sanity-io / plugin-kit Goto Github PK

I have tried multiple times using npx @sanity/plugin-kit init pluginname, following the wizard, and then when running yarn build it instantly fails (see screenshot below)

All your plugin docs suggest using this but it doesn't work out of the box, so its not a great starting point! Please could someone take a look?

When running the README.md quick run steps, the package.json doesn't seem to be properly configured.

# Initialize a new plugin (outside of your Sanity studio folder)
npx @sanity/plugin-kit init sanity-plugin-testing-it-out

# Make your plugin linkable, and compile an initial version
cd sanity-plugin-testing-it-out
npm run link-watch

npm run link-watch produces

[error] `type` in `./package.json` must be of type 'commonjs' | 'module' (received undefined)

To fix this

1. The plugin template package.json needs "type": "module" added

2. "exports": {
    ".": {
      "types": "./lib/src/index.d.ts",
      "source": "./src/index.ts",
      "import": "./lib/index.esm.js",
      "require": "./lib/index.js", // Update to .cjs
      "default": "./lib/index.esm.js"
    },
    "main": "./lib/index.js", //update to .cjs

Describe the bug

ESLintIgnoreWarning: The ".eslintignore" file is no longer supported. Switch to using the "ignores" property in "eslint.config.js": https://eslint.org/docs/latest/use/configure/migration-guide#ignoring-files
(Use `node --trace-warnings ...` to show where the warning was created)

To Reproduce

Steps to reproduce the behavior:

1. Initialize
2. Verify pnpx @sanity/plugin-kit@latest verify-package

Expected behavior

No warnings. No .eslintignore file should be generated.

Screenshots

Which versions of Sanity are you using?

@sanity/cli (global) 3.14.4 (latest: 3.44.0)
@sanity/incompatible-plugin 1.0.4 (up to date)
@sanity/pkg-utils 6.8.18 (up to date)
@sanity/plugin-kit 4.0.16 (up to date)
sanity 3.44.0 (up to date)

What operating system are you using?

Mac

Which versions of Node.js / npm are you running?

pnpm 9.0.5

Additional context

Add any other context about the problem here.

Security issue?

Any security issues should be submitted directly to [email protected]. In order to determine whether you are dealing with a security issue, ask yourself these two questions:

• Can I access something that's not mine, or something I shouldn't have access to?
• Can I disable something for other people? If the answer to either of those two questions are "yes", then you're probably dealing with a security issue. Note that even if you answer "no" to both questions, you may still be dealing with a security issue, so if you're unsure, just email us at [[email protected]](mailto:[email protected].

[0] Error: missing package.json
[0] at D:\repos\sanity-smartling\sanity-plugin-smartling\node_modules@sanity\pkg-utils\dist_chunks\watch-86ed07a5.cjs:186:13

[0]
[0] D:\repos\sanity-plugin\sanity-plugin-smartling\node_modules\rxjs\dist\cjs\internal\util\reportUnhandledError.js:13
[0] throw err;
[0] ^
[0]
[0] Error: missing package.json
[0] at D:\repos\sanity-plugin\sanity-plugin-smartling\node_modules@sanity\pkg-utils\dist_chunks\watch-86ed07a5.cjs:186:13
[0] at D:\repos\net-sanity-plugin\sanity-plugin-smartling\node_modules\rxjs\dist\cjs\internal\operators\switchMap.js:17:35

Following the exact steps in the readme end up in error.

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Using a curated preset maintained by

Sanity: The Composable Content Cloud

Pending Approval

These branches will be created by Renovate only once you click their checkbox below.

• chore(deps): update dependency sanity to v3.47.1
• fix(deps): Update dependency nodemon to v3.1.4
• chore(deps): lock file maintenance
• 🔐 Create all pending approval PRs at once 🔐

Ignored or Blocked

These are blocked by an existing closed PR and will not be recreated unless you click a checkbox below.

• chore(deps): update dependency sinon to v18
• chore(deps): update dependency tap to v18
• chore(deps): update dependency tap to v19

Detected dependencies

• Check this box to trigger a request for Renovate to run again on this repository

When a .eslintrc is used the plugin-kit correctly detects that I have @sanity/no-v2-imports in my extends array.
But when using .eslintrc.js I get this error:

✖ 4 problems (3 errors, 1 warning)
ESLint detected Studio V2 imports that are no longer available.
It is recommended configure @sanity/eslint-config-no-v2-imports for ESLint.

Run:
npm install --save-dev @sanity/eslint-config-no-v2-imports

In .eslintrc add:
"extends": ["@sanity/no-v2-imports"]

This way, V2-imports can be identified directly in the IDE, or using eslint CLI.
For more, see https://github.com/sanity-io/eslint-config-no-v2-imports

If the plugin package does not use eslint, disable this check.

To skip this validation add the following to your package.json:
"sanityPlugin": {
   "verifyPackage": {
      "eslintImports": false
   }
}

Repro: https://github.com/sanity-io/sanity-plugin-mux-input