fix(template): api type declaration merging for scripts (#11367)

Make imports in scripts (files in `scripts/`) find our mirror types used for declaration merging also for `api/src/` imports (not just web imports)
redwoodjs · Aug 30, 2024 · 327ffc2 · 327ffc2
1 parent 6635e2e
commit 327ffc2
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 0 deletions.
diff --git a/.changesets/11367.md b/.changesets/11367.md
@@ -0,0 +1,6 @@
+- fix(template): api type declaration merging for scripts (#11367) by @Tobbe
+
+Make imports in scripts (files in `scripts/`) find our mirror types used for declaration merging also for `api/src/` imports (not just web imports)
+
+Users upgrading are adviced to manually upgrade their tsconfig files to match
+what is now in the template.
diff --git a/__fixtures__/test-project/scripts/tsconfig.json b/__fixtures__/test-project/scripts/tsconfig.json
@@ -9,6 +9,8 @@
     "paths": {
       "$api/*": ["../api/*"],
       "api/*": ["../api/*"],
+      "$api/src/*": ["../api/src/*", "../.redwood/types/mirror/api/src/*"],
+      "api/src/*": ["../api/src/*", "../.redwood/types/mirror/api/src/*"],
       "$web/*": ["../web/*"],
       "web/*": ["../web/*"],
       "$web/src/*": ["../web/src/*", "../.redwood/types/mirror/web/src/*"],

diff --git a/packages/create-redwood-app/templates/js/scripts/jsconfig.json b/packages/create-redwood-app/templates/js/scripts/jsconfig.json
@@ -8,6 +8,8 @@
     "paths": {
       "$api/*": ["../api/*"],
       "api/*": ["../api/*"],
+      "$api/src/*": ["../api/src/*", "../.redwood/types/mirror/api/src/*"],
+      "api/src/*": ["../api/src/*", "../.redwood/types/mirror/api/src/*"],
       "$web/*": ["../web/*"],
       "web/*": ["../web/*"],
       "$web/src/*": ["../web/src/*", "../.redwood/types/mirror/web/src/*"],

diff --git a/packages/create-redwood-app/templates/ts/scripts/tsconfig.json b/packages/create-redwood-app/templates/ts/scripts/tsconfig.json
@@ -9,6 +9,8 @@
     "paths": {
       "$api/*": ["../api/*"],
       "api/*": ["../api/*"],
+      "$api/src/*": ["../api/src/*", "../.redwood/types/mirror/api/src/*"],
+      "api/src/*": ["../api/src/*", "../.redwood/types/mirror/api/src/*"],
       "$web/*": ["../web/*"],
       "web/*": ["../web/*"],
       "$web/src/*": ["../web/src/*", "../.redwood/types/mirror/web/src/*"],