[ESLint] How to export custom dictionary with config

[christopher-buss]

Hi! I maintain a custom ESlint config which is a preconfigured set of ESlint rules. As part of this, I am currently looking into adding a spell checker module. The problem is, a lot of false positives were getting picked up (due to platform speciifc words), so I made my own config here.

In my config, I have included my dict as a dependency, and then added it in the import section of the cspell eslint plugin, but sadly this does not export the config to consumers. Any advice would be appreciated! The code where I am attempting to import it can be found here.

[Jason3S]

@christopher-buss,

I'll take a look.

[Jason3S]

@christopher-buss,

TL;DR

Use configFile to import the dictionary.

You can use a local cspell config file bundled with your plugin or refer to your dictionary directly:

rules: {
    '@cspell/spellchecker': [
        'warn',
        {
            // ...
            configFile: '@isentinel/dict-roblox',
            cspell: {
                language: 'en-US',
                words: ['isentinel'],
            },
            // ...
        },
    ],
},

It is also possible to use a URL:

configFile: 'https://cdn.jsdelivr.net/npm/@isentinel/[email protected]/cspell-ext.json',
// or
configFile: new URL('./cspell.config.js', import.meta.url).href,

More Detail

The current implementation of cspell.import in the ESLint plugin does not work as expected. It was implemented as a pass-through to the cspell-lib, but the method used will not resolve the imports. It was assumed to be working because the tests passed. But the tests assumed that import was used when it was not.

A workaround is to use the configFile option to point to a cspell config file bundled with your package. The imports in the config file will get correctly imported.

The issue is the challenge on how to resolve the location of an import. CSpell uses the location of the configuration file to resolve the import, a bit like:

import { createRequire } from 'node:module';
import { pathToFileURL } from 'node:url';

function resolveImport(importName, pathToCSpellConfig) {
  const require = createRequire(pathToFileURL(pathToCSpellConfig);
  return require.resolve(importName);
}

The problem with cspell.import option in the ESLint config is that pathToCSpellConfig isn't known. The "fix" in #5790 tries to guess, but that is imperfect and won't always work with your plugin due to the layout of node_modules. Package managers like PNPM work hard to correctly isolate modules and this will cause random behavior when trying to resolve @isentinel/dict-roblox.

I apologize that the import feature was added without full testing. The excuse is that it is difficult to test ESLint Plugins and as such, unit tests explicitly for import were not added. Recently I have expanded the tests. I'll update #5790 to imports consistent.