@sanity/pkg-utils 7.2.9 → 7.2.10-canary.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/pkg-utils",
-  "version": "7.2.9",
+  "version": "7.2.10-canary.1",
   "description": "Simple utilities for modern npm packages.",
   "keywords": [
     "sanity-io",
@@ -102,6 +102,8 @@
     "prompts": "^2.4.2",
     "recast": "0.23.11",
     "rimraf": "^4.4.1",
+    "rolldown": "1.0.0-beta.17",
+    "rolldown-plugin-dts": "^0.13.11",
     "rollup": "^4.43.0",
     "rollup-plugin-esbuild": "^6.2.1",
     "rxjs": "^7.8.2",
@@ -119,7 +121,7 @@
     "@types/cpx": "^1.5.5",
     "@types/find-config": "^1.0.4",
     "@types/git-url-parse": "^16.0.2",
-    "@types/node": "^20.8.7",
+    "@types/node": "^24.0.3",
     "@types/prompts": "^2.4.9",
     "@types/rimraf": "^3.0.2",
     "@types/semver": "^7.5.8",
@@ -139,7 +141,7 @@
     "ts-node": "^10.9.2",
     "typescript": "5.8.3",
     "vitest": "^3.2.4",
-    "@sanity/pkg-utils": "7.2.9"
+    "@sanity/pkg-utils": "7.2.10-canary.1"
   },
   "peerDependencies": {
     "babel-plugin-react-compiler": "*",

package/src/node/core/config/types.ts

@@ -155,6 +155,8 @@ export type ReactCompilerLogger = {
   logEvent: (filename: string | null, event: ReactCompilerLoggerEvent) => void
 }
 
+export type DtsType = 'api-extractor' | 'rolldown'
+
 /** @public */
 export interface PkgConfigOptions {
   /** @alpha */
@@ -170,7 +172,7 @@ export interface PkgConfigOptions {
           displayName?: boolean
           /**
            * @defaultValue []
-           * @example ["@xstyled/styled-components", "@xstyled/styled-components/*"]
+           * @example ["\@xstyled/styled-components", "\@xstyled/styled-components/*"]
            */
           topLevelImportPaths?: string[]
           /** @defaultValue true */
@@ -203,7 +205,16 @@ export interface PkgConfigOptions {
    */
   dist?: string
   exports?: PkgConfigProperty<PkgExports>
+  /**
+   * Runs `@microsoft/api-extractor` to check that TSDoc tags are valid, and release tags are correct.
+   * This is useful for packages that need to be consumed by TSDoc-based tooling.
+   * It's enabled by default, it can be disabled by setting `extract: {enabled: false}`
+   */
   extract?: {
+    /**
+     * @defaultValue true
+     */
+    enabled?: boolean
     /**
      * Packages in `devDependencies` that are not in `external` are automatically added to the `bundledPackages` config.
      * You can exclude a package from being bundled by using a callback:
@@ -295,4 +306,10 @@ export interface PkgConfigOptions {
    * Configure what checks are made when running `--strict` builds and checks
    */
   strictOptions?: StrictOptions
+  /**
+   * .d.ts files can be generated either by using `@microsoft/api-extractor` or `rolldown`.
+   * `rolldown` is the faster option, but is not yet stable.
+   * @defaultValue 'api-extractor'
+   */
+  dts?: DtsType
 }

package/src/node/core/contexts/buildContext.ts

@@ -1,6 +1,6 @@
 import type ts from 'typescript'
 import type {Logger} from '../../logger'
-import type {PkgConfigOptions, PkgExports, PkgRuntime} from '../config/types'
+import type {DtsType, PkgConfigOptions, PkgExports, PkgRuntime} from '../config/types'
 import type {PackageJSON} from '../pkg/types'
 
 /** @internal */
@@ -28,4 +28,5 @@ export interface BuildContext {
     config?: ts.ParsedCommandLine
     configPath?: string
   }
+  dts: DtsType
 }

package/src/node/resolveBuildContext.ts

@@ -180,6 +180,7 @@ export async function resolveBuildContext(options: {
       config: tsconfig,
       configPath: tsconfigPath,
     },
+    dts: config?.dts === 'rolldown' ? 'rolldown' : 'api-extractor',
   }
 
   return ctx

package/src/node/resolveBuildTasks.ts

@@ -3,7 +3,7 @@ import type {PkgExport, PkgFormat, PkgRuntime} from './core/config/types'
 import type {BuildContext} from './core/contexts/buildContext'
 import {getTargetPaths} from './tasks/dts/getTargetPaths'
 import type {DtsTask} from './tasks/dts/types'
-import type {BuildTask, RollupTask, RollupTaskEntry} from './tasks/types'
+import type {BuildTask, RolldownDtsTask, RollupTask, RollupTaskEntry} from './tasks/types'
 
 /** @internal */
 export function resolveBuildTasks(ctx: BuildContext): BuildTask[] {
@@ -22,155 +22,178 @@ export function resolveBuildTasks(ctx: BuildContext): BuildTask[] {
     entries: [],
   }
 
+  const rolldownDtsTask: Record<string, RolldownDtsTask> = {}
   const rollupTasks: Record<string, RollupTask> = {}
 
   function addRollupTaskEntry(format: PkgFormat, runtime: PkgRuntime, entry: RollupTaskEntry) {
     const buildId = `${format}:${runtime}`
 
-    if (rollupTasks[buildId]) {
-      rollupTasks[buildId].entries.push(entry)
-    } else {
-      rollupTasks[buildId] = {
-        type: 'build:js',
-        buildId,
-        entries: [entry],
-        runtime,
-        format,
-        target: target[runtime],
+    if (ctx.dts === 'rolldown') {
+      if (rolldownDtsTask[buildId]) {
+        rolldownDtsTask[buildId].entries.push(entry)
+      } else {
+        rolldownDtsTask[buildId] = {
+          type: 'rolldown:dts',
+          buildId,
+          entries: [entry],
+          runtime,
+          format,
+          target: target[runtime],
+        }
       }
     }
-  }
 
-  // Parse `dts` tasks
-  for (const exp of exports) {
-    const importId = path.join(pkg.name, exp._path)
-
-    if (exp.source?.endsWith('.ts')) {
-      dtsTask.entries.push({
-        importId,
-        exportPath: exp._path,
-        sourcePath: exp.source,
-        targetPaths: getTargetPaths(pkg.type, exp),
-      })
+    if (!ctx.emitDeclarationOnly) {
+      if (rollupTasks[buildId]) {
+        rollupTasks[buildId].entries.push(entry)
+      } else {
+        rollupTasks[buildId] = {
+          type: 'build:js',
+          buildId,
+          entries: [entry],
+          runtime,
+          format,
+          target: target[runtime],
+        }
+      }
     }
+  }
 
-    if (exp.browser?.source?.endsWith('.ts')) {
-      dtsTask.entries.push({
-        importId,
-        exportPath: exp._path,
-        sourcePath: exp.browser.source,
-        targetPaths: getTargetPaths(pkg.type, exp.browser),
-      })
+  if (ctx.dts === 'api-extractor') {
+    // Parse `dts` tasks
+    for (const exp of exports) {
+      const importId = path.join(pkg.name, exp._path)
+
+      if (exp.source?.endsWith('.ts')) {
+        dtsTask.entries.push({
+          importId,
+          exportPath: exp._path,
+          sourcePath: exp.source,
+          targetPaths: getTargetPaths(pkg.type, exp),
+        })
+      }
+
+      if (exp.browser?.source?.endsWith('.ts')) {
+        dtsTask.entries.push({
+          importId,
+          exportPath: exp._path,
+          sourcePath: exp.browser.source,
+          targetPaths: getTargetPaths(pkg.type, exp.browser),
+        })
+      }
+
+      if (exp.node?.source?.endsWith('.ts')) {
+        dtsTask.entries.push({
+          importId,
+          exportPath: exp._path,
+          sourcePath: exp.node.source,
+          targetPaths: getTargetPaths(pkg.type, exp.node),
+        })
+      }
     }
 
-    if (exp.node?.source?.endsWith('.ts')) {
-      dtsTask.entries.push({
-        importId,
-        exportPath: exp._path,
-        sourcePath: exp.node.source,
-        targetPaths: getTargetPaths(pkg.type, exp.node),
-      })
+    // Handle dts tasks for bundles
+    for (const bundle of bundles) {
+      if (bundle.source?.endsWith('.ts')) {
+        // importId needs to be how the bundle is used, like `@sanity/pkg-utils/dist/cli`
+        // exportPath needs to be the path to the bundle, like `./dist/cli`
+        // targetPaths is then: [./dist/cli.d.ts, ./dist/cli.d.cts]
+        const exportPath = (bundle.import || bundle.require)!.replace(/\.[mc]?js$/, '')
+        const importId = path.join(pkg.name, exportPath)
+
+        dtsTask.entries.push({
+          importId,
+          exportPath,
+          sourcePath: bundle.source,
+          targetPaths: getTargetPaths(pkg.type, bundle),
+        })
+      }
     }
-  }
 
-  // Handle dts tasks for bundles
-  for (const bundle of bundles) {
-    if (bundle.source?.endsWith('.ts')) {
-      // importId needs to be how the bundle is used, like `@sanity/pkg-utils/dist/cli`
-      // exportPath needs to be the path to the bundle, like `./dist/cli`
-      // targetPaths is then: [./dist/cli.d.ts, ./dist/cli.d.cts]
-      const exportPath = (bundle.import || bundle.require)!.replace(/\.[mc]?js$/, '')
-      const importId = path.join(pkg.name, exportPath)
-
-      dtsTask.entries.push({
-        importId,
-        exportPath,
-        sourcePath: bundle.source,
-        targetPaths: getTargetPaths(pkg.type, bundle),
-      })
+    // Add dts task
+    if (dtsTask.entries.length) {
+      tasks.push(dtsTask)
     }
   }
 
-  // Add dts task
-  if (dtsTask.entries.length) {
-    tasks.push(dtsTask)
-  }
+  // Parse rollup:commonjs:* tasks
+  for (const exp of exports) {
+    const output = exp.require
 
-  if (!ctx.emitDeclarationOnly) {
-    // Parse rollup:commonjs:* tasks
-    for (const exp of exports) {
-      const output = exp.require
+    if (!output) continue
 
-      if (!output) continue
+    addRollupTaskEntry('commonjs', ctx.runtime, {
+      path: exp._path,
+      source: exp.source,
+      output,
+    })
+  }
 
-      addRollupTaskEntry('commonjs', ctx.runtime, {
-        path: exp._path,
-        source: exp.source,
-        output,
-      })
-    }
+  // Parse rollup:esm:* tasks
+  for (const exp of exports) {
+    const output = exp.import
 
-    // Parse rollup:esm:* tasks
-    for (const exp of exports) {
-      const output = exp.import
+    if (!output) continue
 
-      if (!output) continue
+    addRollupTaskEntry('esm', ctx.runtime, {
+      path: exp._path,
+      source: exp.source,
+      output,
+    })
+  }
 
-      addRollupTaskEntry('esm', ctx.runtime, {
-        path: exp._path,
-        source: exp.source,
-        output,
-      })
-    }
+  // Parse rollup:commonjs:browser tasks
+  for (const exp of exports) {
+    const output = exp.browser?.require
 
-    // Parse rollup:commonjs:browser tasks
-    for (const exp of exports) {
-      const output = exp.browser?.require
+    if (!output) continue
 
-      if (!output) continue
+    addRollupTaskEntry('commonjs', 'browser', {
+      path: exp._path,
+      source: exp.browser?.source || exp.source,
+      output,
+    })
+  }
 
-      addRollupTaskEntry('commonjs', 'browser', {
-        path: exp._path,
-        source: exp.browser?.source || exp.source,
-        output,
-      })
-    }
+  // Parse rollup:esm:browser tasks
+  for (const exp of exports) {
+    const output = exp.browser?.import
 
-    // Parse rollup:esm:browser tasks
-    for (const exp of exports) {
-      const output = exp.browser?.import
+    if (!output) continue
 
-      if (!output) continue
+    addRollupTaskEntry('esm', 'browser', {
+      path: exp._path,
+      source: exp.browser?.source || exp.source,
+      output,
+    })
+  }
+
+  for (const bundle of bundles) {
+    const idx = bundles.indexOf(bundle)
 
-      addRollupTaskEntry('esm', 'browser', {
-        path: exp._path,
-        source: exp.browser?.source || exp.source,
-        output,
+    if (bundle.require) {
+      addRollupTaskEntry('commonjs', bundle.runtime || ctx.runtime, {
+        path: `__$$bundle_cjs_${idx}$$__`,
+        source: bundle.source,
+        output: bundle.require,
       })
     }
 
-    for (const bundle of bundles) {
-      const idx = bundles.indexOf(bundle)
-
-      if (bundle.require) {
-        addRollupTaskEntry('commonjs', bundle.runtime || ctx.runtime, {
-          path: `__$$bundle_cjs_${idx}$$__`,
-          source: bundle.source,
-          output: bundle.require,
-        })
-      }
-
-      if (bundle.import) {
-        addRollupTaskEntry('esm', bundle.runtime || ctx.runtime, {
-          path: `__$$bundle_esm_${idx}$$__`,
-          source: bundle.source,
-          output: bundle.import,
-        })
-      }
+    if (bundle.import) {
+      addRollupTaskEntry('esm', bundle.runtime || ctx.runtime, {
+        path: `__$$bundle_esm_${idx}$$__`,
+        source: bundle.source,
+        output: bundle.import,
+      })
     }
-
-    tasks.push(...Object.values(rollupTasks))
   }
 
+  // Perform rolldown dts tasks first, as they have special logic for removing non .d.ts chunks
+  tasks.push(...Object.values(rolldownDtsTask))
+  // Then run api-extractor tsdoc release tag checking (if rolldown is used for dts bundling, otherwise api-extractor performs both in the build:dts task)
+  // @TODO
+  // Then run rollup tasks
+  tasks.push(...Object.values(rollupTasks))
+
   return tasks
 }

package/src/node/tasks/dts/createApiExtractorConfig.ts

@@ -12,6 +12,7 @@ export function createApiExtractorConfig(options: {
   mainEntryPointFilePath: string
   tsconfig: ts.ParsedCommandLine
   tsconfigPath: string
+  dtsRollupEnabled: boolean
 }): IConfigFile {
   const {
     bundledPackages,
@@ -23,6 +24,7 @@ export function createApiExtractorConfig(options: {
     mainEntryPointFilePath,
     tsconfig,
     tsconfigPath,
+    dtsRollupEnabled,
   } = options
 
   return {
@@ -50,7 +52,7 @@ export function createApiExtractorConfig(options: {
       apiJsonFilePath: path.resolve(distPath, `${exportPath}.api.json`),
     },
     dtsRollup: {
-      enabled: true,
+      enabled: dtsRollupEnabled,
       untrimmedFilePath: path.resolve(distPath, filePath),
       // betaTrimmedFilePath: path.resolve(distPath, filePath.replace('.d.ts', '-beta.d.ts')),
       // publicTrimmedFilePath: path.resolve(distPath, filePath.replace('.d.ts', '-public.d.ts')),

package/src/node/tasks/dts/doExtract.ts

@@ -59,6 +59,7 @@ export async function doExtract(
       tsconfig: ts.config,
       tmpPath,
       tsconfigPath: path.resolve(cwd, ts.configPath || 'tsconfig.json'),
+      extractorDisabled: config?.extract?.enabled === false,
     })
 
     messages.push(...result.messages)

package/src/node/tasks/dts/dtsTask.ts

@@ -8,9 +8,9 @@ import type {DtsResult, DtsTask} from './types'
 
 /** @internal */
 export const dtsTask: TaskHandler<DtsTask, DtsResult> = {
-  name: (_ctx, task) =>
+  name: (ctx, task) =>
     [
-      'Build type definitions...',
+      `Build type definitions with ${chalk.bold(ctx.dts)}...`,
       '  entries:',
       ...task.entries.map((entry) => {
         return entry.targetPaths

package/src/node/tasks/dts/dtsWatchTask.ts

@@ -111,6 +111,7 @@ export const dtsWatchTask: TaskHandler<DtsWatchTask, DtsResult> = {
               tsconfig: tsContext.config!,
               tmpPath,
               tsconfigPath: path.resolve(cwd, tsContext.configPath || 'tsconfig.json'),
+              extractorDisabled: config?.extract?.enabled === false,
             })
 
             messages.push(...result.messages)

package/src/node/tasks/dts/extractTypes.ts

@@ -30,6 +30,10 @@ export async function extractTypes(options: {
   tmpPath: string
   tsconfig: ts.ParsedCommandLine
   tsconfigPath: string
+  /**
+   * If the extractor is disabled then it means API Extractor is only used to bundle dts, and not check tsdoc release tags.
+   */
+  extractorDisabled: boolean
 }): Promise<{extractorResult: ExtractorResult; messages: ExtractorMessage[]}> {
   const {
     bundledPackages,
@@ -44,6 +48,7 @@ export async function extractTypes(options: {
     tmpPath,
     tsconfig,
     tsconfigPath,
+    extractorDisabled,
   } = options
 
   const tsdocConfigFile = await createTSDocConfig({
@@ -59,11 +64,12 @@ export async function extractTypes(options: {
       distPath,
       exportPath,
       filePath,
-      messages: getExtractMessagesConfig({rules}),
+      messages: getExtractMessagesConfig({rules, disabled: extractorDisabled}),
       projectFolder: projectPath,
       mainEntryPointFilePath: sourceTypesPath,
       tsconfig,
       tsconfigPath,
+      dtsRollupEnabled: true,
     }),
     configObjectFullPath: undefined,
     tsdocConfigFile,

package/src/node/tasks/dts/getExtractMessagesConfig.ts

@@ -11,8 +11,9 @@ const LOG_LEVELS: Record<PkgRuleLevel, ExtractorLogLevel> = {
 /** @alpha */
 export function getExtractMessagesConfig(options: {
   rules: NonNullable<PkgConfigOptions['extract']>['rules']
+  disabled?: boolean
 }): IExtractorMessagesConfig {
-  const {rules} = options
+  const {rules, disabled = false} = options
 
   function ruleToLogLevel(
     key: keyof NonNullable<NonNullable<PkgConfigOptions['extract']>['rules']>,
@@ -26,66 +27,83 @@ export function getExtractMessagesConfig(options: {
   return {
     compilerMessageReporting: {
       default: {
-        logLevel: 'warning' as ExtractorLogLevel,
+        logLevel: (disabled ? 'none' : 'warning') as ExtractorLogLevel,
       },
     },
 
-    extractorMessageReporting: {
-      'default': {
-        logLevel: 'warning' as ExtractorLogLevel,
-        addToApiReportFile: false,
-      },
+    extractorMessageReporting: disabled
+      ? {
+          default: {
+            logLevel: 'none' as ExtractorLogLevel,
+            addToApiReportFile: false,
+          },
+        }
+      : {
+          'default': {
+            logLevel: 'warning' as ExtractorLogLevel,
+            addToApiReportFile: false,
+          },
 
-      'ae-forgotten-export': {
-        /**
-         * This is hardcoded to `none` as it's no longer needed since TypeScript 5.5 https://github.com/microsoft/TypeScript/issues/42873
-         * It's hardcoded to `none` since supported by API Extractor when using `module: 'Preserve'` doesn't support it well since `@microsoft/api-extractor` v7.49.0, which upgraded from TS 5.4 to 5.7 internally
-         */
-        logLevel: 'none' as ExtractorLogLevel,
-        addToApiReportFile: false,
-      },
+          'ae-forgotten-export': {
+            /**
+             * This is hardcoded to `none` as it's no longer needed since TypeScript 5.5 https://github.com/microsoft/TypeScript/issues/42873
+             * It's hardcoded to `none` since supported by API Extractor when using `module: 'Preserve'` doesn't support it well since `@microsoft/api-extractor` v7.49.0, which upgraded from TS 5.4 to 5.7 internally
+             */
+            logLevel: 'none' as ExtractorLogLevel,
+            addToApiReportFile: false,
+          },
 
-      'ae-incompatible-release-tags': {
-        logLevel: ruleToLogLevel('ae-incompatible-release-tags', 'error' as ExtractorLogLevel),
-        addToApiReportFile: false,
-      },
+          'ae-incompatible-release-tags': {
+            logLevel: ruleToLogLevel('ae-incompatible-release-tags', 'error' as ExtractorLogLevel),
+            addToApiReportFile: false,
+          },
 
-      'ae-internal-missing-underscore': {
-        logLevel: ruleToLogLevel('ae-internal-missing-underscore'),
-        addToApiReportFile: false,
-      },
+          'ae-internal-missing-underscore': {
+            logLevel: ruleToLogLevel('ae-internal-missing-underscore'),
+            addToApiReportFile: false,
+          },
 
-      'ae-missing-release-tag': {
-        logLevel: ruleToLogLevel('ae-missing-release-tag', 'error' as ExtractorLogLevel),
-        addToApiReportFile: false,
-      },
+          'ae-missing-release-tag': {
+            logLevel: ruleToLogLevel('ae-missing-release-tag', 'error' as ExtractorLogLevel),
+            addToApiReportFile: false,
+          },
 
-      'ae-wrong-input-file-type': {
-        logLevel: 'none' as ExtractorLogLevel,
-        addToApiReportFile: false,
-      },
-    },
+          'ae-wrong-input-file-type': {
+            logLevel: 'none' as ExtractorLogLevel,
+            addToApiReportFile: false,
+          },
+        },
 
-    tsdocMessageReporting: {
-      'default': {
-        logLevel: 'warning' as ExtractorLogLevel,
-        addToApiReportFile: false,
-      },
+    tsdocMessageReporting: disabled
+      ? {
+          default: {
+            logLevel: 'none' as ExtractorLogLevel,
+            addToApiReportFile: false,
+          },
+        }
+      : {
+          'default': {
+            logLevel: 'warning' as ExtractorLogLevel,
+            addToApiReportFile: false,
+          },
 
-      'tsdoc-link-tag-unescaped-text': {
-        logLevel: ruleToLogLevel('tsdoc-link-tag-unescaped-text', 'warning' as ExtractorLogLevel),
-        addToApiReportFile: false,
-      },
+          'tsdoc-link-tag-unescaped-text': {
+            logLevel: ruleToLogLevel(
+              'tsdoc-link-tag-unescaped-text',
+              'warning' as ExtractorLogLevel,
+            ),
+            addToApiReportFile: false,
+          },
 
-      'tsdoc-undefined-tag': {
-        logLevel: ruleToLogLevel('tsdoc-undefined-tag', 'error' as ExtractorLogLevel),
-        addToApiReportFile: false,
-      },
+          'tsdoc-undefined-tag': {
+            logLevel: ruleToLogLevel('tsdoc-undefined-tag', 'error' as ExtractorLogLevel),
+            addToApiReportFile: false,
+          },
 
-      'tsdoc-unsupported-tag': {
-        logLevel: ruleToLogLevel('tsdoc-unsupported-tag', 'none' as ExtractorLogLevel),
-        addToApiReportFile: false,
-      },
-    },
+          'tsdoc-unsupported-tag': {
+            logLevel: ruleToLogLevel('tsdoc-unsupported-tag', 'none' as ExtractorLogLevel),
+            addToApiReportFile: false,
+          },
+        },
   }
 }

package/src/node/tasks/index.ts

@@ -1,5 +1,6 @@
 import {dtsTask} from './dts/dtsTask'
 import {dtsWatchTask} from './dts/dtsWatchTask'
+import {rolldownDtsTask} from './rolldown/rolldownDtsTask'
 import {rollupTask} from './rollup/rollupTask'
 import {rollupWatchTask} from './rollup/rollupWatchTask'
 import type {BuildTaskHandlers, WatchTaskHandlers} from './types'
@@ -8,6 +9,7 @@ import type {BuildTaskHandlers, WatchTaskHandlers} from './types'
 export const buildTaskHandlers: BuildTaskHandlers = {
   'build:dts': dtsTask,
   'build:js': rollupTask,
+  'rolldown:dts': rolldownDtsTask,
 }
 
 /** @internal */