Q: How to import spellCheckDocument from cspell-lib using tsx from a package with type module or commonjs?

[acenturyandabit]

Kind of Issue

Change in behavior / Regression

Tool or Library

cspell-lib

Version

8.17.1

Supporting Library

Not sure / None

OS

Linux

OS Version

wsl

Description

When I try:

// a.ts
import { spellCheckDocument } from 'cspell-lib';
(async () => {
  console.log(await spellCheckDocument(
    { uri: 'text.txt', text: "hello world", languageId: 'plaintext', locale: 'en' },
    { generateSuggestions: true, noConfigSearch: true },
    { suggestionsTimeout: 2000 }
  ))
})();

and run

tsx a.ts

I get

Error [ERR_PACKAGE_PATH_NOT_EXPORTED]: No "exports" main defined in /.../node_modules/cspell-lib/package.json

When I add "type": "module" to my package.json, this fixes the issue, but breaks another local dependency which I've imported which is commonjs.

Steps to Reproduce

No response

Expected Behavior

No response

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]

@acenturyandabit,

Please try using the await import():

// a.ts
(async () => {
    const { spellCheckDocument } = await import('cspell-lib');
    console.log(await spellCheckDocument(
    { uri: 'text.txt', text: "hello worldz", languageId: 'plaintext', locale: 'en' },
    { generateSuggestions: true, noConfigSearch: true },
    { suggestionsTimeout: 2000 }
  ))
})();

Since cspell-lib is an ESM Module, it cannot be used with import .. from in a commonjs package. Instead, it is necessary to use import().

I hope this helps.