@sanity/pkg-utils 1.2.0 → 1.4.0

package/src/build/_parseTasks.ts

@@ -1,87 +0,0 @@
-import path from 'path'
-import {PackageSubPathExportEntry, _DEFAULTS} from '../core'
-import {_BuildContext} from './_types'
-import {_BuildTask, _DtsTask, _RollupTask} from './tasks'
-
-/**
- * @internal
- */
-export function _parseTasks(ctx: _BuildContext): _BuildTask[] {
-  const {config, pkg} = ctx
-
-  const entries = Object.entries(ctx.exports || {}).map(
-    ([path, entry]) => ({path, ...entry} as PackageSubPathExportEntry & {path: string})
-  )
-
-  const dtsTasks: Record<string, _DtsTask> = {}
-  const rollupTasks: Record<string, _RollupTask> = {}
-
-  // Parse `dts` tasks
-  for (const entry of entries) {
-    const exportId = path.join(pkg.name, entry.path)
-
-    if (entry.types) {
-      if (!dtsTasks[exportId]) {
-        dtsTasks[exportId] = {
-          type: 'dts',
-          exportId,
-          exportPath: entry.path === '.' ? './index' : entry.path,
-          source: entry.source,
-          output: entry.types,
-        }
-      }
-    }
-  }
-
-  // Parse `rollup` tasks
-  for (const entry of entries) {
-    const runtime = entry.runtime || config?.runtime || 'web'
-
-    const format: ('commonjs' | 'esm')[] = []
-    const target: string[] = []
-
-    if (entry.require) {
-      format.push('commonjs')
-    }
-
-    if (entry.default) {
-      format.push('esm')
-    }
-
-    if (runtime === 'node') {
-      target.push(...(config?.target?.node || _DEFAULTS.target.node))
-    }
-
-    if (runtime === 'web') {
-      target.push(...(config?.target?.web || _DEFAULTS.target.web))
-    }
-
-    for (const f of format) {
-      const buildId = `${runtime}:${f}:${target.join(',')}`
-
-      if (!rollupTasks[buildId]) {
-        rollupTasks[buildId] = {
-          type: 'rollup',
-          buildId,
-          entries: [entry],
-          runtime,
-          format: f,
-          target,
-        }
-      } else {
-        rollupTasks[buildId].entries.push(entry)
-      }
-    }
-  }
-
-  const tasks: _BuildTask[] = [...Object.values(dtsTasks), ...Object.values(rollupTasks)]
-
-  if (ctx.extract && pkg.types) {
-    tasks.push({
-      type: 'extract',
-      mainEntryPointPath: pkg.types,
-    })
-  }
-
-  return tasks
-}

package/src/build/_types.ts

@@ -1,25 +0,0 @@
-import {PackageExports, PkgConfigOptions, _PackageJSON} from '../core'
-
-/**
- * @internal
- */
-export interface _BuildFile {
-  type: 'asset' | 'chunk' | 'types'
-  path: string
-}
-
-/**
- * @internal
- */
-export interface _BuildContext {
-  config?: PkgConfigOptions
-  cwd: string
-  exports: PackageExports | undefined
-  external: string[]
-  extract: boolean
-  files: _BuildFile[]
-  dist: string
-  pkg: _PackageJSON
-  src: string
-  tsconfig?: string
-}

package/src/build/build.ts

