@sanity/pkg-utils 7.2.10-canary.0 → 7.2.10-canary.2

package/src/cli/handleError.ts

@@ -1,11 +0,0 @@
-import chalk from 'chalk'
-
-export function handleError(err: unknown): void {
-  if (err instanceof Error) {
-    console.error(chalk.red('error'), err.message)
-  } else {
-    console.error(err)
-  }
-
-  process.exit(1)
-}

package/src/cli/index.ts

@@ -1,65 +0,0 @@
-import {cac} from 'cac'
-import {version} from '../../package.json'
-
-const cli = cac()
-
-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} = await import('./checkAction')
-
-    return checkAction(options)
-  })
-
-cli
-  .command('build', 'Build package')
-  .option('--emitDeclarationOnly', 'Emit d.ts only')
-  .option('--strict', 'Strict mode')
-  .option('--tsconfig [tsconfig]', '[string] tsconfig.json')
-  .option('--check', 'Run the check command after build (same as running `pkg build && pkg check`)')
-  .option('--clean', 'Clean the dist directory before building')
-  .action(async (options) => {
-    const {check = false, ...buildOptions} = options
-    const {buildAction} = await import('./buildAction')
-
-    await buildAction(buildOptions)
-
-    if (check) {
-      const {checkAction} = await import('./checkAction')
-
-      await checkAction({
-        strict: options.strict,
-        tsconfig: options.tsconfig,
-      })
-    }
-  })
-
-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')
-  .option('--tsconfig [tsconfig]', '[string] tsconfig.json')
-  .action(async (options) => {
-    const {watchAction} = await import('./watchAction')
-
-    return watchAction(options)
-  })
-
-// Display help message when `-h` or `--help` appears
-cli.help()
-
-// Display version number when `-v` or `--version` appears
-// It's also used in help message
-cli.version(version)
-
-cli.parse()

package/src/cli/initAction.ts

@@ -1,13 +0,0 @@
-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/cli/watchAction.ts

@@ -1,14 +0,0 @@
-import {watch} from '../node/watch'
-import {handleError} from './handleError'
-
-export async function watchAction(options: {strict?: boolean; tsconfig?: string}): Promise<void> {
-  try {
-    await watch({
-      cwd: process.cwd(),
-      strict: options.strict,
-      tsconfig: options.tsconfig,
-    })
-  } catch (err) {
-    handleError(err)
-  }
-}

package/src/global.ts

@@ -1,5 +0,0 @@
-declare global {
-  var __DEV__: boolean
-}
-
-export type {}

package/src/node/__snapshots__/strict.test.ts.snap

