@sanity/plugin-kit 5.0.3 → 6.0.0

package/dist/_chunks-es/package.js

@@ -13,7 +13,7 @@ import pAny from "p-any";
 import { URL } from "url";
 import inquirer from "inquirer";
 import { pkg } from "./package2.js";
-import getLatestVersion from "get-latest-version";
+import { getLatestVersion } from "get-latest-version";
 import pProps from "p-props";
 const mergedPackages = [
   "@sanity/base",
@@ -274,6 +274,46 @@ function validatePackageType({ type }) {
   `.trimStart()
   ];
 }
+function findRequireConditions(node, pathSegments) {
+  if (Array.isArray(node))
+    return node.flatMap(
+      (entry, index) => findRequireConditions(entry, [...pathSegments, String(index)])
+    );
+  if (!node || typeof node != "object")
+    return [];
+  const found = [];
+  for (const [key, value] of Object.entries(node))
+    key === "require" && found.push(formatExportsPath(pathSegments)), found.push(...findRequireConditions(value, [...pathSegments, key]));
+  return found;
+}
+function formatExportsPath(segments) {
+  return `exports${segments.map((segment) => `[${JSON.stringify(segment)}]`).join("")}`;
+}
+function validateEsmOnly(packageJson) {
+  const offenders = [];
+  typeof packageJson.main < "u" && offenders.push(`- the top-level "main" field (${JSON.stringify(packageJson.main)})`), typeof packageJson.module < "u" && offenders.push(`- the top-level "module" field (${JSON.stringify(packageJson.module)})`);
+  const requireConditions = [...new Set(findRequireConditions(packageJson.exports, []))];
+  for (const conditionPath of requireConditions)
+    offenders.push(`- a "require" export condition at ${conditionPath}`);
+  return offenders.length ? [
+    outdent`
+      package.json ships CommonJS (CJS) output, but Sanity plugins target Sanity Studio v5+, which is pure ESM.
+
+      Remove the following so the package stays ESM-only:
+      ${offenders.join(`
+`)}
+
+      Supporting CJS is not worth it:
+      - It can have unintended side-effects.
+      - The Node.js versions plugin-kit supports (${requiredNodeEngine}) fully support require(esm), so a
+        consumer that still uses require() loads the ESM build directly — which is far more predictable.
+      - Publishing a single format guarantees two copies of the plugin's code (ESM + CJS) can't both end up
+        in the module tree, bloating bundles and slowing down builds.
+
+      Rely on "exports" together with "type": "module", and drop "main", "module" and any "require" conditions.
+  `.trimStart()
+  ] : [];
+}
 function validatePkgUtilsDependency({ devDependencies }) {
   return devDependencies?.["@sanity/pkg-utils"] ? [] : [
     outdent`
@@ -437,52 +477,60 @@ async function validateStudioConfig({ basePath }) {
 
 `)] : [];
 }
-async function validatePluginSanityJson({
+async function validateIncompatiblePlugin({
   basePath,
   packageJson
 }) {
-  const sanityJson = await readJson5File({ basePath, filename: "sanity.json" }), expectedDefaults = {
-    parts: [
-      {
-        implements: "part:@sanity/base/sanity-root",
-        path: "./v2-incompatible.js"
-      }
-    ]
-  }, hasSinglePart = sanityJson && Object.keys(sanityJson).length === 1 && sanityJson?.parts && sanityJson.parts.length === 1, firstPart = hasSinglePart ? sanityJson?.parts?.[0] : void 0, correctImplements = firstPart?.implements === expectedDefaults.parts[0].implements, pathExists = firstPart?.path && await fileExists(path.normalize(path.join(basePath, firstPart.path))), hasDependency = !!packageJson.dependencies?.[incompatiblePluginPackage];
-  if (!(sanityJson && hasSinglePart && correctImplements && pathExists && hasDependency)) {
-    const errors = [
-      sanityJson ? null : "sanity.json does not exist",
-      hasSinglePart ? null : 'sanity.json should have exactly one entry in "parts", but did not.',
-      correctImplements ? null : `The part should implement ${expectedDefaults.parts[0].implements}, but did not.`,
-      firstPart?.path && !pathExists ? `The file in "path", ${firstPart?.path}, does not exist.` : null,
-      hasDependency ? null : outdent`
-      package.json should have ${incompatiblePluginPackage} as a dependency, but did not.
-        Install it with: npm install --save ${incompatiblePluginPackage}
-      `.trimStart()
-    ].filter((e) => !!e);
-    return [
-      outdent`
-        Invalid sanity.json. It is used for compatibility checking in V2 studios:
+  const { dependencies, devDependencies, peerDependencies } = packageJson, inDependencies = !!(dependencies?.[incompatiblePluginPackage] || devDependencies?.[incompatiblePluginPackage] || peerDependencies?.[incompatiblePluginPackage]), hasShimFile = await fileExists(path.normalize(path.join(basePath, "v2-incompatible.js"))), sanityJsonReferencesShim = !!(await readJson5File({ basePath, filename: "sanity.json" }))?.parts?.some(
+    (part) => part?.path?.includes("v2-incompatible")
+  );
+  if (!inDependencies && !hasShimFile && !sanityJsonReferencesShim)
+    return [];
+  const found = [
+    inDependencies ? `- "${incompatiblePluginPackage}" listed in package.json` : null,
+    hasShimFile ? "- the v2-incompatible.js file" : null,
+    sanityJsonReferencesShim ? "- a sanity.json referencing v2-incompatible.js" : null
+  ].filter((e) => !!e);
+  return [
+    outdent`
+      ${incompatiblePluginPackage} is no longer used and should be removed.
 
-        - ${errors.join(`
-- `)}
+      It only rendered an error dialog in the long end-of-life Sanity Studio v2 when a v3 plugin was
+      installed there. That compatibility shim is now obsolete, so plugin-kit no longer adds it.
+
+      Found:
+      ${found.join(`
+`)}
 
-        sanity.json will only be used when incorrectly installing a v3 plugin in a v2 Studio.
+      To fix this:
+      - Remove "${incompatiblePluginPackage}" from package.json (dependencies/devDependencies/peerDependencies)
+      - Delete the v2-incompatible.js file
+      - Delete sanity.json (if it only contains the v2-incompatible "part")
+      - Remove "sanity.json" and "v2-incompatible.js" from the package.json "files" array
 
-        This check ensures that sanity.json conforms with the usage section of
-        ${urls.incompatiblePlugin}
+      For more, see ${urls.incompatiblePlugin}
     `.trimStart()
-    ];
-  }
-  return [];
+  ];
 }
 function validatePackageName$1(packageJson) {
-  const valid = validateNpmPackageName(
-    packageJson.name
-  );
+  const valid = validateNpmPackageName(packageJson.name ?? "");
   return valid.validForNewPackages ? !packageJson.name?.startsWith("@") && !packageJson.name?.startsWith("sanity-plugin-") ? [
     'Invalid package.json: "name" should be prefixed with "sanity-plugin-" (or scoped - @your-company/plugin-name)'
-  ] : [] : [`Invalid package.json: "name" is invalid: ${valid.errors.join(", ")}`];
+  ] : [] : [`Invalid package.json: "name" is invalid: ${(valid.errors ?? valid.warnings ?? []).join(", ")}`];
+}
+function validateBannedFiles(packageJson) {
+  const { files } = packageJson;
+  return Array.isArray(files) ? files.some((entry) => typeof entry != "string" ? !1 : entry.trim().replace(/^\.?\/+/, "").replace(/\/+$/, "") === "src") ? [
+    outdent`
+      package.json "files" must not include "src".
+
+      Plugins built with @sanity/plugin-kit publish the compiled output in "dist" (and any v2-compatibility files).
+      Shipping the "src" directory bloats the published package and can cause bundlers that resolve the
+      "source" export condition to import raw, uncompiled TypeScript.
+
+      Please remove "src" from the "files" array in package.json.
+    `.trimStart()
+  ] : [] : [];
 }
 async function validateSrcIndexFile(basePath) {
   const paths = ["index.js", "index.ts"].map((p) => path.join("src", p)), allowedIndexFiles = paths.map((file) => path.join(basePath, file));
@@ -563,7 +611,7 @@ const forcedPackageVersions = {}, forcedDevPackageVersions = {}, forcedPeerPacka
   "react-dom": "^18",
   "@types/react": "^18",
   "@types/react-dom": "^18",
-  sanity: "^3",
+  sanity: "^5 || ^6.0.0-0",
   "styled-components": "^5.2"
 };
 function errorToUndefined(err) {
@@ -761,7 +809,7 @@ function resolveLatestVersions(packages) {
 function rangeify(version) {
   return `^${version}`;
 }
-const defaultDependencies = [incompatiblePluginPackage], defaultDevDependencies = [
+const defaultDependencies = [], defaultDevDependencies = [
   "sanity",
   // peer dependencies of `sanity`
   "react",
@@ -808,11 +856,9 @@ async function validatePluginPackage(manifest, options) {
 function validatePackageName(manifest) {
   if (typeof manifest.name != "string")
     throw new Error('Invalid package.json: "name" must be a string');
-  const valid = validateNpmPackageName(
-    manifest.name
-  );
+  const valid = validateNpmPackageName(manifest.name);
   if (!valid.validForNewPackages)
-    throw new Error(`Invalid package.json: "name" is invalid: ${valid.errors.join(", ")}`);
+    throw new Error(`Invalid package.json: "name" is invalid: ${(valid.errors ?? []).join(", ")}`);
   if (manifest.name[0] !== "@" && !manifest.name.startsWith("sanity-plugin-"))
     throw new Error(
       'Invalid package.json: "name" should be prefixed with "sanity-plugin-" (or scoped - @your-company/plugin-name)'
@@ -891,7 +937,7 @@ async function writePackageJson(data, options) {
       ...await resolveLatestVersions(defaultPeerDependencies)
     },
     forcedPeerPackageVersions
-  ), source = flags.typescript ? "./src/index.ts" : "./src/index.js", files = [outDir, "sanity.json", "src", "v2-incompatible.js"];
+  ), source = flags.typescript ? "./src/index.ts" : "./src/index.js", files = [outDir];
   files.sort();
   const forcedOrder = {
     name: pluginName,
@@ -930,6 +976,8 @@ async function writePackageJson(data, options) {
   return log.debug("Does manifest differ? %s", differs ? "yes" : "no"), differs && await writePackageJsonDirect(manifest, options), differs ? manifest : prev;
 }
 function urlsFromOrigin(gitOrigin) {
+  if (!gitOrigin)
+    return {};
   const details = githubUrlToObject(gitOrigin);
   return details ? {
     homepage: `https://github.com/${details.user}/${details.repo}#readme`,
@@ -996,13 +1044,15 @@ export {
   resolveLatestVersions,
   sortKeys,
   validateBabelConfig,
+  validateBannedFiles,
   validateDeprecatedDependencies,
+  validateEsmOnly,
+  validateIncompatiblePlugin,
   validateNodeEngine,
   validatePackageName$1 as validatePackageName,
   validatePackageType,
   validatePkgUtilsDependency,
   validatePkgUtilsVersion,
-  validatePluginSanityJson,
   validateSanityDependencies,
   validateScripts,
   validateSrcIndexFile,