@@ -1,82 +0,0 @@
-/* eslint-disable no-console */
-
-import path from 'path'
-import chalk from 'chalk'
-import {PackageExports, _loadConfig, _loadPkg, _parseExports, _resolveConfigProperty} from '../core'
-import {_parseTasks} from './_parseTasks'
-import {_BuildContext} from './_types'
-import {_dtsTask, _extractTask, _rollupTask} from './tasks'
-
-/**
- * @public
- */
-export async function build(options: {
-  cwd: string
-  extract?: boolean
-  tsconfig?: string
-}): Promise<void> {
-  const {cwd, extract = false, tsconfig = 'tsconfig.json'} = options
-  const pkg = await _loadPkg({cwd})
-  const config = await _loadConfig({cwd})
-
-  const parsedExports = _parseExports(pkg).reduce<PackageExports>((acc, x) => {
-    const {path: exportPath, ...exportEntry} = x
-
-    return {...acc, [exportPath]: exportEntry}
-  }, {})
-
-  const exports = config?.exports
-    ? _resolveConfigProperty(config.exports, parsedExports)
-    : parsedExports
-
-  const initialExternal = [
-    ...(pkg.dependencies ? Object.keys(pkg.dependencies) : []),
-    ...(pkg.peerDependencies ? Object.keys(pkg.peerDependencies) : []),
-  ]
-
-  const external = config?.external
-    ? _resolveConfigProperty(config.external, initialExternal)
-    : initialExternal
-
-  const srcPath = path.resolve(cwd, config?.src || 'src')
-  const distPath = path.resolve(cwd, config?.dist || 'dist')
-
-  const context: _BuildContext = {
-    config,
-    cwd,
-    exports,
-    extract,
-    files: [],
-    external,
-    dist: path.relative(cwd, distPath),
-    pkg,
-    src: path.relative(cwd, srcPath),
-    tsconfig,
-  }
-
-  console.log(chalk.gray('cwd       '), context.cwd)
-  // console.log('external ', context.external)
-  console.log(chalk.gray('src       '), context.src)
-  console.log(chalk.gray('dist      '), context.dist)
-  console.log(chalk.gray('tsconfig  '), context.tsconfig)
-
-  if (exports) {
-    const buildTasks = _parseTasks(context)
-
-    for (const task of buildTasks) {
-      if (task.type === 'dts') {
-        await _dtsTask(context, task)
-      }
-
-      if (task.type === 'extract') {
-        await _extractTask(context, task)
-      }
-
-      if (task.type === 'rollup') {
-        await _rollupTask(context, task)
-      }
-    }
-  } else {
-    throw new Error('no exports')
-  }
-}

package/src/build/index.ts

@@ -1,2 +0,0 @@
-export * from './_types'
-export * from './build'

package/src/build/tasks/_types.ts

@@ -1,8 +0,0 @@
-import {_DtsTask} from './dts'
-import {_ExtractTask} from './extract'
-import {_RollupTask} from './rollup'
-
-/**
- * @internal
- */
-export type _BuildTask = _DtsTask | _ExtractTask | _RollupTask

package/src/build/tasks/dts/_createApiExtractorConfig.ts

@@ -1,88 +0,0 @@
-import path from 'path'
-import {ExtractorLogLevel, IConfigFile, IExtractorMessagesConfig} from '@microsoft/api-extractor'
-
-export const DEFAULT_MESSAGES_CONFIG: IExtractorMessagesConfig = {
-  compilerMessageReporting: {
-    default: {
-      logLevel: 'warning' as ExtractorLogLevel,
-    },
-  },
-
-  extractorMessageReporting: {
-    default: {
-      logLevel: 'warning' as ExtractorLogLevel,
-      addToApiReportFile: false,
-    },
-
-    // 'ae-extra-release-tag': {
-    //   logLevel: 'error' as ExtractorLogLevel,
-    //   addToApiReportFile: false
-    // },
-
-    // 'ae-forgotten-export': {
-    //   logLevel: 'error' as ExtractorLogLevel,
-    //   addToApiReportFile: false
-    // }
-  },
-
-  tsdocMessageReporting: {
-    default: {
-      logLevel: 'warning' as ExtractorLogLevel,
-      addToApiReportFile: false,
-    },
-
-    // 'tsdoc-link-tag-unescaped-text': {
-    //   logLevel: 'warning' as ExtractorLogLevel,
-    //   addToApiReportFile: false
-    // },
-
-    // 'tsdoc-unsupported-tag': {
-    //   logLevel: 'none' as ExtractorLogLevel,
-    //   addToApiReportFile: false
-    // },
-
-    // 'tsdoc-undefined-tag': {
-    //   logLevel: 'none' as ExtractorLogLevel,
-    //   addToApiReportFile: false
-    // }
-  },
-}
-
-export function _createApiExtractorConfig(options: {
-  exportPath: string
-  projectPath: string
-  sourcePath: string
-  tsconfigPath: string
-  distPath: string
-}): IConfigFile {
-  const {exportPath, projectPath, sourcePath, tsconfigPath, distPath} = options
-
-  return {
-    apiReport: {
-      enabled: false,
-      reportFileName: '<unscopedPackageName>.api.md',
-      // reportFileName: path.resolve(distPath, `${exportPath}.api.md`)
-    },
-    // bundledPackages: [],
-    compiler: {
-      tsconfigFilePath: tsconfigPath,
-    },
-    docModel: {
-      enabled: false,
-      // apiJsonFilePath: '<unscopedPackageName>.api.json'
-      apiJsonFilePath: path.resolve(distPath, `${exportPath}.api.json`),
-    },
-    dtsRollup: {
-      enabled: true,
-      untrimmedFilePath: path.resolve(distPath, `${exportPath}.d.ts`),
-      // betaTrimmedFilePath: path.resolve(distPath, `${exportPath}-beta.d.ts`),
-      // publicTrimmedFilePath: path.resolve(distPath, `${exportPath}-public.d.ts`)
-    },
-    tsdocMetadata: {
-      enabled: false,
-    },
-    messages: DEFAULT_MESSAGES_CONFIG,
-    mainEntryPointFilePath: sourcePath,
-    projectFolder: projectPath,
-  }
-}

