@sanity/pkg-utils 2.3.4 → 2.3.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/pkg-utils",
-  "version": "2.3.4",
+  "version": "2.3.6",
   "description": "Simple utilities for modern npm packages.",
   "keywords": [
     "sanity-io",
@@ -147,7 +147,7 @@
     "outdent": "^0.8.0",
     "parse-git-config": "^3.0.0",
     "pkg-up": "^3.1.0",
-    "prettier": "^2.8.8",
+    "prettier": "^3.0.0",
     "prettier-plugin-packagejson": "^2.4.3",
     "pretty-bytes": "^5.6.0",
     "prompts": "^2.4.2",
@@ -164,14 +164,13 @@
     "@commitlint/cli": "^17.6.5",
     "@commitlint/config-conventional": "^17.6.5",
     "@sanity/pkg-utils": "workspace:*",
-    "@sanity/semantic-release-preset": "4.1.1",
+    "@sanity/semantic-release-preset": "4.1.2",
     "@types/babel__core": "^7.20.1",
     "@types/cpx": "^1.5.2",
     "@types/find-config": "^1.0.1",
     "@types/git-url-parse": "^9.0.1",
     "@types/node": "^20.2.5",
     "@types/parse-git-config": "^3.0.1",
-    "@types/prettier": "^2.7.3",
     "@types/prompts": "^2.4.4",
     "@types/rimraf": "^3.0.2",
     "@types/treeify": "^1.0.0",
@@ -184,7 +183,7 @@
     "eslint": "^8.42.0",
     "eslint-config-prettier": "^8.8.0",
     "eslint-plugin-import": "^2.27.5",
-    "eslint-plugin-prettier": "^4.2.1",
+    "eslint-plugin-prettier": "^5.0.0",
     "eslint-plugin-simple-import-sort": "10.0.0",
     "husky": "^8.0.3",
     "lint-staged": "^13.2.2",
@@ -199,7 +198,7 @@
   "peerDependencies": {
     "typescript": "^4.7 || ^5"
   },
-  "packageManager": "pnpm@8.6.6",
+  "packageManager": "pnpm@8.6.10",
   "engines": {
     "node": ">=16.0.0"
   },

package/src/node/check.ts

@@ -85,7 +85,7 @@ export async function check(options: {
 
 async function checkExports(
   exportPaths: string[],
-  options: {cwd: string; external: string[]; format: 'esm' | 'cjs'; logger: Logger}
+  options: {cwd: string; external: string[]; format: 'esm' | 'cjs'; logger: Logger},
 ) {
   const {cwd, external, format, logger} = options
 
@@ -148,7 +148,7 @@ function printEsbuildMessage(log: (...args: unknown[]) => void, msg: esbuild.Mes
         `${msg.detail || msg.text}\n`,
         `${msg.location.line} | ${msg.location.lineText}\n`,
         `in ./${msg.location.file}:${msg.location.line}:${msg.location.column}`,
-      ].join('')
+      ].join(''),
     )
   } else {
     log(msg.detail || msg.text)

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

@@ -3,7 +3,7 @@ import {PkgConfigProperty, PkgConfigPropertyResolver} from './types'
 /** @internal */
 export function resolveConfigProperty<T>(
   prop: PkgConfigProperty<T> | undefined,
-  initialValue: T
+  initialValue: T,
 ): T {
   if (!prop) return initialValue
 

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

@@ -33,19 +33,19 @@ export async function loadPkgWithReporting(options: {
 
         if (!assertOrder('require', 'import', keys)) {
           logger.warn(
-            `exports["${expPath}"]: the \`require\` property should come before the \`import\` property`
+            `exports["${expPath}"]: the \`require\` property should come before the \`import\` property`,
           )
         }
 
         if (!assertOrder('require', 'node', keys)) {
           logger.warn(
-            `exports["${expPath}"]: the \`require\` property should come before the \`node\` property`
+            `exports["${expPath}"]: the \`require\` property should come before the \`node\` property`,
           )
         }
 
         if (!assertOrder('node', 'import', keys)) {
           logger.warn(
-            `exports["${expPath}"]: the \`node\` property should come before \`import\` property`
+            `exports["${expPath}"]: the \`node\` property should come before \`import\` property`,
           )
         }
 
@@ -65,7 +65,7 @@ export async function loadPkgWithReporting(options: {
               `\`${formatPath(issue.path)}\` `,
               `in \`./package.json\` must be of type ${chalk.magenta(issue.expected)} `,
               `(received ${chalk.magenta(issue.received)})`,
-            ].join('')
+            ].join(''),
           )
           continue
         }

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

@@ -51,25 +51,25 @@ export function parseExports(options: {
             exportEntry.require !== rootExport.require
           ) {
             errors.push(
-              'package.json: mismatch between "main" and "exports.require". These must be equal.'
+              'package.json: mismatch between "main" and "exports.require". These must be equal.',
             )
           }
 
           if (exportEntry.import && rootExport.import && exportEntry.import !== rootExport.import) {
             errors.push(
-              'package.json: mismatch between "module" and "exports.import" These must be equal.'
+              'package.json: mismatch between "module" and "exports.import" These must be equal.',
             )
           }
 
           if (exportEntry.types && rootExport.types && exportEntry.types !== rootExport.types) {
             errors.push(
-              'package.json: mismatch between "types" and "exports.types". These must be equal.'
+              'package.json: mismatch between "types" and "exports.types". These must be equal.',
             )
           }
 
           if (exportEntry.source && rootExport.source && exportEntry.source !== rootExport.source) {
             errors.push(
-              'package.json: mismatch between "source" and "exports.source". These must be equal.'
+              'package.json: mismatch between "source" and "exports.source". These must be equal.',
             )
           }
 

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

@@ -4,7 +4,7 @@ import {PackageJSON} from './types'
 
 export function validateExports(
   _exports: (PkgExport & {_path: string})[],
-  options: {extMap: PkgExtMap; pkg: PackageJSON}
+  options: {extMap: PkgExtMap; pkg: PackageJSON},
 ): string[] {
   const {extMap, pkg} = options
   const ext = extMap[pkg.type || 'commonjs']
@@ -14,13 +14,13 @@ export function validateExports(
   for (const exp of _exports) {
     if (exp.require && !exp.require.endsWith(ext.commonjs)) {
       errors.push(
-        `package.json with \`type: "${pkg.type}"\` - \`exports["${exp._path}"].require\` must end with "${ext.commonjs}"`
+        `package.json with \`type: "${pkg.type}"\` - \`exports["${exp._path}"].require\` must end with "${ext.commonjs}"`,
       )
     }
 
     if (exp.import && !exp.import.endsWith(ext.esm)) {
       errors.push(
-        `package.json with \`type: "${pkg.type}"\` - \`exports["${exp._path}"].import\` must end with "${ext.esm}"`
+        `package.json with \`type: "${pkg.type}"\` - \`exports["${exp._path}"].import\` must end with "${ext.esm}"`,
       )
     }
   }

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

@@ -29,20 +29,20 @@ const pkgSchema = z.object({
               source: z.string(),
               require: z.optional(z.string()),
               import: z.optional(z.string()),
-            })
+            }),
           ),
           node: z.optional(
             z.object({
               source: z.optional(z.string()),
               require: z.optional(z.string()),
               import: z.optional(z.string()),
-            })
+            }),
           ),
           import: z.optional(z.string()),
           default: z.string(),
         }),
