@sanity/plugin-kit 5.0.2 → 6.0.0

package/README.md

@@ -124,13 +124,13 @@ Verify that the plugin package is configured correctly by running:
 
 - Check package.json for:
   - recommended script commands
-  - recommended cjs and esm configuration
+  - ESM-only configuration (bans CJS `main`/`module` fields and `require` export conditions)
   - sanity dependency compatibility
   - @sanity/pkg-utils devDependency
   - recommended usage of devDependencies/peerDependencies/dependencies for certain packages
 - Check for redundant v2 config:
   - babel
-  - sanity.json
+  - the deprecated `@sanity/incompatible-plugin` v2 compatibility shim (`sanity.json` + `v2-incompatible.js`)
 - Check for sanity imports that has changed in v3, using eslint
 - Check tsconfig.json settings
 - Check for [SPDX](https://spdx.org/licenses/) compatible license definition
@@ -206,7 +206,6 @@ The inject command can do more work by adding presets. Consult the individual pr
 - [semver-workflow](./docs/semver-workflow.md) - Add an opinionated Github workflow to automate NPM releases
 - [renovatebot](./docs/renovatebot.md) - Add opinionated Renovatebot config to make dependency management a breeze
 - [ui](./docs/ui.md) - Add [@sanity/ui](https://github.com/sanity-io/ui) to build plugin UIs.
-- [ui-workshop](./docs/ui-workshop.md) - Add [@sanity/ui-workshop](https://github.com/sanity-io/ui-workshop) to make component testing a breeze
 
 ## Testing a plugin in Sanity Studio
 
@@ -422,25 +421,35 @@ Provide a sanityPlugin config in package.json (defaults shown):
     "linkWatch": {
       "command": "npm run watch",
       "extensions": "js,png,svg,gif,jpeg,css"
+    },
+    "verifyPackage": {
+      "packageName": true,
+      "esmOnly": true,
+      "tsconfig": true,
+      "tsc": true,
+      "dependencies": true,
+      "deprecatedDependencies": true,
+      "babelConfig": true,
+      "incompatiblePlugin": true,
+      "eslintImports": true,
+      "scripts": true,
+      "pkg-utils": true,
+      "nodeEngine": true,
+      "studioConfig": true,
+      "srcIndex": true,
+      "bannedFiles": true,
+      "duplicateConfig": true
     }
-  },
-  "verifyPackage": {
-    "packageName": true,
-    "module": true,
-    "tsconfig": true,
-    "tsc": true,
-    "dependencies": true,
-    "rollupConfig": true,
-    "babelConfig": true,
-    "sanityV2Json": true,
-    "eslintImports": true,
-    "scripts": true,
-    "pkg-utils": true,
-    "nodeEngine": true
   }
 }
 ```
 
+Set `esmOnly` to `false` to allow CommonJS interop (a `require` export condition, or top-level
+`main`/`module` fields). This is discouraged: plugins target Sanity Studio v5+, which is pure ESM, and
+shipping a parallel CJS build can have unintended side-effects. The supported Node.js versions handle
+`require(esm)`, so a single published format keeps two copies of the plugin's code out of the module
+tree, avoiding bundle bloat and slower builds.
+
 ## License
 
 MIT © [Espen Hovlandsdal](https://espen.codes/) and [Sanity.io](https://www.sanity.io/)

package/dist/_chunks-es/init.js

@@ -1,9 +1,9 @@
 import path from "path";
 import meow from "meow";
-import { initFlags, init } from "./init2.js";
+import { initFlags, init, presetHelpList } from "./init2.js";
 import { cliName, log } from "./index.js";
 import execa from "execa";
-import { prompt, hasSanityJson, findStudioV3Config, isEmptyish, ensureDir, presetHelpList } from "./package.js";
+import { prompt, hasSanityJson, findStudioV3Config, isEmptyish, ensureDir } from "./package.js";
 function npmIsAvailable() {
   return execa("npm", ["-v"]).then(() => !0).catch(() => !1);
 }