package/src/build/tasks/dts/_extractTypes.ts

@@ -1,100 +0,0 @@
-import path from 'path'
-import {
-  Extractor,
-  ExtractorConfig,
-  ExtractorMessage,
-  ExtractorResult,
-} from '@microsoft/api-extractor'
-import chalk from 'chalk'
-import {_BuildFile} from '../../_types'
-import {_createApiExtractorConfig} from './_createApiExtractorConfig'
-import {_createTSDocConfig} from './_createTSDocConfig'
-
-export async function _extractTypes(options: {
-  cwd: string
-  distPath: string
-  exportPath: string
-  files: _BuildFile[]
-  projectPath: string
-  quiet?: boolean
-  sourcePath: string
-  tsconfigPath: string
-}): Promise<{extractorResult: ExtractorResult; messages: ExtractorMessage[]}> {
-  const {cwd, distPath, exportPath, files, projectPath, quiet, sourcePath, tsconfigPath} = options
-
-  const tsdocConfigFile = await _createTSDocConfig({
-    customTags: [],
-  })
-
-  const extractorConfig: ExtractorConfig = ExtractorConfig.prepare({
-    configObject: _createApiExtractorConfig({
-      exportPath,
-      projectPath,
-      sourcePath,
-      distPath,
-      tsconfigPath,
-    }),
-    configObjectFullPath: undefined,
-    tsdocConfigFile,
-    packageJsonFullPath: path.resolve(projectPath, 'package.json'),
-  })
-
-  const messages: ExtractorMessage[] = []
-
-  // Invoke API Extractor
-  const extractorResult = Extractor.invoke(extractorConfig, {
-    // Equivalent to the "--local" command-line parameter
-    localBuild: true,
-    // Equivalent to the "--verbose" command-line parameter
-    showVerboseMessages: true,
-    // handle messages
-    messageCallback(message: ExtractorMessage) {
-      messages.push(message)
-      message.handled = true
-    },
-  })
-
-  if (!quiet) {
-    const warnings: ExtractorMessage[] = messages.filter((msg) => msg.logLevel === 'warning')
-
-    for (const msg of warnings) {
-      const sourceFilePath = msg.sourceFilePath && path.relative(cwd, msg.sourceFilePath)
-
-      // eslint-disable-next-line no-console
-      console.log(
-        [
-          `${chalk.cyan(sourceFilePath || '?')}`,
-          `:${chalk.yellow(msg.sourceFileLine)}:${chalk.yellow(msg.sourceFileColumn)}`,
-          ` - ${chalk.yellow('warning')} ${chalk.gray(msg.messageId)}\n`,
-          msg.text,
-          '\n',
-        ].join('')
-      )
-    }
-  }
-
-  const errors: ExtractorMessage[] = messages.filter((msg) => msg.logLevel === 'error')
-
-  for (const msg of errors) {
-    const sourceFilePath = msg.sourceFilePath && path.relative(cwd, msg.sourceFilePath)
-
-    // eslint-disable-next-line no-console
-    console.log(
-      [
-        `${chalk.cyan(sourceFilePath || '?')}`,
-        `:${chalk.yellow(msg.sourceFileLine)}:${chalk.yellow(msg.sourceFileColumn)}`,
-        ` - ${chalk.red('error')} ${chalk.gray(msg.messageId)}\n`,
-        msg.text,
-        '\n',
-      ].join('')
-    )
-  }
-
-  // Add to `files` in context
-  files.push({
-    type: 'types',
-    path: path.resolve(distPath, `${exportPath}.d.ts`),
-  })
-
-  return {extractorResult, messages}
-}