@@ -1,154 +0,0 @@
-// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
-
-exports[`{'noPackageJsonTypings': 'error'}} 1`] = `
-{
-  "alwaysPackageJsonFiles": "error",
-  "alwaysPackageJsonMain": "error",
-  "alwaysPackageJsonTypes": "error",
-  "noImplicitBrowsersList": "warn",
-  "noImplicitSideEffects": "warn",
-  "noPackageJsonTypings": "error",
-}
-`;
-
-exports[`{'noPackageJsonTypings': 'off'}} 1`] = `
-{
-  "alwaysPackageJsonFiles": "error",
-  "alwaysPackageJsonMain": "error",
-  "alwaysPackageJsonTypes": "error",
-  "noImplicitBrowsersList": "warn",
-  "noImplicitSideEffects": "warn",
-  "noPackageJsonTypings": "off",
-}
-`;
-
-exports[`{'noPackageJsonTypings': 'warn'}} 1`] = `
-{
-  "alwaysPackageJsonFiles": "error",
-  "alwaysPackageJsonMain": "error",
-  "alwaysPackageJsonTypes": "error",
-  "noImplicitBrowsersList": "warn",
-  "noImplicitSideEffects": "warn",
-  "noPackageJsonTypings": "warn",
-}
-`;
-
-exports[`{'noPackageJsonTypings': false}} 1`] = `
-[ZodError: [
-  {
-    "code": "invalid_union",
-    "unionErrors": [
-      {
-        "issues": [
-          {
-            "received": false,
-            "code": "invalid_literal",
-            "expected": "error",
-            "path": [
-              "strictOptions",
-              "noPackageJsonTypings"
-            ],
-            "message": "Validation error: Invalid literal value, expected \\"error\\" at \\"strictOptions.noPackageJsonTypings\\""
-          }
-        ],
-        "name": "ZodError"
-      },
-      {
-        "issues": [
-          {
-            "received": false,
-            "code": "invalid_literal",
-            "expected": "warn",
-            "path": [
-              "strictOptions",
-              "noPackageJsonTypings"
-            ],
-            "message": "Validation error: Invalid literal value, expected \\"warn\\" at \\"strictOptions.noPackageJsonTypings\\""
-          }
-        ],
-        "name": "ZodError"
-      },
-      {
-        "issues": [
-          {
-            "received": false,
-            "code": "invalid_literal",
-            "expected": "off",
-            "path": [
-              "strictOptions",
-              "noPackageJsonTypings"
-            ],
-            "message": "Validation error: Invalid literal value, expected \\"off\\" at \\"strictOptions.noPackageJsonTypings\\""
-          }
-        ],
-        "name": "ZodError"
-      }
-    ],
-    "path": [
-      "strictOptions",
-      "noPackageJsonTypings"
-    ],
-    "message": "Validation error: Validation error: Invalid literal value, expected \\"error\\" at \\"strictOptions.noPackageJsonTypings\\" at \\"strictOptions.noPackageJsonTypings\\", or Validation error: Invalid literal value, expected \\"warn\\" at \\"strictOptions.noPackageJsonTypings\\" at \\"strictOptions.noPackageJsonTypings\\", or Validation error: Invalid literal value, expected \\"off\\" at \\"strictOptions.noPackageJsonTypings\\" at \\"strictOptions.noPackageJsonTypings\\""
-  }
-]]
-`;
-
-exports[`{'noPackageJsonTypings': true}} 1`] = `
-[ZodError: [
-  {
-    "code": "invalid_union",
-    "unionErrors": [
-      {
-        "issues": [
-          {
-            "received": true,
-            "code": "invalid_literal",
-            "expected": "error",
-            "path": [
-              "strictOptions",
-              "noPackageJsonTypings"
-            ],
-            "message": "Validation error: Invalid literal value, expected \\"error\\" at \\"strictOptions.noPackageJsonTypings\\""
-          }
-        ],
-        "name": "ZodError"
-      },
-      {
-        "issues": [
-          {
-            "received": true,
-            "code": "invalid_literal",
-            "expected": "warn",
-            "path": [
-              "strictOptions",
-              "noPackageJsonTypings"
-            ],
-            "message": "Validation error: Invalid literal value, expected \\"warn\\" at \\"strictOptions.noPackageJsonTypings\\""
-          }
-        ],
-        "name": "ZodError"
-      },
-      {
-        "issues": [
-          {
-            "received": true,
-            "code": "invalid_literal",
-            "expected": "off",
-            "path": [
-              "strictOptions",
-              "noPackageJsonTypings"
-            ],
-            "message": "Validation error: Invalid literal value, expected \\"off\\" at \\"strictOptions.noPackageJsonTypings\\""
-          }
-        ],
-        "name": "ZodError"
-      }
-    ],
-    "path": [
-      "strictOptions",
-      "noPackageJsonTypings"
-    ],
-    "message": "Validation error: Validation error: Invalid literal value, expected \\"error\\" at \\"strictOptions.noPackageJsonTypings\\" at \\"strictOptions.noPackageJsonTypings\\", or Validation error: Invalid literal value, expected \\"warn\\" at \\"strictOptions.noPackageJsonTypings\\" at \\"strictOptions.noPackageJsonTypings\\", or Validation error: Invalid literal value, expected \\"off\\" at \\"strictOptions.noPackageJsonTypings\\" at \\"strictOptions.noPackageJsonTypings\\""
-  }
-]]
-`;

package/src/node/build.ts

