@sanity/pkg-utils 2.2.16 → 2.3.0

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.3.0",
   "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,19 +132,25 @@
     "@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",
     "esbuild": "^0.17.19",
     "esbuild-register": "^3.4.2",
     "find-config": "^1.0.0",
+    "get-latest-version": "^5.0.1",
+    "git-url-parse": "^13.1.0",
     "globby": "^11.1.0",
     "jsonc-parser": "^3.2.0",
     "mkdirp": "^3.0.1",
+    "outdent": "^0.8.0",
+    "parse-git-config": "^3.0.0",
     "pkg-up": "^3.1.0",
     "prettier": "^2.8.8",
+    "prettier-plugin-packagejson": "^2.4.3",
     "pretty-bytes": "^5.6.0",
+    "prompts": "^2.4.2",
     "recast": "^0.23.2",
     "rimraf": "^5.0.1",
     "rollup": "^3.23.0",
@@ -91,15 +161,18 @@
     "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/git-url-parse": "^9.0.1",
+    "@types/node": "^20.2.5",
+    "@types/parse-git-config": "^3.0.1",
     "@types/prettier": "^2.7.2",
+    "@types/prompts": "^2.4.4",
     "@types/treeify": "^1.0.0",
     "@types/uuid": "^9.0.1",
     "@typescript-eslint/eslint-plugin": "^5.59.7",
@@ -111,6 +184,7 @@
     "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",
@@ -124,76 +198,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
@@ -25,6 +26,14 @@ cli
     return buildAction(options)
   })
 
+cli.command('init [path]', 'Initialize package').action(async (p) => {
+  const {initAction} = await import('./initAction')
+
+  return initAction({
+    path: p,
+  })
+})
+
 cli
   .command('watch', 'Watch package')
   .option('--strict', 'Strict mode')

package/src/cli/initAction.ts

@@ -0,0 +1,13 @@
+import {init} from '../node/init'
+import {handleError} from './handleError'
+
+export async function initAction(options: {path: string}): Promise<void> {
+  try {
+    await init({
+      cwd: process.cwd(),
+      path: options.path,
+    })
+  } catch (err) {
+    handleError(err)
+  }
+}

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,7 @@
-export * from './defaults'
-export * from './isRecord'
 export * from './config'
 export * from './contexts'
+export * from './defaults'
+export * from './isRecord'
 export * from './pkg'
+export * from './template'
 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/types.ts

@@ -3,7 +3,10 @@ export interface PackageJSON {
   type?: 'commonjs' | 'module'
   version: string
   private?: boolean
+  author?: string | {name: string; email?: string; url?: string}
   name: string
+  description?: string
+  keywords?: string[]
   bin?: Record<string, string>
   dependencies?: Record<string, string>
   devDependencies?: Record<string, string>
@@ -34,5 +37,15 @@ export interface PackageJSON {
   source?: string
   module?: string
   types?: string
+  files?: string[]
+  scripts?: Record<string, string>
   browserslist?: string[]
+  engines?: {
+    node?: string
+    npm?: string
+  }
+  repository?: string | {type: 'git'; url: string}
+  bugs?: string | {url: string; email?: string}
+  homepage?: string
+  license?: string
 }

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/core/template/createFromTemplate.ts

@@ -0,0 +1,85 @@
+import {writeFile} from 'fs/promises'
+import {mkdirp} from 'mkdirp'
+import {dirname, relative, resolve} from 'path'
+import prompts from 'prompts'
+
+import {Logger} from '../../logger'
+import {PkgTemplate} from './types'
+
+const promptsTypes = {
+  string: 'text' as const,
+}
+
+/** @internal */
+export async function createFromTemplate(options: {
+  cwd: string
+  logger: Logger
+  packagePath: string
+  template: PkgTemplate
+}): Promise<void> {
+  const {cwd, logger, packagePath, template: templateOrResolver} = options
+
+  const template =
+    typeof templateOrResolver === 'function'
+      ? await templateOrResolver({cwd, logger, packagePath})
+      : templateOrResolver
+
+  logger.log('create new package at', relative(cwd, packagePath))
+
+  const templateOptions: Record<string, string> = {}
+
+  for (const templateOption of template.options) {
+    const templateValidate = templateOption.validate
+
+    const res = await prompts(
+      {
+        type: promptsTypes[templateOption.type],
+        name: templateOption.name,
+        message: templateOption.description,
+        validate: templateValidate ? (prev) => templateValidate(prev) : undefined,
+        initial:
+          typeof templateOption.initial === 'function'
+            ? templateOption.initial(templateOptions)
+            : templateOption.initial,
+      },
+      {onCancel: () => process.exit(0)}
+    )
+
+    templateOptions[templateOption.name] = templateOption.parse
+      ? templateOption.parse(res[templateOption.name])
+      : res[templateOption.name]
+  }
+
+  const features: Record<string, boolean> = {}
+
+  for (const templateFeature of template.features) {
+    const res = templateFeature.optional
+      ? await prompts(
+          {
+            type: 'confirm',
+            name: 'confirm',
+            message: `use ${templateFeature.name}?`,
+            initial: templateFeature.initial,
+          },
+          {onCancel: () => process.exit(0)}
+        )
+      : undefined
+
+    features[templateFeature.name] = res?.confirm || !templateFeature.optional
+  }
+
+  const files = await template.getFiles(templateOptions, features)
+
+  files.sort((a, b) => {
+    return a.name.localeCompare(b.name)
+  })
+
+  for (const file of files) {
+    const filePath = resolve(packagePath, file.name)
+
+    await mkdirp(dirname(filePath))
+    await writeFile(filePath, file.contents.trim() + '\n')
+
+    logger.success(`wrote ${relative(cwd, filePath)}`)
+  }
+}

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

@@ -0,0 +1,6 @@
+import {PkgTemplateOption} from './types'
+
+/** @public */
+export function defineTemplateOption<T>(option: PkgTemplateOption<T>): PkgTemplateOption<T> {
+  return option
+}

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

@@ -0,0 +1,3 @@
+export * from './createFromTemplate'
+export * from './define'
+export * from './types'

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

@@ -0,0 +1,45 @@
+import {Logger} from '../../logger'
+
+/** @public */
+export interface PkgTemplateFile {
+  name: string
+  contents: string
+}
+
+/** @public */
+export interface PkgTemplateStringOption<T = string> {
+  name: string
+  type: 'string'
+  description: string
+  initial?: T | ((options: Record<string, any>) => T)
+  parse?: (v: string) => T | null
+  validate?: (v: string) => string | true
+}
+
+/** @public */
+export type PkgTemplateOption<T = string> = PkgTemplateStringOption<T>
+
+/** @public */
+export interface PkgTemplateDefinition {
+  options: PkgTemplateStringOption<any>[]
+  features: {
+    name: string
+    optional: boolean
+    initial: boolean
+  }[]
+  getFiles: (
+    options: Record<string, any>,
+    features: Record<string, boolean>
+  ) => Promise<PkgTemplateFile[]>
+}
+
+/** @public */
+export type PkgTemplateResolver = (options: {
+  cwd: string
+  /** @internal */
+  logger: Logger
+  packagePath: string
+}) => PkgTemplateDefinition | Promise<PkgTemplateDefinition>
+
+/** @public */
+export type PkgTemplate = PkgTemplateDefinition | PkgTemplateResolver

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/index.ts

@@ -1,6 +1,7 @@
 export * from './build'
 export * from './check'
 export * from './core'
+export * from './init'
 export * from './logger'
 export * from './resolveBuildTasks'
 export * from './tasks'