fix!: pkg-utils validates if exports are missing (#167)

sanity-io · Apr 11, 2024 · 3daaa3d · 3daaa3d
1 parent d3ee8a3
commit 3daaa3d
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 25 deletions.
diff --git a/src/actions/verify/validations.ts b/src/actions/verify/validations.ts
@@ -16,7 +16,7 @@ export const expectedScripts = {
   prepublishOnly: 'npm run build',
 }
 
-const expectedModulesFields = ['exports', 'main', 'files']
+const expectedModulesFields = ['main', 'files']
 
 function filesWithSuffixes(fileBases: string[], suffixes: string[]): string[] {
   return fileBases.flatMap((file) => suffixes.map((suffix) => `${file}.${suffix}`))
@@ -48,23 +48,14 @@ export function validateModule(packageJson: PackageJson, options: {outDir: strin
   if (missingFields.length) {
     errors.push(
       outdent`
-        Expected exports, main, files entries in package.json, but ${missingFields.join(
-          ', ',
-        )} where missing.
+        Expected main, files entries in package.json, but ${missingFields.join(', ')} where missing.
 
         Example:
 
-        Given a plugin with entry-point in src/index.ts, using default @sanity/pkg-utils build command,
-        package.json should contain the following entries to ensure that commonjs and esm outputs are built into ${outDir}:
+        Given a plugin with entry-point in src/index.ts, using a default @sanity/pkg-utils build command,
+        the package.json should contain the following entries to ensure that commonjs and esm outputs are built into ${outDir}:
 
-        "exports": {
-          ".": {
-            "source": "./src/index.ts",
-            "import": "./${outDir}/index.mjs",
-            "default": "./${outDir}/index.js"
-          }
-        },
-        "main": "./${outDir}/index.js",
+        "main": "./${outDir}/index.ts",
         "types": "./${outDir}/index.d.ts",
         "files": [
           "${outDir}",

diff --git a/tap-snapshots/test/verify-package.test.ts.test.cjs b/tap-snapshots/test/verify-package.test.ts.test.cjs
@@ -71,21 +71,14 @@ To skip this validation add the following to your package.json:
 }
 ----------------------------------------------------------
 [error] 
-Expected exports, main, files entries in package.json, but exports, main where missing.
+Expected main, files entries in package.json, but main where missing.
 
 Example:
 
-Given a plugin with entry-point in src/index.ts, using default @sanity/pkg-utils build command,
-package.json should contain the following entries to ensure that commonjs and esm outputs are built into dist:
+Given a plugin with entry-point in src/index.ts, using a default @sanity/pkg-utils build command,
+the package.json should contain the following entries to ensure that commonjs and esm outputs are built into dist:
 
-"exports": {
-  ".": {
-    "source": "./src/index.ts",
-    "import": "./dist/index.mjs",
-    "default": "./dist/index.js"
-  }
-},
-"main": "./dist/index.js",
+"main": "./dist/index.ts",
 "types": "./dist/index.d.ts",
 "files": [
   "dist",