@sanity/pkg-utils 4.4.1 → 5.0.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/pkg-utils",
-  "version": "4.4.1",
+  "version": "5.0.1",
   "description": "Simple utilities for modern npm packages.",
   "keywords": [
     "sanity-io",
@@ -92,7 +92,7 @@
     "pretty-bytes": "^5.6.0",
     "prompts": "^2.4.2",
     "rimraf": "^4.4.1",
-    "rollup": "^4.12.1",
+    "rollup": "^4.13.0",
     "rollup-plugin-esbuild": "^6.1.1",
     "rxjs": "^7.8.1",
     "treeify": "^1.1.0",
@@ -100,8 +100,8 @@
     "zod": "^3.22.4"
   },
   "devDependencies": {
-    "@commitlint/cli": "^19.0.3",
-    "@commitlint/config-conventional": "^19.0.3",
+    "@commitlint/cli": "^19.1.0",
+    "@commitlint/config-conventional": "^19.1.0",
     "@types/babel__core": "^7.20.5",
     "@types/cpx": "^1.5.5",
     "@types/find-config": "^1.0.4",
@@ -112,8 +112,8 @@
     "@types/rimraf": "^3.0.2",
     "@types/treeify": "^1.0.3",
     "@types/uuid": "^9.0.8",
-    "@typescript-eslint/eslint-plugin": "^7.1.1",
-    "@typescript-eslint/parser": "^7.1.1",
+    "@typescript-eslint/eslint-plugin": "^7.2.0",
+    "@typescript-eslint/parser": "^7.2.0",
     "browserslist-to-esbuild": "2.1.1",
     "commitizen": "^4.3.0",
     "cpx": "^1.5.0",
@@ -127,13 +127,13 @@
     "lint-staged": "^15.0.2",
     "npm-run-all2": "^6.1.2",
     "outdent": "^0.8.0",
-    "recast": "^0.23.5",
+    "recast": "^0.23.6",
     "rollup-plugin-visualizer": "^5.12.0",
     "ts-node": "^10.9.2",
-    "typescript": "^5.3.3",
+    "typescript": "^5.4.2",
     "vitest": "^1.3.1",
     "vitest-github-actions-reporter": "^0.11.1",
-    "@sanity/pkg-utils": "4.4.1"
+    "@sanity/pkg-utils": "5.0.1"
   },
   "peerDependencies": {
     "typescript": "^4.7 || ^5"

package/src/node/core/pkg/loadPkgWithReporting.ts

@@ -33,28 +33,14 @@ export async function loadPkgWithReporting(options: {
           logger.error(`exports["${expPath}"]: the \`types\` property should be the first property`)
         }
 
-        if (exp.node) {
-          const nodeKeys = Object.keys(exp.node)
-
-          if (!assertOrder('module', 'import', nodeKeys)) {
-            shouldError = true
-            logger.error(
-              `exports["${expPath}"]: the \`node.module\` property should come before the \`node.import\` property`,
-            )
-          }
-
-          if (!assertOrder('import', 'require', nodeKeys)) {
-            logger.warn(
-              `exports["${expPath}"]: the \`node.import\` property should come before the \`node.require\` property`,
-            )
-          }
-
-          if (!assertOrder('module', 'require', nodeKeys)) {
-            logger.warn(
-              `exports["${expPath}"]: the \`node.module\` property should come before \`node.require\` property`,
-            )
-          }
+        if (exp.module) {
+          shouldError = true
+          logger.error(
+            `exports["${expPath}"]: the \`module\` condition shouldn't be used as it's not well supported in all bundlers.`,
+          )
+        }
 
+        if (exp.node) {
           if (exp.import && exp.node.import && !assertOrder('node', 'import', keys)) {
             shouldError = true
             logger.error(
@@ -62,23 +48,22 @@ export async function loadPkgWithReporting(options: {
             )
           }
 
-          if (exp.module && exp.node.module && !assertOrder('node', 'module', keys)) {
+          if (exp.node.module) {
             shouldError = true
             logger.error(
-              `exports["${expPath}"]: the \`node\` property should come before the \`module\` property`,
+              `exports["${expPath}"]: the \`node.module\` condition shouldn't be used as it's not well supported in all bundlers. A better strategy is to refactor the codebase to no longer be vulnerable to the "dual package hazard"`,
             )
           }
 
           if (
+            !exp.node.source &&
             exp.node.import &&
-            !exp.node.require &&
-            exp.node.module &&
-            exp.import &&
-            exp.node.module !== exp.import
+            (exp.node.require || exp.require) &&
+            (exp.node.import.endsWith('.cjs.js') || exp.node.import.endsWith('.cjs.mjs'))
           ) {
             shouldError = true
             logger.error(
-              `exports["${expPath}"]: the \`node.module\` property should match \`import\``,
+              `exports["${expPath}"]: the \`node.import\` re-export pattern shouldn't be used as it's not well supported in all bundlers. A better strategy is to refactor the codebase to no longer be vulnerable to the "dual package hazard"`,
             )
           }
 
@@ -99,12 +84,6 @@ export async function loadPkgWithReporting(options: {
               `exports["${expPath}"]: the \`import\` property should come before the \`require\` property`,
             )
           }
-
-          if (!assertOrder('module', 'import', keys)) {
-            logger.warn(
-              `exports["${expPath}"]: the \`module\` property should come before \`import\` property`,
-            )
-          }
         }
 
         if (!assertLast('default', keys)) {

package/src/node/core/pkg/validatePkg.ts

@@ -33,12 +33,10 @@ const pkgSchema = z.object({
           node: z.optional(
             z.object({
               source: z.optional(z.string()),
-              module: z.optional(z.string()),
               import: z.optional(z.string()),
               require: z.optional(z.string()),
             }),
           ),
-          module: z.optional(z.string()),
           import: z.optional(z.string()),
           require: z.optional(z.string()),
           default: z.string(),

package/src/node/resolveBuildTasks.ts

@@ -2,7 +2,7 @@ import fs from 'fs'
 import path from 'path'
 
 import {BuildContext, PkgExport, PkgFormat, PkgRuntime} from './core'
-import {BuildTask, DtsTask, NodeReExportFromCJSTask, RollupTask, RollupTaskEntry} from './tasks'
+import {BuildTask, DtsTask, RollupTask, RollupTaskEntry} from './tasks'
 
 /** @internal */
 export function resolveBuildTasks(ctx: BuildContext): BuildTask[] {
@@ -156,33 +156,5 @@ export function resolveBuildTasks(ctx: BuildContext): BuildTask[] {
     }
   }
 
-  const nodeReexportCjsEntries: NodeReExportFromCJSTask['entries'] = []
-
-  // Parse tasks to re-export from CommonJS for Node.js
-  for (const exp of exports) {
-    if (
-      exp.node &&
-      !exp.node.source &&
-      exp.node.import &&
-      (exp.node.require || exp.require) &&
-      (exp.node.import.endsWith('.cjs.js') || exp.node.import.endsWith('.cjs.mjs'))
-    ) {
-      const importId = path.join(pkg.name, exp._path)
-
-      nodeReexportCjsEntries.push({
-        importId,
-        import: exp.node.import,
-        require: (exp.node.require || exp.require)!,
-      })
-    }
-  }
-
-  if (nodeReexportCjsEntries.length) {
-    tasks.push({
-      type: 'node:reexport-cjs',
-      entries: nodeReexportCjsEntries,
-    })
-  }
-
   return tasks
 }

package/src/node/tasks/index.ts

@@ -1,5 +1,4 @@
 import {dtsTask, dtsWatchTask} from './dts'
-import {nodeReexportCjsTask} from './node/reexportCjsTask'
 import {rollupTask, rollupWatchTask} from './rollup'
 import {BuildTaskHandlers, WatchTaskHandlers} from './types'
 
@@ -11,7 +10,6 @@ export * from './types'
 export const buildTaskHandlers: BuildTaskHandlers = {
   'build:dts': dtsTask,
   'build:js': rollupTask,
-  'node:reexport-cjs': nodeReexportCjsTask,
 }
 
 /** @internal */

package/src/node/tasks/types.ts

@@ -32,13 +32,7 @@ export interface RollupWatchTask {
 }
 
 /** @internal */
-export interface NodeReExportFromCJSTask {
-  type: 'node:reexport-cjs'
-  entries: {importId: string; import: string; require: string}[]
-}
-
-/** @internal */
-export type BuildTask = DtsTask | RollupTask | NodeReExportFromCJSTask
+export type BuildTask = DtsTask | RollupTask
 
 /** @internal */
 export type WatchTask = DtsWatchTask | RollupWatchTask
@@ -55,7 +49,6 @@ export type TaskHandler<Task, Result = void> = {
 export interface BuildTaskHandlers {
   'build:dts': TaskHandler<DtsTask, DtsResult>
   'build:js': TaskHandler<RollupTask>
-  'node:reexport-cjs': TaskHandler<NodeReExportFromCJSTask>
 }
 
 /** @internal */

package/src/node/tasks/node/reexportCjsTask.ts

@@ -1,87 +0,0 @@
-import chalk from 'chalk'
-import {writeFile} from 'fs/promises'
-import {mkdirp} from 'mkdirp'
-import path from 'path'
-import {from} from 'rxjs'
-
-import {BuildContext} from '../../core'
-import {NodeReExportFromCJSTask, TaskHandler} from '../types'
-
-/** @internal */
-export const nodeReexportCjsTask: TaskHandler<NodeReExportFromCJSTask> = {
-  name: (_ctx, task) =>
-    [
-      `Re-export CommonJS module in ESM wrapper…`,
-      `  entries:`,
-      ...task.entries.map((entry) =>
-        [
-          `    - ${chalk.cyan(entry.importId)}: `,
-          `${chalk.yellow(entry.require)} ${chalk.gray('→')} ${chalk.yellow(entry.import)}`,
-        ].join(''),
-      ),
-    ].join('\n'),
-  exec: (ctx, task) => {
-    return from(exec(ctx, task))
-  },
-  complete: () => {
-    //
-  },
-  error: (_ctx, _task, err) => {
-    // eslint-disable-next-line no-console
-    console.error(err)
-  },
-}
-
-async function exec(ctx: BuildContext, task: NodeReExportFromCJSTask) {
-  const {cwd} = ctx
-
-  for (const entry of task.entries) {
-    const sourcePath = path.resolve(cwd, entry.require)
-    const targetPath = path.resolve(cwd, entry.import)
-    const targetDir = path.dirname(targetPath)
-
-    await mkdirp(targetDir)
-
-    // eslint-disable-next-line @typescript-eslint/no-var-requires
-    const mod = require(sourcePath)
-
-    let relativeImport = `./${path.relative(targetDir, sourcePath)}`
-
-    // Strip leading "./" from relative import
-    if (relativeImport.startsWith('./.')) {
-      relativeImport = relativeImport.slice(2)
-    }
-
-    const code = compileESMWrapper(mod, relativeImport)
-
-    await writeFile(targetPath, code, 'utf8')
-  }
-}
-
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-function compileESMWrapper(mod: any, relativeImport: string) {
-  const keys = Object.keys(mod).filter((k) => k !== '__esModule')
-
-  let code = `import cjs from '${relativeImport}';\n`
-
-  if (keys.length) {
-    code += `\n`
-    code += keys
-      .filter((k) => (mod.__esModule ? k !== 'default' : true))
-      .map((k) => `export const ${k} = cjs.${k};\n`)
-      .join('')
-  }
-
-  code += `\n`
-
-  if (mod.__esModule) {
-    // If there is no default export, we shouldn't add it as it'll be undefined
-    if ('default' in mod) {
-      code += `export default cjs.default;\n`
-    }
-  } else {
-    code += `export default cjs;\n`
-  }
-
-  return code
-}