package/src/build/tasks/dts/dts.ts

@@ -1,59 +0,0 @@
-/* eslint-disable no-console */
-
-import path from 'path'
-import {promisify} from 'util'
-import chalk from 'chalk'
-import rimrafCallback from 'rimraf'
-import {_BuildContext} from '../../_types'
-import {_buildTypes} from './_buildTypes'
-import {_extractTypes} from './_extractTypes'
-
-const rimraf = promisify(rimrafCallback)
-
-/**
- * @internal
- */
-export interface _DtsTask {
-  type: 'dts'
-  exportId: string
-  exportPath: string
-  source: string
-  output: string
-}
-
-/**
- * @internal
- */
-export async function _dtsTask(ctx: _BuildContext, task: _DtsTask): Promise<void> {
-  const {cwd, dist, files, tsconfig} = ctx
-  const exportPath = task.exportPath === '.' ? './index' : task.exportPath
-  const distPath = path.resolve(cwd, dist)
-  const tmpPath = path.resolve(cwd, dist, 'tmp')
-  const tsconfigPath = path.resolve(cwd, tsconfig || 'tsconfig.json')
-
-  console.log('=================================================================================')
-  console.log(chalk.gray('task      '), 'd.ts')
-  console.log(chalk.gray('source    '), path.join('', task.source))
-  console.log(chalk.gray('export    '), path.join(dist, `${exportPath}.d.ts`))
-  console.log(chalk.gray('tsconfig  '), path.relative(cwd, tsconfigPath))
-
-  const types = await _buildTypes({
-    cwd,
-    outDir: tmpPath,
-    sourcePath: task.source,
-    tsconfigPath,
-  })
-
-  await _extractTypes({
-    cwd,
-    exportPath,
-    files,
-    projectPath: cwd,
-    sourcePath: types.path,
-    tsconfigPath,
-    distPath,
-  })
-
-  // Delete tmp directory
-  await rimraf(tmpPath)
-}

package/src/build/tasks/dts/index.ts

@@ -1 +0,0 @@
-export * from './dts'

package/src/build/tasks/extract/_extractTask.ts

@@ -1,49 +0,0 @@
-/* eslint-disable no-console */
-
-import fs from 'fs/promises'
-import path from 'path'
-import {extract, transform} from '@sanity/tsdoc-to-portable-text'
-import chalk from 'chalk'
-import mkdirp from 'mkdirp'
-import {_BuildContext} from '../../_types'
-
-/**
- * @internal
- */
-export interface _ExtractTask {
-  type: 'extract'
-  mainEntryPointPath: string
-}
-
-export async function _extractTask(ctx: _BuildContext, task: _ExtractTask): Promise<void> {
-  const {mainEntryPointPath} = task
-
-  console.log('=================================================================================')
-  console.log(chalk.gray('task      '), 'extract')
-  console.log(
-    chalk.gray('source    '),
-    path.relative(ctx.cwd, path.resolve(ctx.cwd, mainEntryPointPath))
-  )
-
-  const extracted = await extract(ctx.cwd, {
-    tsconfigPath: path.resolve(ctx.cwd, ctx.tsconfig || 'tsconfig.json'),
-  })
-
-  const transformed = transform(extracted, {
-    package: {
-      version: ctx.pkg.version,
-    },
-  })
-
-  const apiJsonDirPath = path.resolve(ctx.cwd, 'etc/api', ctx.pkg.name)
-
-  await mkdirp(apiJsonDirPath)
-
-  const jsonPath = path.resolve(apiJsonDirPath, `${ctx.pkg.version}.json`)
-
-  if (transformed.length) {
-    await fs.writeFile(jsonPath, JSON.stringify(transformed, null, 2) + '\n')
-
-    console.log(chalk.gray('result    '), path.relative(ctx.cwd, jsonPath))
-  }
-}

