@sanity/pkg-utils 2.2.16 → 2.2.17

package/package.json

@@ -1,9 +1,6 @@
 {
-  "type": "module",
   "name": "@sanity/pkg-utils",
-  "version": "2.2.16",
-  "author": "Sanity.io <hello@sanity.io>",
-  "license": "MIT",
+  "version": "2.2.17",
   "description": "Simple utilities for modern npm packages.",
   "keywords": [
     "sanity-io",
@@ -14,10 +11,17 @@
     "build",
     "bundling"
   ],
-  "source": "./src/node/index.ts",
-  "main": "./dist/index.cjs",
-  "module": "./dist/index.js",
-  "types": "./dist/index.d.ts",
+  "homepage": "https://github.com/sanity-io/pkg-utils#readme",
+  "bugs": {
+    "url": "https://github.com/sanity-io/pkg-utils/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com/sanity-io/pkg-utils.git"
+  },
+  "license": "MIT",
+  "author": "Sanity.io <hello@sanity.io>",
+  "type": "module",
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
@@ -28,6 +32,10 @@
     },
     "./package.json": "./package.json"
   },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "source": "./src/node/index.ts",
+  "types": "./dist/index.d.ts",
   "bin": {
     "pkg": "./bin/pkg-utils.cjs",
     "pkg-utils": "./bin/pkg-utils.cjs"
@@ -46,7 +54,7 @@
     "clean": "rimraf dist",
     "commit": "cz",
     "extract": "sanity-tsdoc etl --outDir etc/api/@sanity/pkg-utils --tsconfig tsconfig.dist.json",
-    "format": "prettier --write --cache --ignore-unknown .",
+    "format": "prettier --write --cache --ignore-unknown . && eslint . --ext .cjs,.js,.ts,.tsx --fix --quiet",
     "lint": "eslint . --ext .cjs,.js,.ts,.tsx",
     "playground:build": "pnpm --filter './playground/**' build",
     "playground:clean": "pnpm --filter './playground/**' --silent clean",
@@ -55,10 +63,66 @@
     "test": "run-s playground:clean && rimraf test/env/__tmp__ && vitest run",
     "watch": "node --loader esbuild-register/loader -r esbuild-register scripts/watch"
   },
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ]
+  },
+  "lint-staged": {
+    "*": [
+      "prettier --write --cache --ignore-unknown",
+      "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
+        }
+      }
+    ]
+  },
+  "release": {
+    "branches": [
+      "+([0-9])?(.{+([0-9]),x}).x",
+      "main",
+      "next",
+      {
+        "name": "beta",
+        "prerelease": true
+      },
+      {
+        "name": "alpha",
+        "prerelease": true
+      }
+    ],
+    "extends": "@sanity/semantic-release-preset"
+  },
   "dependencies": {
-    "@babel/core": "^7.21.8",
-    "@babel/preset-env": "^7.21.5",
-    "@babel/types": "^7.21.5",
+    "@babel/core": "^7.22.1",
+    "@babel/preset-env": "^7.22.2",
+    "@babel/types": "^7.22.3",
     "@microsoft/api-extractor": "^7.35.0",
     "@microsoft/tsdoc-config": "^0.16.2",
     "@rollup/plugin-alias": "^5.0.0",
@@ -68,7 +132,7 @@
     "@rollup/plugin-node-resolve": "^15.0.2",
     "@rollup/plugin-replace": "^5.0.2",
     "@rollup/plugin-terser": "^0.4.3",
-    "browserslist": "^4.21.5",
+    "browserslist": "^4.21.7",
     "cac": "^6.7.14",
     "chalk": "^4.1.2",
     "chokidar": "^3.5.3",
@@ -91,14 +155,14 @@
     "zod": "^3.21.4"
   },
   "devDependencies": {
-    "@commitlint/cli": "^17.4.4",
-    "@commitlint/config-conventional": "^17.4.4",
+    "@commitlint/cli": "^17.6.3",
+    "@commitlint/config-conventional": "^17.6.3",
     "@sanity/pkg-utils": "workspace:*",
     "@sanity/semantic-release-preset": "4.1.1",
-    "@types/babel__core": "^7.20.0",
+    "@types/babel__core": "^7.20.1",
     "@types/cpx": "^1.5.2",
     "@types/find-config": "^1.0.1",
-    "@types/node": "^18.15.3",
+    "@types/node": "^20.2.5",
     "@types/prettier": "^2.7.2",
     "@types/treeify": "^1.0.0",
     "@types/uuid": "^9.0.1",
@@ -111,10 +175,12 @@
     "eslint-config-prettier": "^8.8.0",
     "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-prettier": "^4.2.1",
+    "eslint-plugin-simple-import-sort": "10.0.0",
     "husky": "^8.0.3",
     "lint-staged": "^13.2.2",
     "npm-run-all": "^4.1.5",
     "outdent": "^0.8.0",
+    "prettier-plugin-packagejson": "^2.4.3",
     "rollup-plugin-visualizer": "^5.9.0",
     "semantic-release": "^21.0.2",
     "ts-node": "^10.9.1",
@@ -124,76 +190,16 @@
   "peerDependencies": {
     "typescript": "^4.7 || ^5"
   },
+  "packageManager": "pnpm@8.6.0",
   "engines": {
-    "node": ">=14.0.0"
-  },
-  "lint-staged": {
-    "*": [
-      "prettier --write --cache --ignore-unknown"
-    ]
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+ssh://git@github.com/sanity-io/pkg-utils.git"
-  },
-  "bugs": {
-    "url": "https://github.com/sanity-io/pkg-utils/issues"
-  },
-  "homepage": "https://github.com/sanity-io/pkg-utils#readme",
-  "commitlint": {
-    "extends": [
-      "@commitlint/config-conventional"
-    ]
+    "node": ">=16.0.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "packageManager": "pnpm@7.32.4",
   "pnpm": {
     "overrides": {
       "@sanity/pkg-utils": "workspace:*"
     }
-  },
-  "prettier": {
-    "bracketSpacing": false,
-    "printWidth": 100,
-    "semi": false,
-    "singleQuote": true,
-    "tabWidth": 2,
-    "overrides": [
-      {
-        "files": [
-          "*.json5"
-        ],
-        "options": {
-          "singleQuote": false,
-          "quoteProps": "preserve"
-        }
-      },
-      {
-        "files": [
-          "*.yml"
-        ],
-        "options": {
-          "singleQuote": false
-        }
-      }
-    ]
-  },
-  "release": {
-    "extends": "@sanity/semantic-release-preset",
-    "branches": [
-      "+([0-9])?(.{+([0-9]),x}).x",
-      "main",
-      "next",
-      {
-        "name": "beta",
-        "prerelease": true
-      },
-      {
-        "name": "alpha",
-        "prerelease": true
-      }
-    ]
   }
 }

package/src/cli/index.ts

@@ -1,17 +1,18 @@
 import cac from 'cac'
+
 import {version} from '../../package.json'
 
 const cli = cac()
 
-// default commands checks package status
 cli
   .command('', 'Check')
+  .alias('check') // alias to align with the action name
   .option('--strict', 'Strict mode')
   .option('--tsconfig [tsconfig]', '[string] tsconfig.json')
   .action(async (options) => {
-    const {checkAction: statusAction} = await import('./checkAction')
+    const {checkAction} = await import('./checkAction')
 
-    return statusAction(options)
+    return checkAction(options)
   })
 
 cli

package/src/node/build.ts

@@ -3,7 +3,7 @@ import {createLogger} from './logger'
 import {resolveBuildContext} from './resolveBuildContext'
 import {resolveBuildTasks} from './resolveBuildTasks'
 import {createSpinner} from './spinner'
-import {BuildTask, TaskHandler, buildTaskHandlers} from './tasks'
+import {BuildTask, buildTaskHandlers, TaskHandler} from './tasks'
 
 /**
  * Build the distribution files of a npm package.

package/src/node/check.ts

@@ -1,8 +1,10 @@
-import path from 'path'
 import esbuild, {BuildFailure} from 'esbuild'
+import path from 'path'
+
 import {getPkgExtMap, loadConfig, loadPkgWithReporting} from './core'
+import {fileExists} from './fileExists'
 import {createLogger} from './logger'
-import {fileExists, printPackageTree} from './printPackageTree'
+import {printPackageTree} from './printPackageTree'
 import {resolveBuildContext} from './resolveBuildContext'
 
 /** @public */

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

@@ -1,6 +1,7 @@
-import {stat} from 'fs/promises'
-import path from 'path'
 import findConfig from 'find-config'
+import path from 'path'
+
+import {fileExists} from '../../fileExists'
 
 const CONFIG_FILE_NAMES = [
   'package.config.ts',
@@ -9,7 +10,8 @@ const CONFIG_FILE_NAMES = [
   'package.config.mjs',
 ]
 
-export async function findConfigFile(cwd: string): Promise<string | undefined> {
+/** @internal */
+export function findConfigFile(cwd: string): string | undefined {
   const pkgJsonPath = findConfig('package.json', {cwd})
 
   if (!pkgJsonPath) return undefined
@@ -19,7 +21,7 @@ export async function findConfigFile(cwd: string): Promise<string | undefined> {
   for (const fileName of CONFIG_FILE_NAMES) {
     const configPath = path.resolve(pkgPath, fileName)
 
-    const exists = await fileExists(configPath)
+    const exists = fileExists(configPath)
 
     if (exists) {
       return configPath
@@ -28,13 +30,3 @@ export async function findConfigFile(cwd: string): Promise<string | undefined> {
 
   return undefined
 }
-
-async function fileExists(filePath: string) {
-  try {
-    await stat(filePath)
-
-    return true
-  } catch (_) {
-    return false
-  }
-}

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

@@ -1,4 +1,4 @@
+export * from './defineConfig'
 export * from './loadConfig'
 export * from './resolveConfigProperty'
-export * from './defineConfig'
 export * from './types'

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

@@ -1,6 +1,7 @@
-import path from 'path'
 import {register} from 'esbuild-register/dist/node'
+import path from 'path'
 import pkgUp from 'pkg-up'
+
 import {findConfigFile} from './findConfigFile'
 import {PkgConfigOptions} from './types'
 

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

@@ -1,6 +1,7 @@
 import ts from 'typescript'
+
 import {Logger} from '../../logger'
-import {PkgExports, PkgRuntime, PkgConfigOptions} from '../config'
+import {PkgConfigOptions, PkgExports, PkgRuntime} from '../config'
 import {PackageJSON, PkgExtMap} from '../pkg'
 
 /** @internal */

package/src/node/core/findCommonPath.test.ts

@@ -1,4 +1,5 @@
 import {expect, test} from 'vitest'
+
 import {findCommonDirPath} from './findCommonPath'
 
 test('should find common parent directory of paths', () => {

package/src/node/core/index.ts

@@ -1,6 +1,6 @@
-export * from './defaults'
-export * from './isRecord'
 export * from './config'
 export * from './contexts'
+export * from './defaults'
+export * from './isRecord'
 export * from './pkg'
 export * from './ts'

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

@@ -1,5 +1,6 @@
 import fs from 'fs/promises'
 import pkgUp from 'pkg-up'
+
 import {PackageJSON} from './types'
 import {validatePkg} from './validatePkg'
 

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

@@ -1,5 +1,6 @@
 import chalk from 'chalk'
 import {ZodError} from 'zod'
+
 import {Logger} from '../../logger'
 import {assertFirst, assertLast, assertOrder} from './helpers'
 import {loadPkg} from './loadPkg'

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

@@ -1,4 +1,5 @@
 import {z} from 'zod'
+
 import {PackageJSON} from './types'
 
 const pkgSchema = z.object({

package/src/node/fileExists.ts

@@ -0,0 +1,12 @@
+import {statSync} from 'fs'
+
+/** @internal */
+export function fileExists(filePath: string): boolean {
+  try {
+    statSync(filePath)
+
+    return true
+  } catch (_) {
+    return false
+  }
+}

package/src/node/globFiles.ts

@@ -1,5 +1,5 @@
-import path from 'path'
 import globby from 'globby'
+import path from 'path'
 
 export function globFiles(patterns: string[]): Promise<string[]> {
   return globby(patterns.map((pattern) => pattern.split(path.sep).join(path.posix.sep)))

package/src/node/printExtractMessages.ts

@@ -1,6 +1,7 @@
-import path from 'path'
 import {ExtractorMessage} from '@microsoft/api-extractor'
 import chalk from 'chalk'
+import path from 'path'
+
 import {BuildContext} from './core'
 
 export function printExtractMessages(ctx: BuildContext, messages: ExtractorMessage[]): void {

package/src/node/printPackageTree.ts

@@ -1,19 +1,10 @@
-import fs from 'fs'
-import path from 'path'
 import chalk from 'chalk'
+import path from 'path'
 import treeify from 'treeify'
-import {PkgExport, BuildContext} from './core'
-import {getFilesize} from './getFilesize'
-
-export function fileExists(file: string): boolean {
-  try {
-    fs.accessSync(file)
 
-    return true
-  } catch (_) {
-    return false
-  }
-}
+import {BuildContext, PkgExport} from './core'
+import {fileExists} from './fileExists'
+import {getFilesize} from './getFilesize'
 
 function getFileInfo(cwd: string, filePath: string) {
   const p = path.resolve(cwd, filePath)

package/src/node/resolveBuildContext.ts

@@ -1,15 +1,16 @@
 import path from 'path'
+
 import {
-  PkgConfigOptions,
-  PkgExports,
-  PkgRuntime,
   BuildContext,
   DEFAULT_BROWSERSLIST_QUERY,
   loadTSConfig,
   PackageJSON,
   parseExports,
-  resolveConfigProperty,
+  PkgConfigOptions,
+  PkgExports,
   PkgExtMap,
+  PkgRuntime,
+  resolveConfigProperty,
 } from './core'
 import {findCommonDirPath, pathContains} from './core/findCommonPath'
 import {Logger} from './logger'

package/src/node/resolveBuildTasks.ts

@@ -1,6 +1,7 @@
 import fs from 'fs'
 import path from 'path'
-import {PkgExport, PkgFormat, PkgRuntime, BuildContext} from './core'
+
+import {BuildContext, PkgExport, PkgFormat, PkgRuntime} from './core'
 import {BuildTask, DtsTask, NodeReExportFromCJSTask, RollupTask, RollupTaskEntry} from './tasks'
 
 /** @internal */

package/src/node/resolveWatchTasks.ts

@@ -1,7 +1,8 @@
 import fs from 'fs'
 import path from 'path'
-import {PkgExport, PkgFormat, PkgRuntime, BuildContext} from './core'
-import {WatchTask, DtsWatchTask, RollupWatchTask, RollupTaskEntry} from './tasks'
+
+import {BuildContext, PkgExport, PkgFormat, PkgRuntime} from './core'
+import {DtsWatchTask, RollupTaskEntry, RollupWatchTask, WatchTask} from './tasks'
 
 /** @internal */
 export function resolveWatchTasks(ctx: BuildContext): WatchTask[] {

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

@@ -1,4 +1,5 @@
 import ts from 'typescript'
+
 import {Logger} from '../../logger'
 import {printDiagnostic} from './printDiagnostic'
 

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

@@ -1,5 +1,5 @@
-import path from 'path'
 import {IConfigFile, IExtractorMessagesConfig} from '@microsoft/api-extractor'
+import path from 'path'
 
 export function createApiExtractorConfig(options: {
   distPath: string

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

@@ -1,5 +1,5 @@
-import {readFile} from 'fs/promises'
 import {TSDocConfigFile} from '@microsoft/tsdoc-config'
+import {readFile} from 'fs/promises'
 import {parse} from 'jsonc-parser'
 
 /** @public */

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

@@ -1,6 +1,7 @@
-import path from 'path'
 import {ExtractorMessage} from '@microsoft/api-extractor'
+import path from 'path'
 import {rimraf} from 'rimraf'
+
 import {BuildContext} from '../../core'
 import {buildTypes} from './buildTypes'
 import {DtsError} from './DtsError'

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

@@ -1,5 +1,6 @@
 import chalk from 'chalk'
 import {Observable} from 'rxjs'
+
 import {printExtractMessages} from '../../printExtractMessages'
 import {TaskHandler} from '../types'
 import {doExtract} from './doExtract'

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

@@ -1,5 +1,6 @@
 import chalk from 'chalk'
 import {Observable} from 'rxjs'
+
 import {printExtractMessages} from '../../printExtractMessages'
 import {TaskHandler} from '../types'
 import {doExtract} from './doExtract'

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

@@ -1,14 +1,15 @@
-import fs from 'fs/promises'
-import path from 'path'
 import {
   Extractor,
   ExtractorConfig,
   ExtractorMessage,
   ExtractorResult,
 } from '@microsoft/api-extractor'
+import fs from 'fs/promises'
 import {mkdirp} from 'mkdirp'
+import path from 'path'
 import prettier from 'prettier'
-import {PkgConfigOptions, BuildFile} from '../../core'
+
+import {BuildFile, PkgConfigOptions} from '../../core'
 import {createApiExtractorConfig} from './createApiExtractorConfig'
 import {createTSDocConfig} from './createTSDocConfig'
 import {extractModuleBlocksFromTypes} from './extractModuleBlocks'

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

@@ -1,5 +1,6 @@
 import {ExtractorLogLevel, IExtractorMessagesConfig} from '@microsoft/api-extractor'
-import {PkgRuleLevel, PkgConfigOptions} from '../../core'
+
+import {PkgConfigOptions, PkgRuleLevel} from '../../core'
 
 const LOG_LEVELS: Record<PkgRuleLevel, ExtractorLogLevel> = {
   error: 'error' as ExtractorLogLevel.Error,

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

@@ -1,6 +1,7 @@
-import path from 'path'
 import chalk from 'chalk'
+import path from 'path'
 import ts from 'typescript'
+
 import {Logger} from '../../logger'
 
 export function printDiagnostic(options: {

package/src/node/tasks/index.ts

@@ -3,9 +3,9 @@ import {nodeReexportCjsTask} from './node/reexportCjsTask'
 import {rollupTask, rollupWatchTask} from './rollup'
 import {BuildTaskHandlers, WatchTaskHandlers} from './types'
 
-export * from './types'
 export * from './dts'
 export * from './rollup'
+export * from './types'
 
 /** @internal */
 export const buildTaskHandlers: BuildTaskHandlers = {

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

@@ -1,8 +1,9 @@
-import {writeFile} from 'fs/promises'
-import path from 'path'
 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'
 

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

@@ -1,4 +1,3 @@
-import path from 'path'
 import alias from '@rollup/plugin-alias'
 import {getBabelOutputPlugin} from '@rollup/plugin-babel'
 import commonjs from '@rollup/plugin-commonjs'
@@ -6,8 +5,10 @@ import json from '@rollup/plugin-json'
 import {nodeResolve} from '@rollup/plugin-node-resolve'
 import replace from '@rollup/plugin-replace'
 import terser from '@rollup/plugin-terser'
+import path from 'path'
 import {InputOptions, OutputOptions, Plugin} from 'rollup'
 import esbuild from 'rollup-plugin-esbuild'
+
 import {BuildContext, DEFAULT_BROWSERSLIST_QUERY, resolveConfigProperty} from '../../core'
 import {RollupTask, RollupWatchTask} from '../types'
 

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

@@ -1,7 +1,8 @@
-import path from 'path'
 import chalk from 'chalk'
+import path from 'path'
 import {rollup} from 'rollup'
 import {Observable} from 'rxjs'
+
 import {BuildContext} from '../../core'
 import {RollupTask, TaskHandler} from '../types'
 import {createConsoleSpy} from './consoleSpy'

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

@@ -1,7 +1,8 @@
-import path from 'path'
 import chalk from 'chalk'
+import path from 'path'
 import {RollupWatcherEvent, RollupWatchOptions, watch as rollupWatch} from 'rollup'
 import {Observable} from 'rxjs'
+
 import {RollupWatchTask, TaskHandler} from '../types'
 import {resolveRollupConfig} from './resolveRollupConfig'
 

package/src/node/tasks/types.ts

@@ -1,6 +1,7 @@
 import {RollupWatcherEvent} from 'rollup'
 import {Observable} from 'rxjs'
-import {PkgRuntime, BuildContext} from '../core'
+
+import {BuildContext, PkgRuntime} from '../core'
 import {DtsResult, DtsTask, DtsWatchTask} from './dts'
 
 /** @internal */