@sanity/pkg-utils 5.1.11 → 6.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/pkg-utils",
-  "version": "5.1.11",
+  "version": "6.0.0",
   "description": "Simple utilities for modern npm packages.",
   "keywords": [
     "sanity-io",
@@ -63,6 +63,7 @@
     "@babel/types": "^7.24.0",
     "@microsoft/api-extractor": "7.43.0",
     "@microsoft/tsdoc-config": "^0.16.2",
+    "@optimize-lodash/rollup-plugin": "4.0.4",
     "@rollup/plugin-alias": "^5.1.0",
     "@rollup/plugin-babel": "^6.0.4",
     "@rollup/plugin-commonjs": "^25.0.7",
@@ -91,7 +92,7 @@
     "pretty-bytes": "^5.6.0",
     "prompts": "^2.4.2",
     "rimraf": "^4.4.1",
-    "rollup": "^4.14.0",
+    "rollup": "^4.14.1",
     "rollup-plugin-esbuild": "^6.1.1",
     "rxjs": "^7.8.1",
     "treeify": "^1.1.0",
@@ -111,8 +112,8 @@
     "@types/rimraf": "^3.0.2",
     "@types/treeify": "^1.0.3",
     "@types/uuid": "^9.0.8",
-    "@typescript-eslint/eslint-plugin": "^7.5.0",
-    "@typescript-eslint/parser": "^7.5.0",
+    "@typescript-eslint/eslint-plugin": "^7.6.0",
+    "@typescript-eslint/parser": "^7.6.0",
     "browserslist-to-esbuild": "2.1.1",
     "commitizen": "^4.3.0",
     "cpx": "^1.5.0",
@@ -132,14 +133,14 @@
     "typescript": "5.4.2",
     "vitest": "^1.4.0",
     "vitest-github-actions-reporter": "^0.11.1",
-    "@sanity/pkg-utils": "5.1.11"
+    "@sanity/pkg-utils": "6.0.0"
   },
   "peerDependencies": {
     "typescript": "5.4.2"
   },
   "packageManager": "pnpm@8.15.6",
   "engines": {
-    "node": ">=16.0.0"
+    "node": ">=18.17.0"
   },
   "publishConfig": {
     "access": "public"

package/src/node/check.ts

@@ -1,5 +1,6 @@
+import path from 'node:path'
+
 import esbuild, {type BuildFailure} from 'esbuild'
-import path from 'path'
 
 import {createConsoleSpy} from './consoleSpy'
 import {loadConfig, loadPkgWithReporting} from './core'

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

@@ -1,5 +1,6 @@
+import path from 'node:path'
+
 import findConfig from 'find-config'
-import path from 'path'
 
 import {fileExists} from '../../fileExists'
 

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

@@ -1,9 +1,10 @@
+import path from 'node: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'
+import type {PkgConfigOptions} from './types'
 
 /** @internal */
 export async function loadConfig(options: {cwd: string}): Promise<PkgConfigOptions | undefined> {

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

@@ -1,4 +1,4 @@
-import {PkgConfigProperty, PkgConfigPropertyResolver} from './types'
+import type {PkgConfigProperty, PkgConfigPropertyResolver} from './types'
 
 /** @internal */
 export function resolveConfigProperty<T>(

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

@@ -1,4 +1,5 @@
 import type {PluginItem as BabelPluginItem} from '@babel/core'
+import type {OptimizeLodashOptions} from '@optimize-lodash/rollup-plugin'
 import type {NormalizedOutputOptions, Plugin as RollupPlugin, TreeshakingOptions} from 'rollup'
 
 // re-export
@@ -137,6 +138,14 @@ export interface PkgConfigOptions {
      * @defaultValue false
      */
     hashChunkFileNames?: boolean
+    /**
+     * Optimizes lodash imports using `@optimize-lodash/rollup-plugin` when set to `true`.
+     * It's enabled if `lodash` is found in `dependencies` or `peerDependencies`.
+     * It will use `lodash-es` for ESM targets if found in `dependencies` or `peerDependencies`.
+     * @defaultValue true
+     * @alpha
+     */
+    optimizeLodash?: boolean | OptimizeLodashOptions
   }
   /**
    * Default runtime of package exports

package/src/node/core/findCommonPath.ts

@@ -1,4 +1,4 @@
-import path from 'path'
+import path from 'node:path'
 
 export function pathContains(containerPath: string, itemPath: string): boolean {
   return !path.relative(containerPath, itemPath).startsWith('..')

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

@@ -1,7 +1,8 @@
-import fs from 'fs/promises'
+import fs from 'node:fs/promises'
+
 import pkgUp from 'pkg-up'
 
-import {PackageJSON} from './types'
+import type {PackageJSON} from './types'
 import {validatePkg} from './validatePkg'
 
 /** @internal */

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

@@ -1,6 +1,6 @@
 import {z} from 'zod'
 
-import {PackageJSON} from './types'
+import type {PackageJSON} from './types'
 
 const pkgSchema = z.object({
   type: z.optional(z.enum(['commonjs', 'module'])),

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

@@ -1,10 +1,11 @@
-import {writeFile} from 'fs/promises'
+import {writeFile} from 'node:fs/promises'
+import {dirname, relative, resolve} from 'node:path'
+
 import {mkdirp} from 'mkdirp'
-import {dirname, relative, resolve} from 'path'
 import prompts from 'prompts'
 
-import {Logger} from '../../logger'
-import {PkgTemplate} from './types'
+import type {Logger} from '../../logger'
+import type {PkgTemplate} from './types'
 
 const promptsTypes = {
   string: 'text' as const,

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

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

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

@@ -1,4 +1,4 @@
-import {Logger} from '../../logger'
+import type {Logger} from '../../logger'
 
 /** @public */
 export interface PkgTemplateFile {

package/src/node/fileExists.ts

@@ -1,4 +1,4 @@
-import {statSync} from 'fs'
+import {statSync} from 'node:fs'
 
 /** @internal */
 export function fileExists(filePath: string): boolean {

package/src/node/getFilesize.ts

@@ -1,4 +1,5 @@
-import {statSync} from 'fs'
+import {statSync} from 'node:fs'
+
 import prettyBytes from 'pretty-bytes'
 
 export function getFilesize(file: string): string {

package/src/node/globFiles.ts

@@ -1,5 +1,6 @@
+import path from 'node: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/init.ts

@@ -1,6 +1,7 @@
-import {lstat} from 'fs/promises'
+import {lstat} from 'node:fs/promises'
+import {resolve} from 'node:path'
+
 import {mkdirp} from 'mkdirp'
-import {resolve} from 'path'
 
 import {createFromTemplate} from './core/template'
 import {fileExists} from './fileExists'

package/src/node/isEmptyDirectory.ts

@@ -1,4 +1,4 @@
-import {readdir} from 'fs/promises'
+import {readdir} from 'node:fs/promises'
 
 export async function isEmptyDirectory(dirPath: string): Promise<boolean> {
   return (await readdir(dirPath)).length === 0

package/src/node/printExtractMessages.ts

@@ -1,6 +1,7 @@
+import path from 'node:path'
+
 import type {ExtractorMessage} from '@microsoft/api-extractor'
 import chalk from 'chalk'
-import path from 'path'
 
 import type {BuildContext} from './core'
 

package/src/node/printPackageTree.ts

@@ -1,8 +1,9 @@
+import path from 'node:path'
+
 import chalk from 'chalk'
-import path from 'path'
 import treeify from 'treeify'
 
-import {BuildContext, PkgExport} from './core'
+import type {BuildContext, PkgExport} from './core'
 import {fileExists} from './fileExists'
 import {getFilesize} from './getFilesize'
 

package/src/node/resolveBuildContext.ts

@@ -1,5 +1,6 @@
+import path from 'node:path'
+
 import browserslistToEsbuild from 'browserslist-to-esbuild'
-import path from 'path'
 
 import {
   type BuildContext,

package/src/node/resolveBuildTasks.ts

@@ -1,5 +1,5 @@
-import fs from 'fs'
-import path from 'path'
+import fs from 'node:fs'
+import path from 'node:path'
 
 import type {BuildContext, PkgExport, PkgFormat, PkgRuntime} from './core'
 import type {BuildTask, DtsTask, RollupLegacyTask, RollupTask, RollupTaskEntry} from './tasks'

package/src/node/resolveWatchTasks.ts

@@ -1,5 +1,5 @@
-import fs from 'fs'
-import path from 'path'
+import fs from 'node:fs'
+import path from 'node:path'
 
 import type {BuildContext, PkgExport, PkgFormat, PkgRuntime} from './core'
 import type {DtsWatchTask, RollupTaskEntry, RollupWatchTask, WatchTask} from './tasks'

package/src/node/spinner.ts

@@ -12,7 +12,7 @@ export function createSpinner(msg: string): {complete: () => void; error: () =>
       console.log(`${chalk.green('[success]')} ${chalk.gray(`${Date.now() - startTime}ms`)}`)
     },
     error: () => {
-      console.log(`${chalk.red(`[error]`)} ${chalk.gray(`${Date.now() - startTime}ms`)}`)
+      console.log(`${chalk.red('[error]')} ${chalk.gray(`${Date.now() - startTime}ms`)}`)
     },
   }
 }

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

@@ -1,4 +1,4 @@
-import {ExtractorMessage} from '@microsoft/api-extractor'
+import type {ExtractorMessage} from '@microsoft/api-extractor'
 
 /** @internal */
 export class DtsError extends Error {

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

@@ -1,5 +1,6 @@
+import path from 'node:path'
+
 import type {IConfigFile, IExtractorMessagesConfig} from '@microsoft/api-extractor'
-import path from 'path'
 import ts from 'typescript'
 
 export function createApiExtractorConfig(options: {

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

@@ -1,5 +1,6 @@
+import {readFile} from 'node: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,5 +1,6 @@
+import path from 'node:path'
+
 import type {ExtractorMessage} from '@microsoft/api-extractor'
-import path from 'path'
 import rimraf from 'rimraf'
 
 import type {BuildContext} from '../../core'

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

@@ -11,7 +11,7 @@ import type {DtsResult, DtsWatchTask} from './types'
 export const dtsWatchTask: TaskHandler<DtsWatchTask, DtsResult> = {
   name: (_ctx, task) =>
     [
-      `build type definitions`,
+      'build type definitions',
       ...task.entries.map((entry) => {
         return entry.targetPaths.map((targetPath) => {
           return [

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

@@ -1,12 +1,13 @@
+import fs from 'node:fs/promises'
+import path from 'node:path'
+
 import {
   Extractor,
   ExtractorConfig,
   type ExtractorMessage,
   type ExtractorResult,
 } from '@microsoft/api-extractor'
-import fs from 'fs/promises'
 import {mkdirp} from 'mkdirp'
-import path from 'path'
 import prettier from 'prettier'
 import type ts from 'typescript'
 

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

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

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

@@ -1,8 +1,9 @@
+import path from 'node:path'
+
 import chalk from 'chalk'
-import path from 'path'
 import ts from 'typescript'
 
-import {Logger} from '../../logger'
+import type {Logger} from '../../logger'
 
 export function printDiagnostic(options: {
   cwd: string

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

@@ -1,3 +1,6 @@
+import path from 'node:path'
+
+import {optimizeLodashImports} from '@optimize-lodash/rollup-plugin'
 import alias from '@rollup/plugin-alias'
 import {getBabelOutputPlugin} from '@rollup/plugin-babel'
 import commonjs from '@rollup/plugin-commonjs'
@@ -5,12 +8,11 @@ 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 type {InputOptions, OutputOptions, Plugin} from 'rollup'
 import esbuild from 'rollup-plugin-esbuild'
 
 import {pkgExtMap as extMap} from '../../../node/core/pkg/pkgExt'
-import {type BuildContext, resolveConfigProperty} from '../../core'
+import {type BuildContext, type PackageJSON, resolveConfigProperty} from '../../core'
 import type {RollupLegacyTask, RollupTask, RollupWatchTask} from '../types'
 
 export interface RollupConfig {
@@ -52,6 +54,8 @@ export function resolveRollupConfig(
     Object.entries(config?.define || {}).map(([key, val]) => [key, JSON.stringify(val)]),
   )
 
+  const {optimizeLodash: enableOptimizeLodash = hasDependency(pkg, 'lodash')} = config?.rollup || {}
+
   const defaultPlugins = [
     replace({
       preventAssignment: true,
@@ -90,6 +94,13 @@ export function resolveRollupConfig(
       preferBuiltins: true,
     }),
     commonjs(),
+    enableOptimizeLodash &&
+      optimizeLodashImports({
+        useLodashEs: format === 'esm' && hasDependency(pkg, 'lodash-es') ? true : undefined,
+        ...(typeof config?.rollup?.optimizeLodash === 'boolean'
+          ? {}
+          : config?.rollup?.optimizeLodash),
+      }),
     json(),
     esbuild({
       jsx: config?.jsx ?? 'automatic',
@@ -215,3 +226,11 @@ export function resolveRollupConfig(
     },
   }
 }
+
+function hasDependency(pkg: PackageJSON, packageName: string): boolean {
+  return pkg.dependencies
+    ? packageName in pkg.dependencies
+    : pkg.peerDependencies
+      ? packageName in pkg.peerDependencies
+      : false
+}

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

@@ -1,5 +1,6 @@
+import path from 'node:path'
+
 import chalk from 'chalk'
-import path from 'path'
 import {rollup} from 'rollup'
 import {Observable} from 'rxjs'
 

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

@@ -1,5 +1,6 @@
+import path from 'node:path'
+
 import chalk from 'chalk'
-import path from 'path'
 import {rollup} from 'rollup'
 import {Observable} from 'rxjs'
 

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

@@ -1,9 +1,10 @@
+import path from 'node:path'
+
 import chalk from 'chalk'
-import path from 'path'
-import {RollupWatcherEvent, RollupWatchOptions, watch as rollupWatch} from 'rollup'
+import {type RollupWatcherEvent, type RollupWatchOptions, watch as rollupWatch} from 'rollup'
 import {Observable} from 'rxjs'
 
-import {RollupWatchTask, TaskHandler} from '../types'
+import type {RollupWatchTask, TaskHandler} from '../types'
 import {resolveRollupConfig} from './resolveRollupConfig'
 
 /** @internal */

package/src/node/templates/default/template.ts

@@ -1,11 +1,18 @@
+import {resolve} from 'node:path'
+
 import getLatestVersion from 'get-latest-version'
 import gitUrlParse from 'git-url-parse'
 import {outdent} from 'outdent'
 import parseGitConfig from 'parse-git-config'
-import {resolve} from 'path'
-import prettier, {Config as PrettierConfig} from 'prettier'
-
-import {defineTemplateOption, isRecord, PackageJSON, PkgTemplate, PkgTemplateFile} from '../../core'
+import prettier, {type Config as PrettierConfig} from 'prettier'
+
+import {
+  defineTemplateOption,
+  isRecord,
+  type PackageJSON,
+  type PkgTemplate,
+  type PkgTemplateFile,
+} from '../../core'
 
 const RE_NAME = /^(?:@(?:[a-z0-9-*~][a-z0-9-*._~]*)\/)?[a-z0-9-~][a-z0-9-._~]*$/i
 

package/src/node/watch.ts

@@ -1,4 +1,5 @@
-import path from 'path'
+import path from 'node:path'
+
 import {switchMap} from 'rxjs'
 
 import {loadConfig, loadPkgWithReporting} from './core'

package/src/node/watchConfigFiles.ts

@@ -1,9 +1,10 @@
-import path from 'path'
-import {Observable} from 'rxjs'
+import path from 'node:path'
+
+import type {Observable} from 'rxjs'
 import {distinctUntilChanged, scan, startWith} from 'rxjs/operators'
 
 import {globFiles} from './globFiles'
-import {Logger} from './logger'
+import type {Logger} from './logger'
 import {watchFiles} from './watchFiles'
 
 export async function watchConfigFiles(options: {