-      ])
-    )
+      ]),
+    ),
   ),
   browserslist: z.optional(z.array(z.string())),
 })

package/src/node/core/template/createFromTemplate.ts

@@ -42,7 +42,7 @@ export async function createFromTemplate(options: {
             ? templateOption.initial(templateOptions)
             : templateOption.initial,
       },
-      {onCancel: () => process.exit(0)}
+      {onCancel: () => process.exit(0)},
     )
 
     templateOptions[templateOption.name] = templateOption.parse
@@ -61,7 +61,7 @@ export async function createFromTemplate(options: {
             message: `use ${templateFeature.name}?`,
             initial: templateFeature.initial,
           },
-          {onCancel: () => process.exit(0)}
+          {onCancel: () => process.exit(0)},
         )
       : undefined
 

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

@@ -29,7 +29,7 @@ export interface PkgTemplateDefinition {
   }[]
   getFiles: (
     options: Record<string, any>,
-    features: Record<string, boolean>
+    features: Record<string, boolean>,
   ) => Promise<PkgTemplateFile[]>
 }
 

package/src/node/printExtractMessages.ts

@@ -30,7 +30,7 @@ export function printExtractMessages(ctx: BuildContext, messages: ExtractorMessa
         ` - ${chalk.yellow('warning')} ${chalk.gray(msg.messageId)}\n`,
         msg.text,
         '\n',
-      ].join('')
+      ].join(''),
     )
   }
 