@@ -1,100 +0,0 @@
-import path from 'node:path'
-import {rimraf} from 'rimraf'
-import {loadConfig} from './core/config/loadConfig'
-import {loadPkgWithReporting} from './core/pkg/loadPkgWithReporting'
-import {createLogger} from './logger'
-import {resolveBuildContext} from './resolveBuildContext'
-import {resolveBuildTasks} from './resolveBuildTasks'
-import {createSpinner} from './spinner'
-import {buildTaskHandlers} from './tasks'
-import {type BuildTask, type TaskHandler} from './tasks/types'
-
-/**
- * Build the distribution files of a npm package.
- *
- * @example
- * ```ts
- * import {build} from '@sanity/pkg-utils'
- *
- * build({
- *   cwd: process.cwd(),
- *   tsconfig: 'tsconfig.dist.json,
- * }).then(() => {
- *   console.log('successfully built')
- * }).catch((err) => {
- *   console.log(`build error: ${err.message}`)
- * })
- * ```
- *
- * @public
- */
-export async function build(options: {
-  cwd: string
-  emitDeclarationOnly?: boolean
-  strict?: boolean
-  tsconfig?: string
-  clean?: boolean
-}): Promise<void> {
-  const {
-    cwd,
-    emitDeclarationOnly,
-    strict = false,
-    tsconfig: tsconfigOption,
-    clean = false,
-  } = options
-  const logger = createLogger()
-
-  const config = await loadConfig({cwd})
-
-  const pkg = await loadPkgWithReporting({cwd, logger, strict})
-
-  const tsconfig = tsconfigOption || config?.tsconfig || 'tsconfig.json'
-
-  const ctx = await resolveBuildContext({
-    config,
-    cwd,
-    emitDeclarationOnly,
-    logger,
-    pkg,
-    strict,
-    tsconfig,
-  })
-
-  if (clean) {
-    logger.log(
-      `Deleting the \`dist\` folder: './${path.relative(cwd, ctx.distPath)}' before building...`,
-    )
-    await rimraf(ctx.distPath)
-  }
-
-  const buildTasks = resolveBuildTasks(ctx)
-
-  for (const task of buildTasks) {
-    const handler = buildTaskHandlers[task.type] as TaskHandler<BuildTask>
-    const taskName = handler.name(ctx, task)
-
-    const spinner = createSpinner(taskName)
-
-    try {
-      const result = await handler.exec(ctx, task).toPromise()
-
-      spinner.complete()
-      ctx.logger.log()
-
-      handler.complete(ctx, task, result)
-    } catch (err) {
-      spinner.error()
-
-      if (err instanceof Error) {
-        const RE_CWD = new RegExp(`${cwd}`, 'g')
-
-        ctx.logger.error(err.message.replace(RE_CWD, '.'))
-        ctx.logger.log()
-      }
-
-      handler.error(ctx, task, err)
-
-      process.exit(1)
-    }
-  }
-}

package/src/node/check.ts

