💡: Support ts config files

[gmzacharydovel]

Problem

It would be nice if the tool supported ts files. I use it to help make sure the configuration is well formed. Without the support, I turned to trying to import the lint tool directly.... and realized the documentation doesn't really help. I haven't figured out how to get it to load the 'words' yet.

I'm going to ponder a bit more, but I'm a bit stuck.

Solution

Add support for loading a ts file for configuration

Alternatives

No response

Additional Context

No response

Code of Conduct

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

[Jason3S]

@gmzacharydovel,

Thank you for the suggestion.

Did you try // @ts-check?

cspell.config.mjs

// @ts-check

import { defineConfig } from 'cspell';

export default defineConfig({
    words: ['mycompany'],
});

[gmzacharydovel]

I'll take a look, thank you.

[gmzacharydovel]

I have a framework that wraps cspell as one of its tools. The files are compiled from ts to js, where this definitely helps. The only exception is in the root project where it eats its own ts dogfood.

[gmzacharydovel]

It looks like eslint accomplishes reading ts config files with jiti.

https://www.npmjs.com/package/jiti

[Jason3S]

@gmzacharydovel,

I can add a --register option. The usage would be cspell --register jiti/register . --config cspell.config.mts

[gmzacharydovel]

I think your approach would be appropriate.

eslint also doesn't require jiti. It doesn't get pulled in automatically and reading ts files will fail without it.