[Bug]: Error when trying to integrate the plugin to the eslint flat config file

[rimakan]

Kind of Issue

Question

Tool or Library

cspell/eslint-plugin

Version

8.15.5

Supporting Library

Not sure / None

OS

Linux

OS Version

22.04

Description

The ESLint cannot import @cspell/eslint-plugin for some reason

Steps to Reproduce

1. Migrate ESLint config file (eslintrc.json) to the flat config using ESLint CLI npx @eslint/migrate-config .eslintrc.json
2. Install the @cspell/eslint-plugin using your package manager (npm or yarn)
3. Integrate it in the newly created ESLint flat config file using the instuction
4. Restart VS Code
5. Open up the flat config ESLint file and check out ESLint output in VS Code
   

Expected Behavior

There are no errors

Additional Information

No response

cspell.json

No response

cspell.config.yaml

No response

Example Repository

No response

Code of Conduct

• I agree to follow this project's Code of Conduct

[Jason3S]

I think this might be a yarn only issue.

[Jason3S]

@rimakan,

It is a yarn bug yarnpkg/berry#2476

There might be a work around by using: NODE_OPTIONS="--require .pnp.cjs" like this:
NODE_OPTIONS="--require .pnp.cjs" yarn eslint ..

You could also try importing .pnp.cjs from .eslint.config.js, that might work, but the above issue might keep it from working.

eslint.config.js

import './.pnp.cjs';
// ... the rest of your config.

I'm open to a PR if you find a good fix, there are docs https://yarnpkg.com/features/pnp

[rimakan]

@Jason3S , thank you for your input!

It didn't help to be candid.

What helps is to set nodeLinkers: node-modules in .yarnrc.yaml and reinstall deps to have node_modules but this is a weird solution because it violates the plug and play pattern of new Yarn versions. It is better not to do it.

[Jason3S]

@rimakan,

There is not much I can do. It really is a Yarn issue: yarnpkg/berry#6335

This plugin uses SyncKit to run the worker.

Please try yarn unplug @cspell/eslint-plugin and see if that works for you.

[Jason3S]

@rimakan,

A bit of information would be useful:

1. Node version
2. Yarn version

[rimakan]

@Jason3S ,

My bad, sure I will provide you with the info

Node: 20.13
Yarn: 4.5.0

Your workaround didn't work. I saw similar error to what I attached to the issue. This time I saw the issue but with SyncKit. I tried to install it and put to to "resolutions". It did not help me whatsoever :(

[Jason3S]

@rimakan,

I took the time to set it up and try it out. There are other tests to ensure cspell runs with Yarn, but I had not done that with the ESLint plugin.

I think the key thing to get it working is to ensure yarn generates the .pnp.loader.mjs file. Use the pnpEnableEsmLoader: true in .yarnrc.yml.

[rimakan]

@Jason3S ,

Thank you for your assistance. Your solution did not help me. I still see the very error

Do I need to install extra packages that may be dependencies for the plugin?

[Jason3S]

@rimakan,

Please start with a basic setup and see if it works.

Here is a SandBox Link

Please make an example that fails. As far as I can tell, it is working as expected.