@sanity/pkg-utils 5.1.1-canary.0 → 5.1.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/pkg-utils",
-  "version": "5.1.1-canary.0",
+  "version": "5.1.2",
   "description": "Simple utilities for modern npm packages.",
   "keywords": [
     "sanity-io",
@@ -46,24 +46,6 @@
     "!dist/stats.html",
     "src"
   ],
-  "scripts": {
-    "build": "run-s clean build:pkg check:pkg",
-    "build:pkg": "node -r esbuild-register scripts/build",
-    "check:pkg": "node -r esbuild-register scripts/check",
-    "check:types": "tsc --build",
-    "clean": "rimraf dist test/env/__tmp__",
-    "commit": "cz",
-    "extract": "sanity-tsdoc etl --outDir etc/api/@sanity/pkg-utils --tsconfig tsconfig.dist.json",
-    "format": "prettier --write --cache --ignore-unknown . && eslint . --ext .cjs,.js,.ts,.tsx --fix --quiet",
-    "lint": "eslint . --ext .cjs,.js,.ts,.tsx",
-    "playground:build": "pnpm --filter './playground/**' build",
-    "playground:clean": "pnpm --filter './playground/**' --silent clean",
-    "prepublishOnly": "pnpm run build",
-    "test": "run-s playground:clean test:clean vitest:run",
-    "test:clean": "rimraf test/env/__tmp__",
-    "vitest:run": "vitest run",
-    "watch": "node -r esbuild-register scripts/watch"
-  },
   "commitlint": {
     "extends": [
       "@commitlint/config-conventional"
@@ -119,7 +101,6 @@
   "devDependencies": {
     "@commitlint/cli": "^19.2.1",
     "@commitlint/config-conventional": "^19.1.0",
-    "@sanity/pkg-utils": "workspace:*",
     "@types/babel__core": "^7.20.5",
     "@types/cpx": "^1.5.5",
     "@types/find-config": "^1.0.4",
@@ -150,7 +131,8 @@
     "ts-node": "^10.9.2",
     "typescript": "5.4.2",
     "vitest": "^1.4.0",
-    "vitest-github-actions-reporter": "^0.11.1"
+    "vitest-github-actions-reporter": "^0.11.1",
+    "@sanity/pkg-utils": "5.1.2"
   },
   "peerDependencies": {
     "typescript": "5.4.2"
@@ -162,9 +144,21 @@
   "publishConfig": {
     "access": "public"
   },
-  "pnpm": {
-    "overrides": {
-      "@sanity/pkg-utils": "workspace:*"
-    }
+  "scripts": {
+    "build": "run-s clean build:pkg check:pkg",
+    "build:pkg": "node -r esbuild-register scripts/build",
+    "check:pkg": "node -r esbuild-register scripts/check",
+    "check:types": "tsc --build",
+    "clean": "rimraf dist test/env/__tmp__",
+    "commit": "cz",
+    "extract": "sanity-tsdoc etl --outDir etc/api/@sanity/pkg-utils --tsconfig tsconfig.dist.json",
+    "format": "prettier --write --cache --ignore-unknown . && eslint . --ext .cjs,.js,.ts,.tsx --fix --quiet",
+    "lint": "eslint . --ext .cjs,.js,.ts,.tsx",
+    "playground:build": "pnpm --filter './playground/**' build",
+    "playground:clean": "pnpm --filter './playground/**' --silent clean",
+    "test": "run-s playground:clean test:clean vitest:run",
+    "test:clean": "rimraf test/env/__tmp__",
+    "vitest:run": "vitest run",
+    "watch": "node -r esbuild-register scripts/watch"
   }
-}
+}

package/src/node/build.ts

@@ -33,7 +33,8 @@ export async function build(options: {
   const {cwd, emitDeclarationOnly, strict = false, tsconfig: tsconfigOption} = options
   const logger = createLogger()
 
-  const pkg = await loadPkgWithReporting({cwd, logger})
+  const pkg = await loadPkgWithReporting({cwd, logger, strict})
+
   const config = await loadConfig({cwd})
   const extMap = getPkgExtMap({legacyExports: config?.legacyExports ?? false})
   const tsconfig = tsconfigOption || config?.tsconfig || 'tsconfig.json'

package/src/node/check.ts

@@ -1,10 +1,10 @@
-import esbuild, {BuildFailure} from 'esbuild'
+import esbuild, {type BuildFailure} from 'esbuild'
 import path from 'path'
 
 import {createConsoleSpy} from './consoleSpy'
 import {getPkgExtMap, loadConfig, loadPkgWithReporting} from './core'
 import {fileExists} from './fileExists'
-import {createLogger, Logger} from './logger'
+import {createLogger, type Logger} from './logger'
 import {printPackageTree} from './printPackageTree'
 import {resolveBuildContext} from './resolveBuildContext'
 
@@ -17,7 +17,7 @@ export async function check(options: {
   const {cwd, strict = false, tsconfig: tsconfigOption} = options
   const logger = createLogger()
 
-  const pkg = await loadPkgWithReporting({cwd, logger})
+  const pkg = await loadPkgWithReporting({cwd, logger, strict})
   const config = await loadConfig({cwd})
   const extMap = getPkgExtMap({legacyExports: config?.legacyExports ?? false})
   const tsconfig = tsconfigOption || config?.tsconfig || 'tsconfig.json'

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

@@ -10,13 +10,21 @@ import type {PackageJSON} from './types'
 export async function loadPkgWithReporting(options: {
   cwd: string
   logger: Logger
+  strict: boolean
 }): Promise<PackageJSON> {
-  const {cwd, logger} = options
+  const {cwd, logger, strict} = options
 
   try {
     const pkg = await loadPkg({cwd})
     let shouldError = false
 
+    if (strict && !pkg.type) {
+      shouldError = true
+      logger.error(
+        `the \`type\` field in \`./package.json\` must be either "module" or "commonjs")`,
+      )
+    }
+
     // validate exports
     if (pkg.exports) {
       const _exports = Object.entries(pkg.exports)

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

@@ -30,7 +30,7 @@ export function parseExports(options: {
 
   const errors: string[] = []
 
-  if (strict && !pkg.types && pkg.source?.endsWith('.ts')) {
+  if (strict && !pkg.types && pkg.source?.endsWith('.ts') && pkg.exports) {
     errors.push(
       'package.json: `types` must be declared for the npm listing to show as a TypeScript module.',
     )

package/src/node/resolveBuildTasks.ts

@@ -75,18 +75,20 @@ export function resolveBuildTasks(ctx: BuildContext): BuildTask[] {
 
   // Handle dts tasks for bundles
   for (const bundle of bundles) {
-    // importId needs to be how the bundle is used, like `@sanity/pkg-utils/dist/cli`
-    // exportPath needs to be the path to the bundle, like `./dist/cli`
-    // targetPaths is then: [./dist/cli.d.ts, ./dist/cli.d.cts]
-    const exportPath = (bundle.import || bundle.require)!.replace(/\.[mc]?js$/, '')
-    const importId = path.join(pkg.name, exportPath)
-
-    dtsTask.entries.push({
-      importId,
-      exportPath,
-      sourcePath: bundle.source,
-      targetPaths: getTargetPaths(pkg.type, bundle),
-    })
+    if (bundle.source?.endsWith('.ts')) {
+      // importId needs to be how the bundle is used, like `@sanity/pkg-utils/dist/cli`
+      // exportPath needs to be the path to the bundle, like `./dist/cli`
+      // targetPaths is then: [./dist/cli.d.ts, ./dist/cli.d.cts]
+      const exportPath = (bundle.import || bundle.require)!.replace(/\.[mc]?js$/, '')
+      const importId = path.join(pkg.name, exportPath)
+
+      dtsTask.entries.push({
+        importId,
+        exportPath,
+        sourcePath: bundle.source,
+        targetPaths: getTargetPaths(pkg.type, bundle),
+      })
+    }
   }
 
   // Add dts task
@@ -147,7 +149,6 @@ export function resolveBuildTasks(ctx: BuildContext): BuildTask[] {
       })
     }
 
-    // @TODO also handle bundles
     for (const bundle of bundles) {
       const idx = bundles.indexOf(bundle)
 

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

@@ -115,8 +115,6 @@ export async function extractTypes(options: {
   }
 
   if (shouldCleanUpDts) {
-    // eslint-disable-next-line no-console
-    console.warn('Cleaning up .d.ts file', typesPath)
     await fs.unlink(typesPath)
   }
 

package/src/node/watch.ts

@@ -30,7 +30,7 @@ export async function watch(options: {
         throw new Error('missing package.json')
       }
 
-      const pkg = await loadPkgWithReporting({cwd, logger})
+      const pkg = await loadPkgWithReporting({cwd, logger, strict})
       const config = await loadConfig({cwd})
       const extMap = getPkgExtMap({legacyExports: config?.legacyExports ?? false})
       const tsconfig = tsconfigOption || config?.tsconfig || 'tsconfig.json'