@sanity/pkg-utils 3.1.1 → 3.2.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/pkg-utils",
-  "version": "3.1.1",
+  "version": "3.2.1",
   "description": "Simple utilities for modern npm packages.",
   "keywords": [
     "sanity-io",
@@ -57,35 +57,6 @@
       "eslint --ext .cjs,.js,.ts,.tsx --fix"
     ]
   },
-  "prettier": {
-    "bracketSpacing": false,
-    "plugins": [
-      "prettier-plugin-packagejson"
-    ],
-    "printWidth": 100,
-    "semi": false,
-    "singleQuote": true,
-    "tabWidth": 2,
-    "overrides": [
-      {
-        "files": [
-          "*.json5"
-        ],
-        "options": {
-          "quoteProps": "preserve",
-          "singleQuote": false
-        }
-      },
-      {
-        "files": [
-          "*.yml"
-        ],
-        "options": {
-          "singleQuote": false
-        }
-      }
-    ]
-  },
   "dependencies": {
     "@babel/core": "^7.23.2",
     "@babel/preset-env": "^7.23.2",
@@ -107,7 +78,7 @@
     "esbuild-register": "^3.5.0",
     "find-config": "^1.0.0",
     "get-latest-version": "^5.1.0",
-    "git-url-parse": "^13.1.0",
+    "git-url-parse": "^13.1.1",
     "globby": "^11.1.0",
     "jsonc-parser": "^3.2.0",
     "mkdirp": "^3.0.1",
@@ -127,8 +98,8 @@
     "zod": "^3.22.4"
   },
   "devDependencies": {
-    "@commitlint/cli": "^17.8.0",
-    "@commitlint/config-conventional": "^17.8.0",
+    "@commitlint/cli": "^18.0.0",
+    "@commitlint/config-conventional": "^18.0.0",
     "@types/babel__core": "^7.20.3",
     "@types/cpx": "^1.5.4",
     "@types/find-config": "^1.0.3",
@@ -138,19 +109,19 @@
     "@types/prompts": "^2.4.7",
     "@types/rimraf": "^3.0.2",
     "@types/treeify": "^1.0.2",
-    "@types/uuid": "^9.0.5",
+    "@types/uuid": "^9.0.6",
     "@typescript-eslint/eslint-plugin": "^6.8.0",
     "@typescript-eslint/parser": "^6.8.0",
     "commitizen": "^4.3.0",
     "cpx": "^1.5.0",
     "cz-conventional-changelog": "^3.3.0",
-    "eslint": "^8.51.0",
+    "eslint": "^8.52.0",
     "eslint-config-prettier": "^9.0.0",
-    "eslint-plugin-import": "^2.28.1",
+    "eslint-plugin-import": "^2.29.0",
     "eslint-plugin-prettier": "^5.0.1",
     "eslint-plugin-simple-import-sort": "10.0.0",
     "husky": "^8.0.3",
-    "lint-staged": "^15.0.1",
+    "lint-staged": "^15.0.2",
     "npm-run-all": "^4.1.5",
     "outdent": "^0.8.0",
     "recast": "^0.23.4",
@@ -159,7 +130,7 @@
     "typescript": "^5.2.2",
     "vitest": "^0.34.6",
     "vitest-github-actions-reporter": "^0.10.0",
-    "@sanity/pkg-utils": "3.1.1"
+    "@sanity/pkg-utils": "3.2.1"
   },
   "peerDependencies": {
     "typescript": "^4.7 || ^5"
@@ -173,10 +144,10 @@
   },
   "scripts": {
     "build": "run-s clean build:pkg check:pkg",
-    "build:pkg": "node --loader esbuild-register/loader -r esbuild-register scripts/build",
-    "check:pkg": "node --loader esbuild-register/loader -r esbuild-register scripts/check",
+    "build:pkg": "node -r esbuild-register scripts/build",
+    "check:pkg": "node -r esbuild-register scripts/check",
     "check:types": "tsc --build",
-    "clean": "rimraf dist",
+    "clean": "rimraf dist test/env/__tmp__",
     "commit": "cz",
     "extract": "sanity-tsdoc etl --outDir etc/api/@sanity/pkg-utils --tsconfig tsconfig.dist.json",
     "format": "prettier --write --cache --ignore-unknown . && eslint . --ext .cjs,.js,.ts,.tsx --fix --quiet",
@@ -186,6 +157,6 @@
     "test": "run-s playground:clean test:clean vitest:run",
     "test:clean": "rimraf test/env/__tmp__",
     "vitest:run": "vitest run",
-    "watch": "node --loader esbuild-register/loader -r esbuild-register scripts/watch"
+    "watch": "node -r esbuild-register scripts/watch"
   }
 }

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

