@sanity/pkg-utils 6.4.1 → 6.6.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/pkg-utils",
-  "version": "6.4.1",
+  "version": "6.6.0",
   "description": "Simple utilities for modern npm packages.",
   "keywords": [
     "sanity-io",
@@ -88,7 +88,7 @@
     "parse-git-config": "^3.0.0",
     "pkg-up": "^3.1.0",
     "prettier": "^3.2.5",
-    "prettier-plugin-packagejson": "^2.4.14",
+    "prettier-plugin-packagejson": "^2.5.0",
     "pretty-bytes": "^5.6.0",
     "prompts": "^2.4.2",
     "rimraf": "^4.4.1",
@@ -97,7 +97,8 @@
     "rxjs": "^7.8.1",
     "treeify": "^1.1.0",
     "uuid": "^9.0.1",
-    "zod": "^3.22.4"
+    "zod": "3.22.4",
+    "zod-validation-error": "3.1.0"
   },
   "devDependencies": {
     "@commitlint/cli": "^19.2.1",
@@ -133,9 +134,9 @@
     "semver": "^7.6.0",
     "ts-node": "^10.9.2",
     "typescript": "5.4.5",
-    "vitest": "^1.4.0",
+    "vitest": "^1.5.0",
     "vitest-github-actions-reporter": "^0.11.1",
-    "@sanity/pkg-utils": "6.4.1"
+    "@sanity/pkg-utils": "6.6.0"
   },
   "peerDependencies": {
     "typescript": "5.4.x"

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

@@ -0,0 +1,154 @@
+// 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/core/config/types.ts

@@ -2,8 +2,10 @@ 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'
 
+import type {StrictOptions} from '../../strict'
+
 // re-export
-export type {RollupPlugin}
+export type {RollupPlugin, StrictOptions}
 
 /** @public */
 export type PkgFormat = 'commonjs' | 'esm'
@@ -157,4 +159,8 @@ export interface PkgConfigOptions {
    */
   src?: string
   tsconfig?: string
+  /**
+   * Configure what checks are made when running `--strict` builds and checks
+   */
+  strictOptions?: StrictOptions
 }

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

@@ -1,3 +1,5 @@
+import type {Logger} from '../../logger'
+import type {InferredStrictOptions} from '../../strict'
 import {defaultEnding, fileEnding, legacyEnding} from '../../tasks/dts/getTargetPaths'
 import type {PkgExport} from '../config'
 import {isRecord} from '../isRecord'
@@ -9,12 +11,33 @@ import {validateExports} from './validateExports'
 export function parseExports(options: {
   pkg: PackageJSON
   strict: boolean
+  strictOptions: InferredStrictOptions
   legacyExports: boolean
+  logger: Logger
 }): (PkgExport & {_path: string})[] {
-  const {pkg, strict, legacyExports} = options
+  const {pkg, strict, strictOptions, legacyExports, logger} = options
   const type = pkg.type || 'commonjs'
   const errors: string[] = []
 
+  const report = (kind: 'warn' | 'error', message: string) => {
+    if (kind === 'warn') {
+      logger.warn(message)
+    } else {
+      errors.push(message)
+    }
+  }
+
+  if (!pkg.main && strict && strictOptions.alwaysPackageJsonMain !== 'off') {
+    report(strictOptions.alwaysPackageJsonMain, 'package.json: `main` must be declared')
+  }
+
+  if (!Array.isArray(pkg.files) && strict && strictOptions.alwaysPackageJsonFiles !== 'off') {
+    report(
+      strictOptions.alwaysPackageJsonFiles,
+      'package.json: `files` should be used over `.npmignore`',
+    )
+  }
+
   if (pkg.source) {
     if (
       strict &&
@@ -113,44 +136,24 @@ export function parseExports(options: {
     )
   }
 
-  /*
-  const rootExports: PkgExport & {_path: string} = {
-    _exported: true,
-    _path: '.',
-    source: pkg.source || '',
-    browser: pkg.browser && {
-      source: pkg.source || '',
-      require: pkg.main && pkg.browser[pkg.main],
-      import: pkg.module && pkg.browser[pkg.module],
-    },
-    require: legacyExports
-      ? pkg.main
-      : typeof pkg.exports?.['.'] === 'object' && 'require' in pkg.exports['.']
-        ? pkg.exports['.'].require
-        : '',
-    import: legacyExports
-      ? pkg.module
-      : typeof pkg.exports?.['.'] === 'object' && 'import' in pkg.exports['.']
-        ? pkg.exports['.'].import
-        : '',
-    default: legacyExports
-      ? pkg.module || pkg.main || ''
-      : typeof pkg.exports?.['.'] === 'object' && 'default' in pkg.exports['.']
-        ? pkg.exports['.'].default || ''
-        : pkg.module || pkg.main || '',
-  }
-  // */
-
   const _exports: (PkgExport & {_path: string})[] = []
 
   // @TODO validate typesVersions when legacyExports is true
 
-  if (strict && 'typings' in pkg) {
-    errors.push('package.json: `typings` should be `types`')
+  if (strict && strictOptions.noPackageJsonTypings !== 'off' && 'typings' in pkg) {
+    report(strictOptions.noPackageJsonTypings, 'package.json: `typings` should be `types`')
   }
 
-  if (strict && !pkg.types && pkg.source?.endsWith('.ts')) {
-    errors.push(
+  if (
+    strict &&
+    strictOptions.alwaysPackageJsonTypes !== 'off' &&
+    !pkg.types &&
+    typeof pkg.exports?.['.'] === 'object' &&
+    'source' in pkg.exports['.'] &&
+    pkg.exports['.'].source?.endsWith('.ts')
+  ) {
+    report(
+      strictOptions.alwaysPackageJsonTypes,
       'package.json: `types` must be declared for the npm listing to show as a TypeScript module.',
     )
   }

package/src/node/index.ts

@@ -4,5 +4,6 @@ export * from './core'
 export * from './init'
 export * from './logger'
 export * from './resolveBuildTasks'
+export {type InferredStrictOptions, strictOptions, toggle, type ToggleType} from './strict'
 export * from './tasks'
 export * from './watch'

package/src/node/resolveBuildContext.ts

@@ -17,6 +17,7 @@ import {findCommonDirPath, pathContains} from './core/findCommonPath'
 import type {Logger} from './logger'
 import {resolveBrowserTarget} from './resolveBrowserTarget'
 import {resolveNodeTarget} from './resolveNodeTarget'
+import {parseStrictOptions} from './strict'
 
 export async function resolveBuildContext(options: {
   config?: PkgConfigOptions
@@ -37,24 +38,41 @@ export async function resolveBuildContext(options: {
     tsconfig: tsconfigPath,
   } = options
   const tsconfig = await loadTSConfig({cwd, tsconfigPath})
+  const strictOptions = parseStrictOptions(config?.strictOptions ?? {})
 
   /* eslint-disable padding-line-between-statements */
   let browserslist = pkg.browserslist
   if (!browserslist) {
-    if (strict) {
-      logger.warn(
-        'Could not detect a `browserslist` property in `package.json`, using default configuration. Add `"browserslist": "extends @sanity/browserslist-config"` to silence this warning.',
-      )
+    if (strict && strictOptions.noImplicitBrowsersList !== 'off') {
+      if (strictOptions.noImplicitBrowsersList === 'error') {
+        throw new Error(
+          '\n- ' +
+            `package.json: "browserslist" is missing, set it to \`"browserslist": "extends @sanity/browserslist-config"\``,
+        )
+      } else {
+        logger.warn(
+          'Could not detect a `browserslist` property in `package.json`, using default configuration. Add `"browserslist": "extends @sanity/browserslist-config"` to silence this warning.',
+        )
+      }
     }
     browserslist = DEFAULT_BROWSERSLIST_QUERY
   }
   const targetVersions = browserslistToEsbuild(browserslist)
   /* eslint-enable padding-line-between-statements */
 
-  if (strict && typeof pkg.sideEffects === 'undefined') {
-    logger.error(
-      'No `sideEffects` field in `package.json`, assuming all files are side-effectful. Add `"sideEffects": true` to silence this warning. See https://webpack.js.org/guides/tree-shaking/#clarifying-tree-shaking-and-sideeffects for how to define `sideEffects`.',
-    )
+  if (
+    strict &&
+    strictOptions.noImplicitSideEffects !== 'off' &&
+    typeof pkg.sideEffects === 'undefined'
+  ) {
+    const msg =
+      'package.json: `sideEffects` is missing, see https://webpack.js.org/guides/tree-shaking/#clarifying-tree-shaking-and-sideeffects for how to define `sideEffects`'
+
+    if (strictOptions.noImplicitSideEffects === 'error') {
+      throw new Error(msg)
+    } else {
+      logger.warn(msg)
+    }
   }
 
   const nodeTarget = resolveNodeTarget(targetVersions)
@@ -78,6 +96,8 @@ export async function resolveBuildContext(options: {
     pkg,
     strict,
     legacyExports: config?.legacyExports ?? false,
+    strictOptions,
+    logger,
   }).reduce<PkgExports>((acc, x) => {
     const {_path: exportPath, ...exportEntry} = x
 

package/src/node/strict.test-d.ts

@@ -0,0 +1,7 @@
+import {expectTypeOf, test} from 'vitest'
+
+import {InferredStrictOptions, StrictOptions} from './strict'
+
+test('the zod schema types matches the manual types', () => {
+  expectTypeOf<StrictOptions>().toEqualTypeOf<Partial<InferredStrictOptions>>()
+})

package/src/node/strict.ts

@@ -0,0 +1,84 @@
+import {z} from 'zod'
+import {errorMap} from 'zod-validation-error'
+
+/**
+ * @public
+ */
+export const toggle = z.union([z.literal('error'), z.literal('warn'), z.literal('off')])
+
+/**
+ * @public
+ */
+export type ToggleType = z.infer<typeof toggle>
+
+/**
+ * @public
+ */
+export const strictOptions = z
+  .object({
+    noPackageJsonTypings: toggle.default('error'),
+    noImplicitSideEffects: toggle.default('warn'),
+    noImplicitBrowsersList: toggle.default('warn'),
+    alwaysPackageJsonTypes: toggle.default('error'),
+    alwaysPackageJsonMain: toggle.default('error'),
+    alwaysPackageJsonFiles: toggle.default('error'),
+  })
+  .strict()
+
+/**
+ * To make error message paths line up with the paths in package.config.ts the schema is hoisted into a root schema
+ * This way errors will say `Expected boolean, received string at "strict.noPackageJsonTypings"` instead of `Expected boolean, received string at "noPackageJsonTypings"`.
+ */
+const validationSchema = z.object({
+  strictOptions: strictOptions.default({}),
+})
+
+/**
+ * @public
+ */
+export type InferredStrictOptions = z.infer<typeof strictOptions>
+
+/**
+ * @public
+ */
+export interface StrictOptions {
+  /**
+   * Disallows a top level `typings` field in `package.json` if it is equal to `exports['.'].source`.
+   * @defaultValue 'error'
+   */
+  noPackageJsonTypings?: ToggleType
+  /**
+   * Requires specifying `sideEffects` in `package.json`.
+   * @defaultValue 'warn'
+   */
+  noImplicitSideEffects?: ToggleType
+  /**
+   * Requires specifying `browserslist` in `package.json`, instead of relying on it implicitly being:
+   * @example
+   * ```
+   * "browserslist": "extends @sanity/browserslist-config"
+   * ```
+   * @defaultValue 'warn'
+   */
+  noImplicitBrowsersList?: ToggleType
+  /**
+   * If typescript is used then `types` in `package.json` should be specified for npm listings to show the TS icon.
+   * @defaultValue 'error'
+   */
+  alwaysPackageJsonTypes?: ToggleType
+  /**
+   * A lot of analysis tooling requiers the `main` field to work (like bundlephobia) and so it's best practice to always include it
+   * @defaultValue 'error'
+   */
+  alwaysPackageJsonMain?: ToggleType
+  /**
+   * Using `.npmignore` is error prone, it's best practice to always declare `files` instead
+   * @defaultValue 'error'
+   */
+  alwaysPackageJsonFiles?: ToggleType
+}
+
+/** @internal */
+export function parseStrictOptions(input: unknown): InferredStrictOptions {
+  return validationSchema.parse({strictOptions: input}, {errorMap}).strictOptions
+}