@sanity/pkg-utils 1.0.0 → 1.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/pkg-utils",
-  "version": "1.0.0",
+  "version": "1.2.0",
   "author": "Sanity.io <hello@sanity.io>",
   "license": "MIT",
   "description": "Simple utilities for modern npm packages.",
@@ -32,7 +32,7 @@
     "dist"
   ],
   "scripts": {
-    "build": "node -r esbuild-register src/cli.ts build --extract --tsconfig tsconfig.dist.json",
+    "build": "node -r esbuild-register src/cli build --extract --tsconfig tsconfig.dist.json",
     "format": "prettier --write --cache --ignore-unknown .",
     "lint": "eslint . --ext .cjs,.js,.ts",
     "prebuild": "rimraf dist",
@@ -52,6 +52,7 @@
     "chalk": "^4.1.2",
     "esbuild": "^0.15.5",
     "esbuild-register": "^3.3.3",
+    "find-config": "^1.0.0",
     "jsonc-parser": "^3.1.0",
     "mkdirp": "^1.0.4",
     "pkg-up": "^3.1.0",
@@ -64,6 +65,7 @@
     "@commitlint/config-conventional": "^17.0.3",
     "@sanity/semantic-release-preset": "^2.0.0",
     "@types/cpx": "^1.5.2",
+    "@types/find-config": "^1.0.1",
     "@types/mkdirp": "^1.0.2",
     "@types/node": "^18.7.13",
     "@types/rimraf": "^3.0.2",

package/src/build/_parseTasks.ts

@@ -1,13 +1,13 @@
 import path from 'path'
-import {PackageSubPathExportEntry} from '../core'
+import {PackageSubPathExportEntry, _DEFAULTS} from '../core'
 import {_BuildContext} from './_types'
-import {_RollupTask, _BuildTask, _DtsTask} from './tasks'
+import {_BuildTask, _DtsTask, _RollupTask} from './tasks'
 
 /**
  * @internal
  */
 export function _parseTasks(ctx: _BuildContext): _BuildTask[] {
-  const {pkg} = ctx
+  const {config, pkg} = ctx
 
   const entries = Object.entries(ctx.exports || {}).map(
     ([path, entry]) => ({path, ...entry} as PackageSubPathExportEntry & {path: string})
@@ -35,6 +35,8 @@ export function _parseTasks(ctx: _BuildContext): _BuildTask[] {
 
   // Parse `rollup` tasks
   for (const entry of entries) {
+    const runtime = entry.runtime || config?.runtime || 'web'
+
     const format: ('commonjs' | 'esm')[] = []
     const target: string[] = []
 
@@ -46,23 +48,23 @@ export function _parseTasks(ctx: _BuildContext): _BuildTask[] {
       format.push('esm')
     }
 
-    if (entry.runtime === 'node') {
-      target.push('node12')
+    if (runtime === 'node') {
+      target.push(...(config?.target?.node || _DEFAULTS.target.node))
     }
 
-    if (entry.runtime === 'web') {
-      target.push('chrome104')
+    if (runtime === 'web') {
+      target.push(...(config?.target?.web || _DEFAULTS.target.web))
     }
 
     for (const f of format) {
-      const buildId = `${entry.runtime}:${f}:${target.join(',')}`
+      const buildId = `${runtime}:${f}:${target.join(',')}`
 
       if (!rollupTasks[buildId]) {
         rollupTasks[buildId] = {
           type: 'rollup',
           buildId,
           entries: [entry],
-          runtime: entry.runtime,
+          runtime,
           format: f,
           target,
         }

package/src/build/build.ts

@@ -19,11 +19,6 @@ export async function build(options: {
   const pkg = await _loadPkg({cwd})
   const config = await _loadConfig({cwd})
 
-  // if (!config) {
-  //   console.log('no configuration found')
-  //   return
-  // }
-
   const parsedExports = _parseExports(pkg).reduce<PackageExports>((acc, x) => {
     const {path: exportPath, ...exportEntry} = x
 

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

@@ -25,6 +25,7 @@ export async function _buildTypes(options: {
 
   const compilerOptions: ts.CompilerOptions = {
     ...config.options,
+    declaration: true,
     emitDeclarationOnly: true,
     outDir,
   }

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

@@ -13,7 +13,6 @@ import {_createTSDocConfig} from './_createTSDocConfig'
 export async function _extractTypes(options: {
   cwd: string
   distPath: string
-  // exportId: string
   exportPath: string
   files: _BuildFile[]
   projectPath: string

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

@@ -27,16 +27,15 @@ export interface _DtsTask {
 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`))
-
-  const distPath = path.resolve(cwd, dist)
-  const tmpPath = path.resolve(cwd, dist, 'tmp')
-
-  const tsconfigPath = path.resolve(cwd, tsconfig || 'tsconfig.json')
+  console.log(chalk.gray('tsconfig  '), path.relative(cwd, tsconfigPath))
 
   const types = await _buildTypes({
     cwd,

package/src/core/_defaults.ts

@@ -0,0 +1,9 @@
+/**
+ * @internal
+ */
+export const _DEFAULTS = {
+  target: {
+    node: ['node12'],
+    web: ['chrome58', 'edge16', 'firefox54', 'opera44', 'safari11'],
+  },
+}

package/src/core/config/_loadConfig.ts

@@ -1,5 +1,6 @@
 import path from 'path'
 import {register} from 'esbuild-register/dist/node'
+import findConfig from 'find-config'
 import pkgUp from 'pkg-up'
 import {PkgConfigOptions} from './types'
 
@@ -15,16 +16,40 @@ export async function _loadConfig(options: {cwd: string}): Promise<PkgConfigOpti
 
   const root = path.dirname(pkgPath)
 
+  const configFile = _findConfigFile(root)
+
+  if (!configFile) {
+    return undefined
+  }
+
   try {
-    const {unregister} = register({extensions: ['.js', '.ts']})
+    const {unregister} = configFile.transform
+      ? register({extensions: ['.js', '.ts']})
+      : {unregister: () => undefined}
 
     // eslint-disable-next-line @typescript-eslint/no-var-requires
-    const mod = require(path.resolve(root, 'package.config.ts'))
+    const mod = require(configFile.path)
 
     unregister()
 
-    return mod.default
+    return mod?.default || mod || undefined
   } catch (_) {
     return undefined
   }
 }
+
+// Looks for:
+// 1. package.config.ts
+// 2. package.config.cjs
+//
+function _findConfigFile(cwd: string): {path: string; transform: boolean} | null {
+  const ts = findConfig('package.config.ts', {cwd})
+
+  if (ts) return {path: ts, transform: true}
+
+  const cjs = findConfig('package.config.cjs', {cwd})
+
+  if (cjs) return {path: cjs, transform: false}
+
+  return null
+}

package/src/core/config/types.ts

@@ -2,7 +2,7 @@
  * @public
  */
 export interface PackageSubPathExportEntry {
-  runtime: 'node' | 'web'
+  runtime?: 'node' | 'web'
 
   // paths
   source: string
@@ -41,8 +41,16 @@ export interface PkgConfigOptions {
    * Packages to exclude from the bundles.
    */
   external?: ConfigProperty<string[]>
+  /**
+   * Default runtime of package exports
+   */
+  runtime?: 'node' | 'web'
   /**
    * Directory of source files.
    */
   src?: string
+  target?: {
+    node?: string[]
+    web?: string[]
+  }
 }

package/src/core/index.ts

@@ -1,3 +1,4 @@
+export * from './_defaults'
 export * from './_isRecord'
 export * from './config'
 export * from './pkg'

package/src/core/pkg/_parseExports.ts

@@ -8,7 +8,7 @@ import {_PackageJSON} from './_types'
 export function _parseExports(pkg: _PackageJSON): (PackageSubPathExportEntry & {path: string})[] {
   const rootExport: PackageSubPathExportEntry & {path: string} = {
     path: '.',
-    runtime: 'web',
+    runtime: undefined,
 
     source: pkg.source || 'index.js',
     require: pkg.main,
@@ -26,7 +26,6 @@ export function _parseExports(pkg: _PackageJSON): (PackageSubPathExportEntry & {
         } else {
           extraExports.push({
             path: exportPath,
-            runtime: 'web',
             source: exportEntry.source,
             ...exportEntry,
           })