@@ -1,188 +0,0 @@
-import path from 'node:path'
-import esbuild, {type BuildFailure, type Message} from 'esbuild'
-import {createConsoleSpy} from './consoleSpy'
-import {loadConfig} from './core/config/loadConfig'
-import {loadPkgWithReporting} from './core/pkg/loadPkgWithReporting'
-import {fileExists} from './fileExists'
-import {createLogger, type Logger} from './logger'
-import {printPackageTree} from './printPackageTree'
-import {resolveBuildContext} from './resolveBuildContext'
-
-/** @public */
-export async function check(options: {
-  cwd: string
-  strict?: boolean
-  tsconfig?: string
-}): Promise<void> {
-  const {cwd, strict = false, tsconfig: tsconfigOption} = options
-  const logger = createLogger()
-
-  const config = await loadConfig({cwd})
-  const pkg = await loadPkgWithReporting({cwd, logger, strict})
-  const tsconfig = tsconfigOption || config?.tsconfig || 'tsconfig.json'
-  const ctx = await resolveBuildContext({config, cwd, logger, pkg, strict, tsconfig})
-
-  printPackageTree(ctx)
-
-  if (strict) {
-    const missingFiles: string[] = []
-
-    // Check if there are missing files
-    for (const [, exp] of Object.entries(ctx.exports || {})) {
-      if (exp.source && !fileExists(path.resolve(cwd, exp.source))) {
-        missingFiles.push(exp.source)
-      }
-
-      if (exp.require && !fileExists(path.resolve(cwd, exp.require))) {
-        missingFiles.push(exp.require)
-      }
-
-      if (exp.import && !fileExists(path.resolve(cwd, exp.import))) {
-        missingFiles.push(exp.import)
-      }
-    }
-
-    if (ctx.pkg.types && !fileExists(path.resolve(cwd, ctx.pkg.types))) {
-      missingFiles.push(ctx.pkg.types)
-    }
-
-    if (missingFiles.length) {
-      logger.error(`missing files: ${missingFiles.join(', ')}`)
-      process.exit(1)
-    }
-
-    // Check if the files are resolved
-    const exportPaths: {require: string[]; import: string[]} = {
-      require: [],
-      import: [],
-    }
-
-    for (const exp of Object.values(ctx.exports || {})) {
-      if (!exp._exported) continue
-      if (exp.require) exportPaths.require.push(exp.require)
-      if (exp.import) exportPaths.import.push(exp.import)
-    }
-
-    const external = [
-      ...Object.keys(pkg.dependencies || {}),
-      ...Object.keys(pkg.devDependencies || {}),
-    ]
-
-    const consoleSpy = createConsoleSpy()
-
-    if (exportPaths.import.length) {
-      checkExports(exportPaths.import, {cwd, external, format: 'esm', logger})
-    }
-
-    if (exportPaths.require.length) {
-      checkExports(exportPaths.require, {cwd, external, format: 'cjs', logger})
-    }
-
-    consoleSpy.restore()
-  }
-}
-
-async function checkExports(
-  exportPaths: string[],
-  options: {cwd: string; external: string[]; format: 'esm' | 'cjs'; logger: Logger},
-) {
-  const {cwd, external, format, logger} = options
-
-  const code = exportPaths
-    .map((id) => (format ? `import('${id}');` : `require('${id}');`))
-    .join('\n')
-
-  try {
-    const esbuildResult = await esbuild.build({
-      bundle: true,
-      external,
-      format,
-      logLevel: 'silent',
-      // otherwise output maps to stdout as we're using stdin
-      outfile: '/dev/null',
-      platform: 'node',
-      stdin: {
-        contents: code,
-        loader: 'js',
-        resolveDir: cwd,
-      },
-    })
-
-    if (esbuildResult.errors.length > 0) {
-      for (const msg of esbuildResult.errors) {
-        printEsbuildMessage(logger.warn, msg)
-
-        logger.log()
-      }
-
-      process.exit(1)
-    }
-
-    const esbuildWarnings = esbuildResult.warnings.filter((msg) => {
-      !(msg.detail || msg.text).includes(`does not affect esbuild's own target setting`)
-    })
-
-    for (const msg of esbuildWarnings) {
-      printEsbuildMessage(logger.warn, msg)
-
-      logger.log()
-    }
-  } catch (err) {
-    if (isEsbuildFailure(err)) {
-      const {errors} = err
-
-      for (const msg of errors) {
-        printEsbuildMessage(logger.error, msg)
-
-        logger.log()
-      }
-    } else if (err instanceof Error) {
-      logger.error(err.stack || err.message)
-
-      logger.log()
-    } else {
-      logger.error(`${err}`)
-
-      logger.log()
-    }
-
-    process.exit(1)
-  }
-}
-
-function printEsbuildMessage(log: (...args: unknown[]) => void, msg: esbuild.Message) {
-  if (msg.location) {
-    log(
-      [
-        `${msg.detail || msg.text}\n`,
-        `${msg.location.line} | ${msg.location.lineText}\n`,
-        `in ./${msg.location.file}:${msg.location.line}:${msg.location.column}`,
-      ].join(''),
-    )
-  } else {
-    log(msg.detail || msg.text)
-  }
-}
-
-function isEsbuildFailure(err: unknown): err is BuildFailure {
-  return (
-    err instanceof Error &&
-    'errors' in err &&
-    Array.isArray(err.errors) &&
-    err.errors.every(isEsbuildMessage) &&
-    'warnings' in err &&
-    Array.isArray(err.warnings) &&
-    err.warnings.every(isEsbuildMessage)
-  )
-}
-
-function isEsbuildMessage(msg: unknown): msg is Message {
-  return (
-    typeof msg === 'object' &&
-    msg !== null &&
-    'text' in msg &&
-    typeof msg.text === 'string' &&
-    'location' in msg &&
-    (msg.location === null || typeof msg.location === 'object')
-  )
-}

