fix: upgrade to @sanity/pkg-utils v5 and use updated ESM best pract…

…ices (#5983) * fix: upgrade to `@sanity/pkg-utils` v5 and use updated ESM best practices * refactor: remove redundant `--tsconfig tsconfig.lib.json` cli arg * chore: use import that works in native ESM * chore: bump `@sanity/pkg-utils` * fix: lodash imports need to use `from 'lodash'` for rollup to be able to optimize it * chore(deps): bump nano-pubsub * chore: write to PKG_VERSION to give pre-releases their own version numbers * chore: run build as part of publish to use the correct PKG_VERSION * chore: bump tsdoc * chore: add prepublishOnly at root to speedup canary publishing * chore: fix path to `@sanity/vision` * chore: support types in `/examples` without first running `pnpm build` --------- Co-authored-by: Bjørge Næss <[email protected]>
sanity-io · Apr 9, 2024 · 62a6810 · 62a6810
1 parent fce97c7
commit 62a6810
Show file tree

Hide file tree

Showing 199 changed files with 1,337 additions and 1,839 deletions.
diff --git a/.depcheckrc.json b/.depcheckrc.json
@@ -1,3 +1,9 @@
 {
-  "ignores": ["@sanity/eslint-config-studio", "dotenv-flow", "esbuild", "esbuild-register"]
+  "ignores": [
+    "@repo/tsconfig",
+    "@sanity/eslint-config-studio",
+    "dotenv-flow",
+    "esbuild",
+    "esbuild-register"
+  ]
 }
diff --git a/.eslintrc.cjs b/.eslintrc.cjs
@@ -49,6 +49,8 @@ const config = {
     '*.css',
     '*.snap',
     '*.md',
+    'dev/test-studio/sanity.theme.mjs',
+    'dev/test-studio/workshop/scopes.js',
   ],
   rules: {
     '@typescript-eslint/no-var-requires': 'off', // prefer import/no-dynamic-require
@@ -57,6 +59,7 @@ const config = {
     'import/no-named-as-default': 'off',
     'import/no-named-as-default-member': 'off',
     'import/no-unresolved': 'off',
+    'import/default': 'off',
     'prettier/prettier': 'error',
     'tsdoc/syntax': 'error',
     'react-hooks/rules-of-hooks': 'error',
@@ -191,16 +194,17 @@ const config = {
         project: [
           'dev/*/tsconfig.json',
           'examples/*/tsconfig.json',
+          'packages/@repo/*/tsconfig.json',
           'packages/@sanity/*/tsconfig.json',
           'packages/*/tsconfig.json',
         ],
       },
     },
-    'boundaries/include': ['packages/sanity/exports/*.*', 'packages/sanity/src/**/*.*'],
+    'boundaries/include': ['packages/sanity/src/**/*.*'],
     'boundaries/elements': [
       {
         type: 'sanity',
-        pattern: ['packages/sanity/exports/index.ts'],
+        pattern: ['packages/sanity/src/_exports/index.ts'],
         mode: 'full',
       },
       {
@@ -210,7 +214,7 @@ const config = {
       },
       {
         type: 'sanity/_internal',
-        pattern: ['packages/sanity/exports/_internal.ts'],
+        pattern: ['packages/sanity/src/_exports/_internal.ts'],
         mode: 'full',
       },
       {
@@ -220,7 +224,7 @@ const config = {
       },
       {
         type: 'sanity/cli',
-        pattern: ['packages/sanity/exports/cli.ts'],
+        pattern: ['packages/sanity/src/_exports/cli.ts'],
         mode: 'full',
       },
       {
@@ -230,7 +234,7 @@ const config = {
       },
       {
         type: 'sanity/desk',
-        pattern: ['packages/sanity/exports/desk.ts'],
+        pattern: ['packages/sanity/src/_exports/desk.ts'],
         mode: 'file',
       },
       {
@@ -240,7 +244,7 @@ const config = {
       },
       {
         type: 'sanity/router',
-        pattern: ['packages/sanity/exports/router.ts'],
+        pattern: ['packages/sanity/src/_exports/router.ts'],
         mode: 'full',
       },
       {
@@ -250,7 +254,7 @@ const config = {
       },
       {
         type: 'sanity/structure',
-        pattern: ['packages/sanity/exports/structure.ts'],
+        pattern: ['packages/sanity/src/_exports/structure.ts'],
         mode: 'file',
       },
       {

diff --git a/.github/workflows/cli-test.yml b/.github/workflows/cli-test.yml
@@ -67,7 +67,7 @@ jobs:
         run: pnpm install
 
       - name: Build CLI
-        run: pnpm build # Needed for CLI tests
+        run: pnpm build --output-logs=full --log-order=grouped # Needed for CLI tests
 
       - name: Test
         id: test

diff --git a/.github/workflows/docReport.yml b/.github/workflows/docReport.yml
@@ -52,7 +52,7 @@ jobs:
         run: pnpm install
 
       - name: Build packages
-        run: pnpm build
+        run: pnpm build --output-logs=full --log-order=grouped
         env:
           NODE_OPTIONS: --max_old_space_size=8192
 

diff --git a/.github/workflows/e2e-ct.yml b/.github/workflows/e2e-ct.yml
@@ -61,7 +61,7 @@ jobs:
       - name: Install Playwright Browsers
         run: npx playwright install --with-deps
       - name: Build packages
-        run: pnpm build
+        run: pnpm build --output-logs=full --log-order=grouped
       - name: Run end-to-end tests
         run: pnpm --filter sanity test:ct
         env:

diff --git a/.github/workflows/e2e.yml b/.github/workflows/e2e.yml
@@ -70,7 +70,7 @@ jobs:
         run: npx playwright install --with-deps
 
       - name: Build CLI
-        run: pnpm build:cli
+        run: pnpm build:cli --output-logs=full --log-order=grouped
 
       - name: Build E2E test studio on next
         if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/next' }}

diff --git a/.github/workflows/etl.yml b/.github/workflows/etl.yml
@@ -54,7 +54,7 @@ jobs:
         run: pnpm install
 
       - name: Build packages
-        run: pnpm build
+        run: pnpm build --output-logs=full --log-order=grouped
         env:
           NODE_OPTIONS: --max_old_space_size=8192
 

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -105,7 +105,7 @@ jobs:
             ${{ inputs.version }}
 
       - name: Build
-        run: pnpm build
+        run: pnpm build --output-logs=full --log-order=grouped
 
       - name: Publish
         run: |

diff --git a/.github/workflows/typeCheck.yml b/.github/workflows/typeCheck.yml
@@ -5,6 +5,9 @@ jobs:
   typeCheck:
     timeout-minutes: 15
     runs-on: ubuntu-latest
+    env:
+      TURBO_TOKEN: ${{ secrets.TURBO_TOKEN }}
+      TURBO_TEAM: ${{ vars.TURBO_TEAM }}
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
@@ -41,9 +44,17 @@ jobs:
         run: pnpm install
 
       - name: Check type system
-        # If TypeScript project references is set up properly, `tsc --build` should work right after dependencies
-        # has been installed, no extra build/compile step required
+        # Turbo will run type checks on all files in the project
+        # and ensure that dependencies are built with @sanity/pkg-utils to output dts
+        # used by other packages as they are type checked
         id: typeCheckModules
-        run: pnpm check:types
+        run: pnpm check:types --output-logs=full --log-order=grouped
+        env:
+          NODE_OPTIONS: --max_old_space_size=8192
+
+      - name: Check package.json with @sanity/pkg-utils
+        # Turbo will ensure `build` is run before each package, as pkg-utils requires
+        # as it will check if files declared in package.json `main`, `exports`, `types` and more exists
+        run: pnpm check:package --output-logs=full --log-order=grouped
         env:
           NODE_OPTIONS: --max_old_space_size=8192
diff --git a/.prettierignore b/.prettierignore
@@ -20,6 +20,7 @@
 /packages/*/lib
 /packages/*/node_modules
 
+/packages/@repo/*/node_modules
 /packages/@sanity/*/coverage
 /packages/@sanity/*/lib
 /packages/@sanity/*/node_modules
@@ -31,6 +32,7 @@
 /test/v2-studio/dist
 /turbo.json
 /packages/*/turbo.json
+/packages/@repo/*/turbo.json
 /packages/@sanity/*/turbo.json
 /pnpm-lock.yaml
 

diff --git a/dev/.bin/sanity b/dev/.bin/sanity
@@ -4,6 +4,7 @@ const path = require('path')
 
 require('esbuild-register/dist/node').register({
   target: `node${process.version.slice(1)}`,
+  jsx: 'automatic',
 })
 
 // Define the global `__DEV__` flag which is used to

diff --git a/dev/aliases.cjs b/dev/aliases.cjs
@@ -24,11 +24,9 @@ const devAliases = {
   '@sanity/schema': './packages/@sanity/schema/src/_exports',
   '@sanity/migrate': './packages/@sanity/migrate/src/_exports',
   '@sanity/types': './packages/@sanity/types/src',
-  '@sanity/types/parts': './packages/@sanity/types/parts',
-  '@sanity/util/fs': './packages/@sanity/util/src/fsTools.ts',
-  '@sanity/util': './packages/@sanity/util/src',
+  '@sanity/util': './packages/@sanity/util/src/_exports',
   '@sanity/vision': './packages/@sanity/vision/src',
-  sanity: './packages/sanity/exports',
+  sanity: './packages/sanity/src/_exports',
 }
 
 module.exports = devAliases
diff --git a/dev/design-studio/tsconfig.json b/dev/design-studio/tsconfig.json
@@ -1,8 +1,3 @@
 {
-  "extends": "../tsconfig.dev",
-  "include": ["**/*.ts", "**/*.tsx"],
-  "compilerOptions": {
-    "jsx": "preserve"
-  },
-  "references": [{"path": "../../packages/sanity/tsconfig.lib.json"}]
+  "extends": "../tsconfig.dev"
 }
diff --git a/dev/embedded-studio/package.json b/dev/embedded-studio/package.json
@@ -18,7 +18,7 @@
     "@types/react": "^18.2.74",
     "@types/react-dom": "^18.2.23",
     "@vitejs/plugin-react": "^4.2.1",
-    "typescript": "^5.4.2",
+    "typescript": "5.4.2",
     "vite": "^4.5.3"
   }
 }
diff --git a/dev/embedded-studio/tsconfig.json b/dev/embedded-studio/tsconfig.json
@@ -7,10 +7,8 @@
     "strict": true,
     "forceConsistentCasingInFileNames": true,
     "noEmit": true,
-    "esModuleInterop": true,
-    "module": "esnext",
-    "moduleResolution": "node",
-    "resolveJsonModule": true,
+    "module": "Preserve",
+    "moduleDetection": "force",
     "isolatedModules": true,
     "jsx": "preserve",
     "incremental": true

diff --git a/dev/embedded-studio/tsconfig.node.json b/dev/embedded-studio/tsconfig.node.json
@@ -2,8 +2,8 @@
   "compilerOptions": {
     "composite": true,
     "skipLibCheck": true,
-    "module": "ESNext",
-    "moduleResolution": "bundler",
+    "module": "Preserve",
+    "moduleDetection": "force",
     "allowSyntheticDefaultImports": true
   },
   "include": ["vite.config.ts"]

diff --git a/dev/starter-next-studio/tsconfig.json b/dev/starter-next-studio/tsconfig.json
@@ -8,10 +8,8 @@
     "forceConsistentCasingInFileNames": true,
     "noEmit": true,
     "incremental": true,
-    "esModuleInterop": true,
-    "module": "esnext",
-    "moduleResolution": "node",
-    "resolveJsonModule": true,
+    "module": "Preserve",
+    "moduleDetection": "force",
     "isolatedModules": true,
     "jsx": "preserve"
   },

diff --git a/dev/starter-studio/tsconfig.json b/dev/starter-studio/tsconfig.json
@@ -1,8 +1,6 @@
 {
   "extends": "../tsconfig.dev",
-  "include": ["**/*.ts", "**/*.tsx"],
   "compilerOptions": {
     "jsx": "preserve"
-  },
-  "references": [{"path": "../../packages/sanity/tsconfig.lib.json"}]
+  }
 }
diff --git a/dev/strict-studio/tsconfig.json b/dev/strict-studio/tsconfig.json
@@ -1,9 +1,3 @@
 {
-  "extends": "../tsconfig.dev",
-  "include": ["**/*.ts", "**/*.tsx"],
-  "compilerOptions": {
-    "composite": true,
-    "jsx": "preserve"
-  },
-  "references": [{"path": "../../packages/sanity/tsconfig.lib.json"}]
+  "extends": "../tsconfig.dev"
 }
diff --git a/dev/studio-e2e-testing/tsconfig.json b/dev/studio-e2e-testing/tsconfig.json
@@ -7,10 +7,8 @@
     "strict": true,
     "forceConsistentCasingInFileNames": true,
     "noEmit": true,
-    "esModuleInterop": true,
-    "module": "esnext",
-    "moduleResolution": "node",
-    "resolveJsonModule": true,
+    "module": "Preserve",
+    "moduleDetection": "force",
     "isolatedModules": true,
     "jsx": "react-jsx",
     "incremental": true

diff --git a/dev/test-next-studio/tsconfig.json b/dev/test-next-studio/tsconfig.json
@@ -8,10 +8,8 @@
     "forceConsistentCasingInFileNames": true,
     "noEmit": true,
     "incremental": true,
-    "esModuleInterop": true,
-    "module": "esnext",
-    "moduleResolution": "node",
-    "resolveJsonModule": true,
+    "module": "Preserve",
+    "moduleDetection": "force",
     "isolatedModules": true,
     "jsx": "preserve",
     "plugins": [

diff --git a/dev/test-studio/.eslintignore b/dev/test-studio/.eslintignore
diff --git a/dev/test-studio/package.json b/dev/test-studio/package.json
@@ -38,7 +38,7 @@
     "@sanity/presentation": "1.11.4",
     "@sanity/preview-url-secret": "^1.6.1",
     "@sanity/react-loader": "^1.8.3",
-    "@sanity/tsdoc": "1.0.0-alpha.44",
+    "@sanity/tsdoc": "1.0.13",
     "@sanity/types": "workspace:*",
     "@sanity/ui": "^2.1.0",
     "@sanity/ui-workshop": "^1.0.0",

diff --git a/dev/test-studio/plugins/router-debug/RouterDebug.tsx b/dev/test-studio/plugins/router-debug/RouterDebug.tsx
@@ -40,7 +40,6 @@ export function RouterDebug() {
           <IntentLink
             intent="router-debug-please"
             params={{
-              //@ts-expect-error - todo: we should probably allow arbitrary params
               favorite: 'capybara',
             }}
           >

diff --git a/dev/test-studio/tsconfig.json b/dev/test-studio/tsconfig.json
@@ -1,15 +1,6 @@
 {
   "extends": "../tsconfig.dev",
-  "include": ["**/*.ts", "**/*.tsx"],
   "compilerOptions": {
-    "jsx": "react-jsx",
-    "allowJs": true,
     "isolatedModules": false
-  },
-  "references": [
-    {"path": "../../packages/@sanity/types/tsconfig.lib.json"},
-    {"path": "../../packages/@sanity/vision/tsconfig.lib.json"},
-    {"path": "../../packages/sanity/tsconfig.lib.json"},
-    {"path": "../../packages/@sanity/migrate/tsconfig.lib.json"}
-  ]
+  }
 }
diff --git a/dev/tsconfig.dev.json b/dev/tsconfig.dev.json
@@ -1,19 +1,26 @@
 {
-  "extends": "../tsconfig.settings",
-  "include": ["../packages/@sanity/util/src"],
+  "extends": "@repo/tsconfig/base.json",
+  "include": ["**/*.ts", "**/*.tsx"],
   "compilerOptions": {
     "rootDir": "..",
     "baseUrl": "..",
-    "outDir": "./.cache/ts",
-
     "paths": {
-      // Alias to paths required for Sanity CLI to run in dev-mode
-      "@sanity/mutator": ["./packages/@sanity/mutator/src"],
-      "@sanity/util/fs": ["./packages/@sanity/util/exports/fs.ts"],
-      "sanity/_internal": ["./packages/sanity/exports/_internal.ts"],
-      "sanity/migrate": ["./packages/sanity/exports/migrate.ts"],
-      "sanity/migrate/mutations": ["./packages/sanity/exports/migrate-mutations.ts"],
-      "sanity/cli": ["./packages/sanity/exports/cli.ts"]
+      "@sanity/block-tools": ["./packages/@sanity/block-tools/src/index.ts"],
+      "@sanity/diff": ["./packages/@sanity/diff/src/index.ts"],
+      "@sanity/cli": ["./packages/@sanity/cli/src/index.ts"],
+      "@sanity/codegen": ["./packages/@sanity/codegen/src/_exports/index.ts"],
+      "@sanity/mutator": ["./packages/@sanity/mutator/src/index.ts"],
+      "@sanity/portable-text-editor": ["./packages/@sanity/portable-text-editor/src/index.ts"],
+      "@sanity/schema/*": ["./packages/@sanity/schema/src/_exports/*"],
+      "@sanity/schema": ["./packages/@sanity/schema/src/_exports/index.ts"],
+      "@sanity/migrate": ["./packages/@sanity/migrate/src/_exports/index.ts"],
+      "@sanity/types": ["./packages/@sanity/types/src/index.ts"],
+      "@sanity/util/*": ["./packages/@sanity/util/src/_exports/*"],
+      "@sanity/util": ["./packages/@sanity/util/src/_exports/index.ts"],
+      "@sanity/vision": ["./packages/@sanity/vision/src/index.ts"],
+      "groq": ["./packages/groq/src/groq.ts"],
+      "sanity/*": ["./packages/sanity/src/_exports/*"],
+      "sanity": ["./packages/sanity/src/_exports/index.ts"]
     }
   }
 }