@@ -79,6 +79,7 @@ export interface PkgConfigOptions {
   dist?: string
   exports?: PkgConfigProperty<PkgExports>
   extract?: {
+    bundledPackages?: string[]
     customTags?: TSDocCustomTag[]
     rules?: {
       'ae-forgotten-export'?: PkgRuleLevel

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

@@ -8,9 +8,9 @@ export interface PackageJSON {
   description?: string
   keywords?: string[]
   bin?: Record<string, string>
-  dependencies?: Record<string, string>
-  devDependencies?: Record<string, string>
-  peerDependencies?: Record<string, string>
+  dependencies?: Record<string, string | undefined>
+  devDependencies?: Record<string, string | undefined>
+  peerDependencies?: Record<string, string | undefined>
   exports?: Record<
     string,
     | `./${string}.json`
@@ -40,7 +40,7 @@ export interface PackageJSON {
   module?: string
   types?: string
   files?: string[]
-  scripts?: Record<string, string>
+  scripts?: Record<string, string | undefined>
   browserslist?: string[]
   engines?: {
     node?: string

package/src/node/core/ts/loadTSConfig.ts

@@ -4,13 +4,13 @@ import ts from 'typescript'
 export async function loadTSConfig(options: {
   cwd: string
   tsconfigPath: string
-}): Promise<ts.ParsedCommandLine> {
+}): Promise<ts.ParsedCommandLine | undefined> {
   const {cwd, tsconfigPath} = options
 
   const configPath = ts.findConfigFile(cwd, ts.sys.fileExists, tsconfigPath)
 
   if (!configPath) {
-    throw new Error(`could not find a valid '${tsconfigPath}'`)
+    return undefined
   }
 
   const configFile = ts.readConfigFile(configPath, ts.sys.readFile)

package/src/node/resolveBuildContext.ts

@@ -53,8 +53,8 @@ export async function resolveBuildContext(options: {
 
   const target: Record<PkgRuntime, string[]> = {
     '*': webTarget.concat(nodeTarget),
-    browser: webTarget,
-    node: nodeTarget,
+    'browser': webTarget,
+    'node': nodeTarget,
   }
 
   const parsedExports = parseExports({extMap, pkg, strict}).reduce<PkgExports>((acc, x) => {

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

@@ -2,6 +2,7 @@ import {IConfigFile, IExtractorMessagesConfig} from '@microsoft/api-extractor'
 import path from 'path'
 
 export function createApiExtractorConfig(options: {
+  bundledPackages?: string[]
   distPath: string
   exportPath: string
   filePath: string
@@ -11,6 +12,7 @@ export function createApiExtractorConfig(options: {
   tsconfigPath: string
 }): IConfigFile {
   const {
+    bundledPackages,
     distPath,
     exportPath,
     filePath,
@@ -25,7 +27,7 @@ export function createApiExtractorConfig(options: {
       enabled: false,
       reportFileName: '<unscopedPackageName>.api.md',
     },
-    // bundledPackages: [],
+    bundledPackages,
     compiler: {
       tsconfigFilePath: tsconfigPath,
     },

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

@@ -47,6 +47,7 @@ export async function doExtract(
     const targetPath = path.resolve(cwd, entry.targetPath)
     const filePath = path.relative(outDir, targetPath)
     const result = await extractTypes({
+      bundledPackages: config?.extract?.bundledPackages || [],
       customTags: config?.extract?.customTags,
       cwd,
       distPath: outDir,
@@ -63,6 +64,7 @@ export async function doExtract(
     messages.push(...result.messages)
 
     const errors = result.messages.filter((msg) => msg.logLevel === 'error')
+
     if (errors.length > 0) {
       await rimraf(tmpPath)
       throw new DtsError(`encountered ${errors.length} errors when extracting types`, errors)

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

@@ -16,6 +16,7 @@ import {extractModuleBlocksFromTypes} from './extractModuleBlocks'
 import {getExtractMessagesConfig} from './getExtractMessagesConfig'
 
 export async function extractTypes(options: {
+  bundledPackages?: string[]
   customTags: NonNullable<PkgConfigOptions['extract']>['customTags']
   cwd: string
   distPath: string
@@ -29,6 +30,7 @@ export async function extractTypes(options: {
   tsconfigPath: string
 }): Promise<{extractorResult: ExtractorResult; messages: ExtractorMessage[]}> {
   const {
+    bundledPackages,
     customTags,
     distPath,
     exportPath,
@@ -47,6 +49,7 @@ export async function extractTypes(options: {
 
   const extractorConfig: ExtractorConfig = ExtractorConfig.prepare({
     configObject: createApiExtractorConfig({
+      bundledPackages,
       distPath,
       exportPath,
       filePath,

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

@@ -32,7 +32,7 @@ export function getExtractMessagesConfig(options: {
     },
 
     extractorMessageReporting: {
-      default: {
+      'default': {
         logLevel: 'warning' as ExtractorLogLevel,
         addToApiReportFile: false,
       },
@@ -64,7 +64,7 @@ export function getExtractMessagesConfig(options: {
     },
 
     tsdocMessageReporting: {
-      default: {
+      'default': {
         logLevel: 'warning' as ExtractorLogLevel,
         addToApiReportFile: false,
       },

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

@@ -105,6 +105,11 @@ export const defaultTemplate: PkgTemplate = async ({cwd, logger, packagePath}) =
         optional: true,
         initial: true,
       },
+      {
+        name: 'prettier',
+        optional: true,
+        initial: true,
+      },
       {
         name: 'typescript',
         optional: true,
@@ -121,69 +126,86 @@ export const defaultTemplate: PkgTemplate = async ({cwd, logger, packagePath}) =
           .filter(Boolean)
           .join(' ') ?? undefined
 
-      const prettierConfig: PrettierConfig = {
-        bracketSpacing: false,
-        printWidth: 100,
-        semi: false,
-        singleQuote: true,
-        tabWidth: 2,
-        plugins: ['prettier-plugin-packagejson'],
-        overrides: [
-          {
-            files: ['*.yml'],
-            options: {
-              singleQuote: false,
-            },
-          },
-        ],
-      }
+      const prettierConfig: PrettierConfig | undefined = features.prettier
+        ? {
+            bracketSpacing: false,
+            plugins: ['prettier-plugin-packagejson'],
+            printWidth: 100,
+            quoteProps: 'consistent',
+            semi: false,
+            singleQuote: true,
+            tabWidth: 2,
+            overrides: [
+              {
+                files: ['*.yml'],
+                options: {
+                  singleQuote: false,
+                },
+              },
+            ],
+          }
+        : undefined
 
       const pkgJson: PackageJSON & {
         prettier?: PrettierConfig
         ['lint-staged']?: Record<string, string[]>
       } = {
         name,
-        version: '0.0.0',
-        description: options.description ?? undefined,
-        keywords: [],
-        license: options.license,
+        'version': '0.0.0',
+        'description': options.description ?? undefined,
+        'keywords': [],
+        'homepage': undefined,
+        'bugs': undefined,
+        'repository': undefined,
+        'license': options.license,
         author,
-        type: 'module',
-        exports: {
+        'type': 'module',
+        'exports': {
           '.': {
             types: undefined,
             source: features.typescript ? './src/index.ts' : './src/index.js',
-            require: './dist/index.cjs',
             import: './dist/index.js',
+            require: './dist/index.cjs',
             default: './dist/index.js',
           },
           './package.json': './package.json',
         },
-        main: './dist/index.cjs',
-        module: './dist/index.js',
-        source: features.typescript ? './src/index.ts' : './src/index.js',
-        files: ['dist', 'src'],
-        scripts: {
-          build: 'run-s clean pkg:build pkg:check',
-          clean: 'rimraf dist',
-          format: 'prettier --write --cache --ignore-unknown .',
+        'main': './dist/index.cjs',
+        'module': './dist/index.js',
+        'source': features.typescript ? './src/index.ts' : './src/index.js',
+        'types': undefined,
+        'files': ['dist', 'src'],
+        'scripts': {
+          'build': 'run-s clean pkg:build pkg:check',
+          'clean': 'rimraf dist',
+          'format': features.prettier ? 'prettier --write --cache --ignore-unknown .' : undefined,
           'pkg:build': 'pkg build --strict',
           'pkg:check': 'pkg check --strict',
         },
-        prettier: prettierConfig,
-        'lint-staged': {
-          '*': ['prettier --write --cache --ignore-unknown'],
-        },
-        dependencies: {},
-        devDependencies: {
+        'lint-staged': features.prettier
+          ? {
+              '*': ['prettier --write --cache --ignore-unknown'],
+            }
+          : undefined,
+        // prettier: prettierConfig,
+        'dependencies': {},
+        'devDependencies': {
           '@sanity/pkg-utils': '*',
+          '@typescript-eslint/eslint-plugin': undefined,
+          '@typescript-eslint/parser': undefined,
+          'eslint': undefined,
+          'eslint-config-prettier': undefined,
+          'eslint-plugin-import': undefined,
+          'eslint-plugin-prettier': undefined,
+          'eslint-plugin-simple-import-sort': undefined,
           'lint-staged': '*',
           'npm-run-all': '*',
-          prettier: '*',
-          'prettier-plugin-packagejson': '*',
-          rimraf: '*',
+          'prettier': features.prettier ? '*' : undefined,
+          'prettier-plugin-packagejson': features.prettier ? '*' : undefined,
+          'rimraf': '*',
+          'typescript': undefined,
         },
-        engines: {
+        'engines': {
           node: '>=18.0.0',
         },
       }
@@ -212,21 +234,33 @@ export const defaultTemplate: PkgTemplate = async ({cwd, logger, packagePath}) =
         contents: outdent`
         *.local
         *.log
+        *.tgz
 
         .DS_Store
-        etc
         dist
+        etc
         node_modules
         `,
       })
 
-      files.push({
-        name: '.prettierignore',
-        contents: outdent`
-        /dist
-        /pnpm-lock.yaml
-        `,
-      })
+      if (features.prettier) {
+        files.push({
+          name: '.prettierignore',
+          contents: outdent`
+          dist
+          pnpm-lock.yaml
+          `,
+        })
+
+        files.push({
+          name: '.prettierrc',
+          contents: await format(
+            resolve(packagePath, '.prettierrc.json'),
+            JSON.stringify(prettierConfig, null, 2) + '\n',
+            prettierConfig,
+          ),
+        })
+      }
 
       if (repo) {
         pkgJson.repository = {
@@ -250,7 +284,7 @@ export const defaultTemplate: PkgTemplate = async ({cwd, logger, packagePath}) =
 
         pkgJson.scripts = {
           ...pkgJson.scripts,
-          ['type:check']: 'tsc --build',
+          ['ts:check']: 'tsc --build',
         }
 
         const devDependencies = pkgJson.devDependencies
@@ -269,23 +303,32 @@ export const defaultTemplate: PkgTemplate = async ({cwd, logger, packagePath}) =
             es6: true,
             node: true,
           },
-          extends: ['eslint:recommended', 'plugin:prettier/recommended'],
+          extends: [
+            'eslint:recommended',
+            features.prettier ? 'plugin:prettier/recommended' : undefined,
+          ].filter(Boolean),
           parserOptions: {
             ecmaVersion: 2020,
             sourceType: 'module',
           },
-          plugins: ['import', 'prettier'],
+          plugins: [
+            'import',
+            'simple-import-sort',
+            features.prettier ? 'prettier' : undefined,
+          ].filter(Boolean),
           rules: {
             'no-console': 'error',
             'no-shadow': 'error',
             'no-warning-comments': ['warn', {location: 'start', terms: ['todo', 'fixme']}],
+            'quote-props': ['warn', 'consistent-as-needed'],
+            'strict': ['warn', 'global'],
           },
         }
 
         files.push({
           name: '.eslintignore',
           contents: outdent`
-          /dist
+          dist
           `,
         })
 
@@ -298,10 +341,11 @@ export const defaultTemplate: PkgTemplate = async ({cwd, logger, packagePath}) =
 
         pkgJson.devDependencies = {
           ...pkgJson.devDependencies,
-          eslint: '*',
-          'eslint-config-prettier': '*',
+          'eslint': '*',
+          'eslint-config-prettier': features.prettier ? '*' : undefined,
+          'eslint-plugin-simple-import-sort': '*',
           'eslint-plugin-import': '*',
-          'eslint-plugin-prettier': '*',
+          'eslint-plugin-prettier': features.prettier ? '*' : undefined,
         }
 
         if (features.typescript) {
@@ -320,11 +364,16 @@ export const defaultTemplate: PkgTemplate = async ({cwd, logger, packagePath}) =
             },
             extends: [
               'eslint:recommended',
-              'plugin:prettier/recommended',
+              features.prettier ? 'plugin:prettier/recommended' : undefined,
               'plugin:@typescript-eslint/eslint-recommended',
               'plugin:@typescript-eslint/recommended',
             ].filter(Boolean),
-            plugins: ['import', '@typescript-eslint', 'prettier'].filter(Boolean),
+            plugins: [
+              'import',
+              '@typescript-eslint',
+              'simple-import-sort',
+              features.prettier ? 'prettier' : undefined,
+            ].filter(Boolean),
             rules: {
               '@typescript-eslint/explicit-module-boundary-types': 'error',
               '@typescript-eslint/interface-name-prefix': 'off',
@@ -359,32 +408,32 @@ export const defaultTemplate: PkgTemplate = async ({cwd, logger, packagePath}) =
             outdent`
             {
               "compilerOptions": {
-                "module": "ES2020",
+                // Completeness
+                "skipLibCheck": true,
+
+                // Interop constraints
+                "allowSyntheticDefaultImports": true,
+                "esModuleInterop": true,
+
+                // Language and environment
                 "target": "ES2020",
-                "declaration": true,
-                "declarationMap": true,
-                "sourceMap": true,
 
-                // Strict type-checking
-                "strict": true,
+                // Modules
+                "module": "ES2020",
+                "moduleResolution": "Node",
+
+                // Type checking
+                "alwaysStrict": true,
+                "noFallthroughCasesInSwitch": true,
                 "noImplicitAny": true,
-                "strictNullChecks": true,
-                "strictFunctionTypes": true,
-                "strictPropertyInitialization": true,
+                "noImplicitReturns": true,
                 "noImplicitThis": true,
-                "alwaysStrict": true,
-
-                // Additional checks
                 "noUnusedLocals": true,
                 "noUnusedParameters": true,
-                "noImplicitReturns": true,
-                "noFallthroughCasesInSwitch": true,
-                "skipLibCheck": true,
-
-                // Module resolution
-                "moduleResolution": "node",
-                "allowSyntheticDefaultImports": true,
-                "esModuleInterop": true
+                "strict": true,
+                "strictFunctionTypes": true,
+                "strictNullChecks": true,
+                "strictPropertyInitialization": true
               }
             }
             `,
@@ -400,10 +449,10 @@ export const defaultTemplate: PkgTemplate = async ({cwd, logger, packagePath}) =
             {
               "extends": "./tsconfig.settings",
               "include": ["./src"],
+              "exclude": ["./src/**/*.test.ts"],
               "compilerOptions": {
                 "rootDir": ".",
                 "outDir": "./dist",
-                "emitDeclarationOnly": true,
                 "resolveJsonModule": true
               }
             }
@@ -419,7 +468,8 @@ export const defaultTemplate: PkgTemplate = async ({cwd, logger, packagePath}) =
             outdent`
             {
               "extends": "./tsconfig.settings",
-              "include": ["./*.cjs", "./*.ts", "./package.config.ts", "./src"],
+              "include": ["./**/*.cjs", "./**/*.ts", "./**/*.tsx"],
+              "exclude": ["./node_modules"],
               "compilerOptions": {
                 "rootDir": ".",
                 "outDir": "./dist",
@@ -443,14 +493,8 @@ export const defaultTemplate: PkgTemplate = async ({cwd, logger, packagePath}) =
             outdent`
             import {defineConfig} from '@sanity/pkg-utils'
 
+            // https://github.com/sanity-io/pkg-utils#configuration
             export default defineConfig({
-              extract: {
-                rules: {
-                  // do not require internal members to be prefixed with \`_\`
-                  'ae-internal-missing-underscore': 'off',
-                },
-              },
-
               // the path to the tsconfig file for distributed builds
               tsconfig: 'tsconfig.dist.json',
             })
@@ -536,19 +580,22 @@ export const defaultTemplate: PkgTemplate = async ({cwd, logger, packagePath}) =
   }
 }
 
-function format(filepath: string, input: string, prettierOptions: PrettierConfig) {
-  return prettier.format(input, {...prettierOptions, filepath})
+function format(filepath: string, input: string, prettierOptions: PrettierConfig | undefined) {
+  return prettier.format(input, {...prettierOptions, plugins: [], filepath})
 }
 
-async function resolveLatestDeps(deps: Record<string, string>) {
+async function resolveLatestDeps(deps: Record<string, string | undefined>) {
   const depsEntries = Object.entries(deps)
   const latestDeps: Record<string, string> = {}
 
   for (const entry of depsEntries) {
     const [name, version] = entry
-    const latestVersion = await getLatestVersion(name, version)
 
-    latestDeps[name] = latestVersion ? `^${latestVersion}` : version
+    if (version) {
+      const latestVersion = await getLatestVersion(name, version)
+
+      latestDeps[name] = latestVersion ? `^${latestVersion}` : version
+    }
   }
 
   return latestDeps