package/src/node/consoleSpy.ts

@@ -1,39 +0,0 @@
-export interface ConsoleSpyMsg {
-  type: 'log' | 'warn' | 'error'
-  code?: string
-  args: unknown[]
-}
-
-export interface ConsoleSpy {
-  messages: ConsoleSpyMsg[]
-  restore: () => void
-}
-
-export function createConsoleSpy(options?: {
-  onRestored?: (messages: ConsoleSpyMsg[]) => void
-}): ConsoleSpy {
-  const {onRestored} = options || {}
-
-  const original = {
-    log: console.log,
-    warn: console.warn,
-    error: console.error,
-  }
-
-  const messages: ConsoleSpyMsg[] = []
-
-  console.log = (...args: unknown[]) => messages.push({type: 'log', args})
-  console.warn = (...args: unknown[]) => messages.push({type: 'warn', args})
-  console.error = (...args: unknown[]) => messages.push({type: 'error', args})
-
-  return {
-    messages,
-    restore: () => {
-      console.log = original.log
-      console.warn = original.warn
-      console.error = original.error
-
-      onRestored?.(messages)
-    },
-  }
-}

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

@@ -1,6 +0,0 @@
-import type {PkgConfigOptions} from './types'
-
-/** @public */
-export function defineConfig<const T extends PkgConfigOptions>(configOptions: T): T {
-  return configOptions
-}

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

@@ -1,31 +0,0 @@
-import path from 'node:path'
-import findConfig from 'find-config'
-import {fileExists} from '../../fileExists'
-
-const CONFIG_FILE_NAMES = [
-  'package.config.ts',
-  'package.config.js',
-  'package.config.cjs',
-  'package.config.mjs',
-]
-
-/** @internal */
-export function findConfigFile(cwd: string): string | undefined {
-  const pkgJsonPath = findConfig('package.json', {cwd})
-
-  if (!pkgJsonPath) return undefined
-
-  const pkgPath = path.dirname(pkgJsonPath)
-
-  for (const fileName of CONFIG_FILE_NAMES) {
-    const configPath = path.resolve(pkgPath, fileName)
-
-    const exists = fileExists(configPath)
-
-    if (exists) {
-      return configPath
-    }
-  }
-
-  return undefined
-}

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

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

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

@@ -1,37 +0,0 @@
-import path from 'node:path'
-import {register} from 'esbuild-register/dist/node'
-import pkgUp from 'pkg-up'
-import {findConfigFile} from './findConfigFile'
-import type {PkgConfigOptions} from './types'
-
-/** @alpha */
-export async function loadConfig(options: {cwd: string}): Promise<PkgConfigOptions | undefined> {
-  const {cwd} = options
-
-  const pkgPath = await pkgUp({cwd})
-
-  if (!pkgPath) return undefined
-
-  const root = path.dirname(pkgPath)
-
-  const configFile = await findConfigFile(root)
-
-  if (!configFile) {
-    return undefined
-  }
-
-  // Do not accept config files outside of the root
-  if (!configFile.startsWith(cwd)) {
-    return undefined
-  }
-
-  const esbuildOptions = {extensions: ['.js', '.mjs', '.ts']}
-
-  const {unregister} = globalThis.__DEV__ ? {unregister: () => undefined} : register(esbuildOptions)
-
-  const mod = require(configFile)
-
-  unregister()
-
-  return mod?.default || mod || undefined
-}

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

@@ -1,15 +0,0 @@
-import type {PkgConfigProperty, PkgConfigPropertyResolver} from './types'
-
-/** @internal */
-export function resolveConfigProperty<T>(
-  prop: PkgConfigProperty<T> | undefined,
-  initialValue: T,
-): T {
-  if (!prop) return initialValue
-
-  if (typeof prop === 'function') {
-    return (prop as PkgConfigPropertyResolver<T>)(initialValue)
-  }
-
-  return prop
-}