@sanity/pkg-utils 6.5.0 → 6.6.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/pkg-utils",
-  "version": "6.5.0",
+  "version": "6.6.0",
   "description": "Simple utilities for modern npm packages.",
   "keywords": [
     "sanity-io",
@@ -136,7 +136,7 @@
     "typescript": "5.4.5",
     "vitest": "^1.5.0",
     "vitest-github-actions-reporter": "^0.11.1",
-    "@sanity/pkg-utils": "6.5.0"
+    "@sanity/pkg-utils": "6.6.0"
   },
   "peerDependencies": {
     "typescript": "5.4.x"

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

@@ -2,6 +2,9 @@
 
 exports[`{'noPackageJsonTypings': 'error'}} 1`] = `
 {
+  "alwaysPackageJsonFiles": "error",
+  "alwaysPackageJsonMain": "error",
+  "alwaysPackageJsonTypes": "error",
   "noImplicitBrowsersList": "warn",
   "noImplicitSideEffects": "warn",
   "noPackageJsonTypings": "error",
@@ -10,6 +13,9 @@ exports[`{'noPackageJsonTypings': 'error'}} 1`] = `
 
 exports[`{'noPackageJsonTypings': 'off'}} 1`] = `
 {
+  "alwaysPackageJsonFiles": "error",
+  "alwaysPackageJsonMain": "error",
+  "alwaysPackageJsonTypes": "error",
   "noImplicitBrowsersList": "warn",
   "noImplicitSideEffects": "warn",
   "noPackageJsonTypings": "off",
@@ -18,6 +24,9 @@ exports[`{'noPackageJsonTypings': 'off'}} 1`] = `
 
 exports[`{'noPackageJsonTypings': 'warn'}} 1`] = `
 {
+  "alwaysPackageJsonFiles": "error",
+  "alwaysPackageJsonMain": "error",
+  "alwaysPackageJsonTypes": "error",
   "noImplicitBrowsersList": "warn",
   "noImplicitSideEffects": "warn",
   "noPackageJsonTypings": "warn",

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

@@ -27,6 +27,17 @@ export function parseExports(options: {
     }
   }
 
+  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 &&
@@ -125,34 +136,6 @@ 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
@@ -161,8 +144,16 @@ export function parseExports(options: {
     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/strict.ts

@@ -19,6 +19,9 @@ export const strictOptions = z
     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()
 
@@ -58,6 +61,21 @@ export interface StrictOptions {
    * @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 */