cspell-lib 9.3.1 → 9.4.0

package/dist/lib/Settings/Controller/configLoader/configLoader.d.ts

@@ -94,6 +94,7 @@ export interface IConfigLoader {
     readonly isTrusted: boolean;
     setIsTrusted(isTrusted: boolean): void;
 }
+export declare const defaultExtensionsAll: string[];
 export declare class ConfigLoader implements IConfigLoader {
     #private;
     readonly fs: VFileSystem;

package/dist/lib/Settings/Controller/configLoader/configLoader.js

@@ -30,11 +30,12 @@ const setOfSupportedConfigVersions = Object.freeze(new Set(supportedCSpellConfig
 export const sectionCSpell = 'cSpell';
 export const defaultFileName = 'cspell.json';
 let defaultConfigLoader = undefined;
-const defaultExtensions = ['.json', '.yaml', '.yml', '.jsonc'];
-const defaultJsExtensions = ['.js', '.cjs', '.mjs'];
+const defaultExtensions = ['.json', '.yaml', '.yml', '.jsonc', '.toml'];
+const defaultJsExtensions = ['.js', '.cjs', '.mjs', '.ts', '.mts'];
+export const defaultExtensionsAll = [...defaultExtensions, ...defaultJsExtensions];
 const trustedSearch = new Map([
     ['*', defaultExtensions],
-    ['file:', [...defaultExtensions, ...defaultJsExtensions]],
+    ['file:', defaultExtensionsAll],
 ]);
 const unTrustedSearch = new Map([['*', defaultExtensions]]);
 export class ConfigLoader {

package/dist/lib/Settings/Controller/configLoader/configLocations.d.ts

@@ -1,3 +1,4 @@
+export declare const supportedExtensions: string[];
 export declare const searchPlaces: readonly string[];
 export declare const defaultConfigFilenames: readonly string[];
 //# sourceMappingURL=configLocations.d.ts.map

package/dist/lib/Settings/Controller/configLoader/configLocations.js

@@ -1,4 +1,15 @@
-const supportedExtensions = ['.json', '.jsonc', '.yaml', '.yml', '.mjs', '.cjs', '.js', '.toml', '.mts', '.ts'];
+export const supportedExtensions = [
+    '.json',
+    '.jsonc',
+    '.yaml',
+    '.yml',
+    '.mjs',
+    '.cjs',
+    '.js',
+    '.toml',
+    '.mts',
+    '.ts',
+];
 /**
  * Logic of the locations:
  * - Support backward compatibility with the VS Code Spell Checker

package/dist/lib/textValidation/docValidator.d.ts

@@ -131,9 +131,31 @@ interface Preparations {
     localConfigFilepath: string | undefined;
 }
 interface ShouldCheckDocumentResult {
+    /** possible errors found while loading configuration. */
     errors: Error[];
+    /**
+     * The calculated result:
+     * - `false` if the document should not be checked. Based upon the settings.
+     * - `true` if the document should be checked.
+     */
     shouldCheck: boolean;
+    /** final settings used to determine the result. */
+    settings: CSpellUserSettings;
+    /**
+     * The reason the document should not be checked.
+     */
+    reason?: string | undefined;
 }
+/**
+ * Check if a document should be checked based upon the ignorePaths and override settings.
+ *
+ * This function will search and fetch settings based upon the location of the document if `noConfigSearch` is not true.
+ *
+ * @param doc - document to check
+ * @param options - options to override some of the settings.
+ * @param settings - current settings
+ * @returns ShouldCheckDocumentResult
+ */
 export declare function shouldCheckDocument(doc: TextDocumentRef, options: DocumentValidatorOptions, settings: CSpellUserSettings): Promise<ShouldCheckDocumentResult>;
 export declare const __testing__: {
     sanitizeSuggestion: typeof sanitizeSuggestion;

package/dist/lib/textValidation/docValidator.js

@@ -81,7 +81,9 @@ export class DocumentValidator {
             : useSearchForConfig
                 ? timePromise(this.perfTiming, '__searchForDocumentConfig', searchForDocumentConfig(this._document, settings, settings))
                 : undefined;
-        pLocalConfig && timePromise(this.perfTiming, '_loadConfig', pLocalConfig);
+        if (pLocalConfig) {
+            timePromise(this.perfTiming, '_loadConfig', pLocalConfig);
+        }
         const localConfig = (await catchPromiseError(pLocalConfig, (e) => this.addPossibleError(e))) || {};
         this.addPossibleError(localConfig?.__importRef?.error);
         const config = mergeSettings(settings, localConfig);
@@ -394,6 +396,16 @@ async function searchForDocumentConfig(document, defaultConfig, pnpSettings) {
 function mapSug(sug) {
     return { cost: 999, ...sug };
 }
+/**
+ * Check if a document should be checked based upon the ignorePaths and override settings.
+ *
+ * This function will search and fetch settings based upon the location of the document if `noConfigSearch` is not true.
+ *
+ * @param doc - document to check
+ * @param options - options to override some of the settings.
+ * @param settings - current settings
+ * @returns ShouldCheckDocumentResult
+ */
 export async function shouldCheckDocument(doc, options, settings) {
     const errors = [];
     function addPossibleError(error) {
@@ -413,11 +425,16 @@ export async function shouldCheckDocument(doc, options, settings) {
         addPossibleError(localConfig?.__importRef?.error);
         const config = mergeSettings(settings, localConfig);
         const matcher = getGlobMatcherForExcluding(localConfig?.ignorePaths);
-        const docSettings = await determineTextDocumentSettings(doc, config);
         // eslint-disable-next-line unicorn/prefer-regexp-test
-        return !matcher.match(uriToFilePath(doc.uri)) && (docSettings.enabled ?? true);
+        if (matcher.match(uriToFilePath(doc.uri))) {
+            return { errors, shouldCheck: false, settings: localConfig, reason: 'Excluded by ignorePaths.' };
+        }
+        const docSettings = await determineTextDocumentSettings(doc, config);
+        const shouldCheck = docSettings.enabled ?? true;
+        const reason = shouldCheck ? undefined : 'Excluded by overrides or languageSettings.';
+        return { errors, shouldCheck, settings: docSettings, reason };
     }
-    return { errors, shouldCheck: await shouldCheck() };
+    return await shouldCheck();
 }
 export const __testing__ = {
     sanitizeSuggestion,

package/package.json

@@ -4,7 +4,7 @@
     "access": "public",
     "provenance": true
   },
-  "version": "9.3.1",
+  "version": "9.4.0",
   "description": "A library of useful functions used across various cspell tools.",
   "type": "module",
   "sideEffects": false,
@@ -64,21 +64,21 @@
   },
   "homepage": "https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell-lib#readme",
   "dependencies": {
-    "@cspell/cspell-bundled-dicts": "9.3.1",
-    "@cspell/cspell-pipe": "9.3.1",
-    "@cspell/cspell-resolver": "9.3.1",
-    "@cspell/cspell-types": "9.3.1",
-    "@cspell/dynamic-import": "9.3.1",
-    "@cspell/filetypes": "9.3.1",
-    "@cspell/strong-weak-map": "9.3.1",
-    "@cspell/url": "9.3.1",
+    "@cspell/cspell-bundled-dicts": "9.4.0",
+    "@cspell/cspell-pipe": "9.4.0",
+    "@cspell/cspell-resolver": "9.4.0",
+    "@cspell/cspell-types": "9.4.0",
+    "@cspell/dynamic-import": "9.4.0",
+    "@cspell/filetypes": "9.4.0",
+    "@cspell/strong-weak-map": "9.4.0",
+    "@cspell/url": "9.4.0",
     "clear-module": "^4.1.2",
-    "cspell-config-lib": "9.3.1",
-    "cspell-dictionary": "9.3.1",
-    "cspell-glob": "9.3.1",
-    "cspell-grammar": "9.3.1",
-    "cspell-io": "9.3.1",
-    "cspell-trie-lib": "9.3.1",
+    "cspell-config-lib": "9.4.0",
+    "cspell-dictionary": "9.4.0",
+    "cspell-glob": "9.4.0",
+    "cspell-grammar": "9.4.0",
+    "cspell-io": "9.4.0",
+    "cspell-trie-lib": "9.4.0",
     "env-paths": "^3.0.0",
     "gensequence": "^8.0.8",
     "import-fresh": "^3.3.1",
@@ -91,14 +91,14 @@
     "node": ">=20"
   },
   "devDependencies": {
-    "@cspell/dict-cpp": "^6.0.14",
+    "@cspell/dict-cpp": "^6.0.15",
     "@cspell/dict-csharp": "^4.0.7",
     "@cspell/dict-css": "^4.0.18",
     "@cspell/dict-fa-ir": "^4.0.5",
     "@cspell/dict-fr-fr": "^2.3.2",
-    "@cspell/dict-html": "^4.0.12",
+    "@cspell/dict-html": "^4.0.13",
     "@cspell/dict-nl-nl": "^2.4.2",
-    "@cspell/dict-python": "^4.2.21",
+    "@cspell/dict-python": "^4.2.23",
     "@types/configstore": "^6.0.2",
     "comment-json": "^4.4.1",
     "configstore": "^7.1.0",
@@ -107,5 +107,5 @@
     "lorem-ipsum": "^2.0.8",
     "perf-insight": "^2.0.1"
   },
-  "gitHead": "3f8bf5c88cda393b581957b7f8efc696e432f6f1"
+  "gitHead": "12dba3d8b880384d1401c765cb2186647f5a266f"
 }