@@ -50,7 +50,7 @@ export function printExtractMessages(ctx: BuildContext, messages: ExtractorMessa
         ` - ${chalk.red('error')} ${chalk.gray(msg.messageId)}\n`,
         msg.text,
         '\n',
-      ].join('')
+      ].join(''),
     )
   }
 

package/src/node/printPackageTree.ts

@@ -30,7 +30,7 @@ export function printPackageTree(ctx: BuildContext): void {
 
   if (pkg.bin) {
     tree.bin = Object.fromEntries(
-      Object.entries(pkg.bin).map(([name, file]) => [chalk.cyan(name), fileInfo(file)])
+      Object.entries(pkg.bin).map(([name, file]) => [chalk.cyan(name), fileInfo(file)]),
     )
   }
 
@@ -96,7 +96,7 @@ export function printPackageTree(ctx: BuildContext): void {
         }
 
         return [chalk.cyan(path.join(pkg.name, exportPath)), exp]
-      })
+      }),
   )
 
   logger.log(treeify.asTree(tree as Record<string, any>, true, true))

package/src/node/resolveBuildContext.ts

@@ -93,7 +93,7 @@ export async function resolveBuildContext(options: {
 
   if (commonDistPath === cwd) {
     throw new Error(
-      'all output files must share a common parent directory which is not the root package directory'
+      'all output files must share a common parent directory which is not the root package directory',
     )
   }
 

package/src/node/resolveBuildTasks.ts

@@ -13,7 +13,7 @@ export function resolveBuildTasks(ctx: BuildContext): BuildTask[] {
   const tasks: BuildTask[] = []
 
   const exports = Object.entries(ctx.exports || {}).map(
-    ([_path, exp]) => ({_path, ...exp} as PkgExport & {_path: string})
+    ([_path, exp]) => ({_path, ...exp}) as PkgExport & {_path: string},
   )
 
   const dtsTask: DtsTask = {
@@ -140,15 +140,15 @@ export function resolveBuildTasks(ctx: BuildContext): BuildTask[] {
         if (exp._exported && exp._path !== '.') {
           const relativeTargetPath = (exp.browser?.import || exp.import || '').replace(
             /\.[^/.]+$/,
-            ''
+            '',
           )
 
           if (relativeTargetPath) {
             fs.writeFileSync(
               path.resolve(cwd, `${exp._path}.js`),
               [`// AUTO-GENERATED – DO NOT EDIT`, `export * from '${relativeTargetPath}'`, ``].join(
-                '\n'
-              )
+                '\n',
+              ),
             )
           }
         }

package/src/node/resolveWatchTasks.ts

@@ -10,7 +10,7 @@ export function resolveWatchTasks(ctx: BuildContext): WatchTask[] {
   const tasks: WatchTask[] = []
 
   const exports = Object.entries(ctx.exports || {}).map(
-    ([_path, exp]) => ({_path, ...exp} as PkgExport & {_path: string})
+    ([_path, exp]) => ({_path, ...exp}) as PkgExport & {_path: string},
   )
 
   const dtsTask: DtsWatchTask = {
@@ -115,15 +115,15 @@ export function resolveWatchTasks(ctx: BuildContext): WatchTask[] {
       if (exp._exported && exp._path !== '.') {
         const relativeTargetPath = (exp.browser?.import || exp.import || '').replace(
           /\.[^/.]+$/,
-          ''
+          '',
         )
 
         if (relativeTargetPath) {
           fs.writeFileSync(
             path.resolve(cwd, `${exp._path}.js`),
             [`// AUTO-GENERATED – DO NOT EDIT`, `export * from '${relativeTargetPath}'`, ``].join(
-              '\n'
-            )
+              '\n',
+            ),
           )
         }
       }

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

@@ -20,7 +20,7 @@ export async function createTSDocConfig(opts: {
   }
 
   const tsDocBaseBuf = await readFile(
-    require.resolve('@microsoft/api-extractor/extends/tsdoc-base.json')
+    require.resolve('@microsoft/api-extractor/extends/tsdoc-base.json'),
   )
 
   // Include the definitions that are required for API Extractor
@@ -33,7 +33,7 @@ export async function createTSDocConfig(opts: {
       tagName: `@${t.name}`,
       syntaxKind: t.syntaxKind,
       allowMultiple: t.allowMultiple,
-    }))
+    })),
   )
 
   // Indicate that custom tags are supported by your tooling.

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

@@ -15,7 +15,7 @@ import {DtsResult, DtsTask, DtsWatchTask} from './types'
  */
 export async function doExtract(
   ctx: BuildContext,
-  task: DtsTask | DtsWatchTask
+  task: DtsTask | DtsWatchTask,
 ): Promise<DtsResult> {
   const {config, cwd, files, logger, strict, ts} = ctx
 
@@ -41,7 +41,7 @@ export async function doExtract(
 
     const sourceTypesPath = path.resolve(
       tmpPath,
-      path.relative(rootDir, path.resolve(cwd, entry.sourcePath)).replace(/\.ts$/, '.d.ts')
+      path.relative(rootDir, path.resolve(cwd, entry.sourcePath)).replace(/\.ts$/, '.d.ts'),
     )
 
     const targetPath = path.resolve(cwd, entry.targetPath)

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

@@ -17,7 +17,7 @@ export const dtsTask: TaskHandler<DtsTask, DtsResult> = {
         [
           `    - ${chalk.cyan(entry.importId)}: `,
           `${chalk.yellow(entry.sourcePath)} ${chalk.gray('→')} ${chalk.yellow(entry.targetPath)}`,
-        ].join('')
+        ].join(''),
       ),
     ].join('\n'),
   exec: (ctx, task) => {

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

@@ -14,7 +14,7 @@ export const dtsWatchTask: TaskHandler<DtsWatchTask, DtsResult> = {
       `build type definitions`,
       ...task.entries.map(
         (entry) =>
-          `       ${chalk.blue(entry.importId)}: ${entry.sourcePath} -> ${entry.targetPath}`
+          `       ${chalk.blue(entry.importId)}: ${entry.sourcePath} -> ${entry.targetPath}`,
       ),
     ].join('\n'),
   exec: (ctx, task) => {

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

@@ -90,10 +90,10 @@ export async function extractTypes(options: {
 
   await fs.writeFile(
     typesPath,
-    prettier.format(code, {
+    await prettier.format(code, {
       ...prettierConfig,
       filepath: typesPath,
-    })
+    }),
   )
 
   // Add to `files` in context

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

@@ -17,7 +17,7 @@ export function getExtractMessagesConfig(options: {
 
   function ruleToLogLevel(
     key: keyof NonNullable<NonNullable<PkgConfigOptions['extract']>['rules']>,
-    defaultLevel?: ExtractorLogLevel
+    defaultLevel?: ExtractorLogLevel,
   ) {
     const r = rules?.[key]
 

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

@@ -17,7 +17,7 @@ export const nodeReexportCjsTask: TaskHandler<NodeReExportFromCJSTask> = {
         [
           `    - ${chalk.cyan(entry.importId)}: `,
           `${chalk.yellow(entry.require)} ${chalk.gray('→')} ${chalk.yellow(entry.import)}`,
-        ].join('')
+        ].join(''),
       ),
     ].join('\n'),
   exec: (ctx, task) => {

package/src/node/tasks/rollup/resolveRollupConfig.ts

@@ -20,7 +20,7 @@ export interface RollupConfig {
 /** @internal */
 export function resolveRollupConfig(
   ctx: BuildContext,
-  buildTask: RollupTask | RollupWatchTask
+  buildTask: RollupTask | RollupWatchTask,
 ): RollupConfig {
   const {format, runtime, target} = buildTask
   const {config, cwd, exports: _exports, extMap, external, distPath, logger, pkg, ts} = ctx
@@ -31,7 +31,7 @@ export function resolveRollupConfig(
   const pathAliases = Object.fromEntries(
     Object.entries(ts.config?.options.paths || {}).map(([key, val]) => {
       return [key, path.resolve(cwd, ts.config?.options.baseUrl || '.', val[0])]
-    })
+    }),
   )
 
   const entries = buildTask.entries.map((entry) => {
@@ -47,7 +47,7 @@ export function resolveRollupConfig(
   const sourcePaths = _exports && Object.values(_exports).map((e) => path.resolve(cwd, e.source))
 
   const replacements = Object.fromEntries(
-    Object.entries(config?.define || {}).map(([key, val]) => [key, JSON.stringify(val)])
+    Object.entries(config?.define || {}).map(([key, val]) => [key, JSON.stringify(val)]),
   )
 
   const defaultPlugins = [
@@ -69,7 +69,7 @@ export function resolveRollupConfig(
                 }
 
                 return JSON.stringify(
-                  path.relative(cwd, path.resolve(outDir, entry.name + outputExt))
+                  path.relative(cwd, path.resolve(outDir, entry.name + outputExt)),
                 )
               },
               'process.env.PKG_FORMAT': JSON.stringify(format),
@@ -156,8 +156,8 @@ export function resolveRollupConfig(
             logger.warn(
               `detected self-referencing import – treating as external: ${path.relative(
                 cwd,
-                idPath
-              )}`
+                idPath,
+              )}`,
             )
 
             return true

package/src/node/tasks/rollup/rollupTask.ts

@@ -25,7 +25,7 @@ export const rollupTask: TaskHandler<RollupTask> = {
             [
               `    - `,
               `${chalk.yellow(e.source)} ${chalk.gray('→')} ${chalk.yellow(e.output)}`,
-            ].join('')
+            ].join(''),
           ),
         ]
       : []
@@ -38,7 +38,7 @@ export const rollupTask: TaskHandler<RollupTask> = {
               `    - `,
               `${chalk.cyan(path.join(ctx.pkg.name, e.path))}: `,
               `${chalk.yellow(e.source)} ${chalk.gray('→')} ${chalk.yellow(e.output)}`,
-            ].join('')
+            ].join(''),
           ),
         ]
       : []

package/src/node/tasks/rollup/rollupWatchTask.ts

@@ -43,7 +43,7 @@ export const rollupWatchTask: TaskHandler<RollupWatchTask, RollupWatcherEvent> =
           task.format
         })\n       ${task.entries
           .map((e) => `${chalk.blue(path.join(ctx.pkg.name, e.path))}: ${e.source} -> ${e.output}`)
-          .join('\n       ')}`
+          .join('\n       ')}`,
       )
       logger.log('')
 

package/src/node/templates/default/template.ts

@@ -336,7 +336,7 @@ export const defaultTemplate: PkgTemplate = async ({cwd, logger, packagePath}) =
 
         files.push({
           name: '.eslintrc.cjs',
-          contents: format(
+          contents: await format(
             resolve(packagePath, '.eslintrc.cjs'),
             outdent`
             'use strict'
@@ -344,7 +344,7 @@ export const defaultTemplate: PkgTemplate = async ({cwd, logger, packagePath}) =
             /** @type import('eslint').Linter.Config */
             module.exports = ${JSON.stringify(eslintConfig, null, 2)}
             `,
-            prettierConfig
+            prettierConfig,
           ),
         })
       }
@@ -352,7 +352,7 @@ export const defaultTemplate: PkgTemplate = async ({cwd, logger, packagePath}) =
       if (features.typescript) {
         files.push({
           name: 'tsconfig.settings.json',
-          contents: format(
+          contents: await format(
             resolve(packagePath, 'tsconfig.settings.json'),
             outdent`
             {
@@ -386,13 +386,13 @@ export const defaultTemplate: PkgTemplate = async ({cwd, logger, packagePath}) =
               }
             }
             `,
-            prettierConfig
+            prettierConfig,
           ),
         })
 
         files.push({
           name: 'tsconfig.dist.json',
-          contents: format(
+          contents: await format(
             resolve(packagePath, 'tsconfig.dist.json'),
             outdent`
             {
@@ -406,13 +406,13 @@ export const defaultTemplate: PkgTemplate = async ({cwd, logger, packagePath}) =
               }
             }
             `,
-            prettierConfig
+            prettierConfig,
           ),
         })
 
         files.push({
           name: 'tsconfig.json',
-          contents: format(
+          contents: await format(
             resolve(packagePath, 'tsconfig.json'),
             outdent`
             {
@@ -427,7 +427,7 @@ export const defaultTemplate: PkgTemplate = async ({cwd, logger, packagePath}) =
               }
             }
             `,
-            prettierConfig
+            prettierConfig,
           ),
         })
       }
@@ -436,7 +436,7 @@ export const defaultTemplate: PkgTemplate = async ({cwd, logger, packagePath}) =
       if (features.typescript) {
         files.push({
           name: 'package.config.ts',
-          contents: format(
+          contents: await format(
             resolve(packagePath, 'package.config.ts'),
             outdent`
             import {defineConfig} from '@sanity/pkg-utils'
@@ -453,13 +453,13 @@ export const defaultTemplate: PkgTemplate = async ({cwd, logger, packagePath}) =
               tsconfig: 'tsconfig.dist.json',
             })
             `,
-            prettierConfig
+            prettierConfig,
           ),
         })
 
         files.push({
           name: 'src/index.ts',
-          contents: format(
+          contents: await format(
             resolve(packagePath, 'src/index.ts'),
             outdent`
             /** @public */
@@ -467,13 +467,13 @@ export const defaultTemplate: PkgTemplate = async ({cwd, logger, packagePath}) =
               //
             }
             `,
-            prettierConfig
+            prettierConfig,
           ),
         })
       } else {
         files.push({
           name: 'package.config.js',
-          contents: format(
+          contents: await format(
             resolve(packagePath, 'package.config.js'),
             outdent`
             import {defineConfig} from '@sanity/pkg-utils'
@@ -487,13 +487,13 @@ export const defaultTemplate: PkgTemplate = async ({cwd, logger, packagePath}) =
               },
             })
             `,
-            prettierConfig
+            prettierConfig,
           ),
         })
 
         files.push({
           name: 'src/index.js',
-          contents: format(
+          contents: await format(
             resolve(packagePath, 'src/index.js'),
             outdent`
             /** @public */
@@ -501,7 +501,7 @@ export const defaultTemplate: PkgTemplate = async ({cwd, logger, packagePath}) =
               //
             }
             `,
-            prettierConfig
+            prettierConfig,
           ),
         })
       }
@@ -522,10 +522,10 @@ export const defaultTemplate: PkgTemplate = async ({cwd, logger, packagePath}) =
 
       files.push({
         name: 'package.json',
-        contents: format(
+        contents: await format(
           resolve(packagePath, 'package.json'),
           JSON.stringify(pkgJson, null, 2),
-          prettierConfig
+          prettierConfig,
         ),
       })
 

package/src/node/watch.ts

@@ -36,7 +36,7 @@ export async function watch(options: {
       const tsconfig = tsconfigOption || config?.tsconfig || 'tsconfig.json'
 
       return resolveBuildContext({config, cwd, extMap, logger, pkg, strict, tsconfig})
-    })
+    }),
   )
 
   ctx$.subscribe(async (ctx) => {