cspell-lib
Version:
A library of useful functions used across various cspell tools.
24 lines • 1.47 kB
TypeScript
import type { PnPSettingsOptional } from './PnPSettings.js';
import type { CSpellSettingsI } from './types.js';
/**
* Read / import a cspell configuration file.
* @param filename - the path to the file.
* Supported types: json, yaml, js, and cjs. ES Modules are not supported.
* - absolute path `/absolute/path/to/file`
* - relative path `./path/to/file` (relative to the current working directory)
* - package `@cspell/dict-typescript/cspell-ext.json`
*/
export declare function readSettings(filename: string | URL): Promise<CSpellSettingsI>;
export declare function readSettings(filename: string | URL, pnpSettings: PnPSettingsOptional): Promise<CSpellSettingsI>;
/**
* Read / import a cspell configuration file.
* @param filename - the path to the file.
* Supported types: json, yaml, js, and cjs. ES Modules are not supported.
* - absolute path `/absolute/path/to/file`
* - relative path `./path/to/file` (relative to `relativeTo`)
* - package `@cspell/dict-typescript/cspell-ext.json` searches for node_modules relative to `relativeTo`
* @param relativeTo - absolute path to start searching for relative files or node_modules.
*/
export declare function readSettings(filename: string | URL, relativeTo: string | URL): Promise<CSpellSettingsI>;
export declare function readSettings(filename: string | URL, relativeTo: string | URL, pnpSettings: PnPSettingsOptional): Promise<CSpellSettingsI>;
//# sourceMappingURL=readSettings.d.ts.map