package/src/build/tasks/extract/index.ts

@@ -1 +0,0 @@
-export * from './_extractTask'

package/src/build/tasks/index.ts

@@ -1,4 +0,0 @@
-export * from './_types'
-export * from './dts'
-export * from './extract'
-export * from './rollup'

package/src/build/tasks/rollup/_resolveRollupConfig.ts

@@ -1,95 +0,0 @@
-import commonjs from '@rollup/plugin-commonjs'
-import json from '@rollup/plugin-json'
-import {nodeResolve} from '@rollup/plugin-node-resolve'
-import {InputOptions, OutputOptions} from 'rollup'
-import esbuild from 'rollup-plugin-esbuild'
-import {_BuildContext} from '../../_types'
-import {_RollupTask} from './rollup'
-
-/**
- * @internal
- */
-export function _resolveRollupConfig(
-  ctx: _BuildContext,
-  buildTask: _RollupTask
-): {
-  inputOptions: InputOptions
-  outputOptions: OutputOptions
-} {
-  const {format, runtime, target} = buildTask
-  const {cwd, external, dist: outDir, pkg, tsconfig} = ctx
-  const outputExt = format === 'commonjs' ? '.cjs' : pkg.type === 'module' ? '.mjs' : '.js'
-
-  return {
-    inputOptions: {
-      context: cwd,
-
-      external,
-
-      input: buildTask.entries.reduce<{[entryAlias: string]: string}>((acc, entry) => {
-        const key = entry.path === '.' ? 'index' : entry.path.slice(2)
-
-        return {...acc, [key]: entry.source || ''}
-      }, {}),
-
-      plugins: [
-        nodeResolve({
-          mainFields: ['module', 'jsnext', 'main'],
-          browser: runtime !== 'node',
-          exportConditions: [runtime === 'node' ? 'node' : 'browser'],
-          extensions: ['.cjs', '.mjs', '.js', '.jsx', '.json', '.node'],
-          preferBuiltins: runtime === 'node',
-        }),
-        commonjs({
-          esmExternals: false,
-          include: /\/node_modules\//,
-          // requireReturnsDefault: 'namespace',
-        }),
-        json(),
-        esbuild({
-          // include: /\.[jt]sx?$/, // default, inferred from `loaders` option
-          // exclude: /node_modules/, // default
-          // sourceMap: false, // by default inferred from rollup's `output.sourcemap` option
-          minify: false, // process.env.NODE_ENV === 'production',
-          // target: 'es2017', // default, or 'es20XX', 'esnext'
-          jsx: 'transform', // default, or 'preserve'
-          jsxFactory: 'React.createElement',
-          jsxFragment: 'React.Fragment',
-          // // Like @rollup/plugin-replace
-          // define: {
-          //   __VERSION__: '"x.y.z"',
-          // },
-          // plugins: [],
-          target,
-          // target:
-          //   target === 'node'
-          //     ? ['node12']
-          //     : ['es2020', 'chrome104', 'edge104', 'firefox103', 'safari15'],
-          tsconfig: tsconfig || 'tsconfig.json', // 'tsconfig.json', // default
-          // Add extra loaders
-          loaders: {
-            // Add .json files support
-            // require @rollup/plugin-commonjs
-            '.json': 'json',
-            // Enable JSX in .js files too
-            // '.js': 'jsx',
-          },
-        }),
-      ],
-
-      treeshake: {
-        propertyReadSideEffects: false,
-      },
-    },
-    outputOptions: {
-      chunkFileNames: () => `_[name]-[hash]${outputExt}`,
-      dir: outDir,
-      entryFileNames: () => `[name]${outputExt}`,
-      format,
-      esModule: false,
-      exports: 'auto',
-      freeze: false,
-      sourcemap: true,
-    },
-  }
-}

package/src/build/tasks/rollup/index.ts

@@ -1 +0,0 @@
-export * from './rollup'