cspell-lib 6.4.2 → 6.6.1-alpha.0

package/dist/Settings/configLoader.d.ts

@@ -15,8 +15,25 @@ export declare const defaultConfigFilenames: readonly string[];
  * @param pathToSettingsFile - path to the source file of the configuration settings.
  */
 declare function normalizeSettings(rawSettings: CSpellSettingsWST, pathToSettingsFile: string, pnpSettings: PnPSettings): 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 the current working directory)
+ *   - package `@cspell/dict-typescript/cspell-ext.json`
+ */
 export declare function readSettings(filename: string): CSpellSettingsI;
 export declare function readSettings(filename: string, defaultValues: CSpellSettingsWST): 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, relativeTo: string): CSpellSettingsI;
 export declare function readSettings(filename: string, relativeTo: string, defaultValues: CSpellSettingsWST): CSpellSettingsI;
 export declare function searchForConfig(searchFrom: string | undefined, pnpSettings?: PnPSettings): Promise<CSpellSettingsI | undefined>;

package/dist/Settings/configLoader.js

@@ -101,7 +101,12 @@ const cachedFiles = new Map();
  */
 function readConfig(fileRef) {
     // cspellConfigExplorerSync
-    const { filename } = fileRef;
+    const { filename, error } = fileRef;
+    if (error) {
+        fileRef.error =
+            error instanceof ImportError_1.ImportError ? error : new ImportError_1.ImportError(`Failed to read config file: "${filename}"`, error);
+        return { __importRef: fileRef };
+    }
     const s = {};
     try {
         const r = cspellConfigExplorerSync.load(filename);
@@ -191,9 +196,8 @@ function mergeSourceList(orig, append) {
 }
 function importSettings(fileRef, defaultValues, pnpSettings) {
     defaultValues = defaultValues ?? defaultSettings;
-    let { filename } = fileRef;
-    filename = path.resolve(filename);
-    const importRef = { ...fileRef, filename };
+    const { filename } = fileRef;
+    const importRef = { ...fileRef };
     const cached = cachedFiles.get(filename);
     if (cached) {
         const cachedImportRef = cached.__importRef || importRef;

package/dist/SpellingDictionary/SpellingDictionaryFromTrie.d.ts

@@ -14,6 +14,7 @@ export declare class SpellingDictionaryFromTrie implements SpellingDictionary {
     readonly type = "SpellingDictionaryFromTrie";
     readonly isDictionaryCaseSensitive: boolean;
     readonly containsNoSuggestWords: boolean;
+    readonly ignoreCharactersRegExp: RegExp | undefined;
     private weightMap;
     constructor(trie: Trie, name: string, options: SpellingDictionaryOptions, source?: string, size?: number);
     get size(): number;
@@ -22,6 +23,7 @@ export declare class SpellingDictionaryFromTrie implements SpellingDictionary {
     private resolveOptions;
     private _find;
     private findAnyForm;
+    private _findAnyForm;
     isNoSuggestWord(word: string, options?: HasOptions): boolean;
     isForbidden(word: string): boolean;
     suggest(word: string, numSuggestions?: number, compoundMethod?: CompoundWordsMethod, numChanges?: number, ignoreCase?: boolean): SuggestionResult[];

package/dist/SpellingDictionary/SpellingDictionaryFromTrie.js

@@ -6,6 +6,7 @@ const Settings_1 = require("../Settings");
 const Memorizer_1 = require("../util/Memorizer");
 const repMap_1 = require("../util/repMap");
 const util_1 = require("../util/util");
+const charset_1 = require("./charset");
 const SpellingDictionaryMethods_1 = require("./SpellingDictionaryMethods");
 class SpellingDictionaryFromTrie {
     constructor(trie, name, options, source = 'from trie', size) {
@@ -23,6 +24,7 @@ class SpellingDictionaryFromTrie {
         this.containsNoSuggestWords = options.noSuggest || false;
         this._size = size || 0;
         this.weightMap = options.weightMap || (0, SpellingDictionaryMethods_1.createWeightMapFromDictionaryInformation)(options.dictionaryInformation);
+        this.ignoreCharactersRegExp = (0, charset_1.charsetToRegExp)(this.options.dictionaryInformation?.ignore);
     }
     get size() {
         if (!this._size) {
@@ -60,6 +62,20 @@ class SpellingDictionaryFromTrie {
         return { useCompounds, ignoreCase };
     }
     findAnyForm(word, useCompounds, ignoreCase) {
+        const outerForms = new Set([word]);
+        if (this.ignoreCharactersRegExp) {
+            outerForms.add(word.replace(this.ignoreCharactersRegExp, ''));
+            outerForms.add(word.normalize('NFD').replace(this.ignoreCharactersRegExp, ''));
+            outerForms.add(word.normalize('NFC').replace(this.ignoreCharactersRegExp, ''));
+        }
+        for (const form of outerForms) {
+            const r = this._findAnyForm(form, useCompounds, ignoreCase);
+            if (r)
+                return r;
+        }
+        return undefined;
+    }
+    _findAnyForm(word, useCompounds, ignoreCase) {
         const mWord = this.mapWord(word.normalize('NFC'));
         const opts = { caseSensitive: !ignoreCase };
         const findResult = this.trie.findWord(mWord, opts);

package/dist/SpellingDictionary/charset.d.ts

@@ -0,0 +1,3 @@
+import { CharacterSet } from '@cspell/cspell-types';
+export declare function charsetToRegExp(charset: CharacterSet | undefined): RegExp | undefined;
+//# sourceMappingURL=charset.d.ts.map

package/dist/SpellingDictionary/charset.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.charsetToRegExp = void 0;
+function charsetToRegExp(charset) {
+    if (!charset)
+        return undefined;
+    try {
+        const reg = `[${charset.replace(/[\][\\]/g, '\\$&')}]`;
+        return new RegExp(reg, 'g');
+    }
+    catch (e) {
+        return undefined;
+    }
+}
+exports.charsetToRegExp = charsetToRegExp;
+//# sourceMappingURL=charset.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cspell-lib",
-  "version": "6.4.2",
+  "version": "6.6.1-alpha.0",
   "description": "A library of useful functions used across various cspell tools.",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -14,15 +14,15 @@
   ],
   "scripts": {
     "clean": "rimraf dist temp coverage .tsbuildinfo",
-    "build": "npm run compile && npm run build-api",
+    "build": "pnpm run compile && pnpm run build-api",
     "build-dev": "tsc -p tsconfig.dev.json",
     "build-api": "rollup -c api/rollup.config.mjs",
-    "clean-build": "npm run clean && npm run build",
+    "clean-build": "pnpm run clean && pnpm run build",
     "compile": "tsc -p .",
     "watch": "tsc --watch -p .",
     "coverage": "jest --coverage",
     "test-watch": "jest --watch",
-    "prepublishOnly": "npm run clean-build && npm test",
+    "prepublishOnly": "pnpm run clean-build",
     "test": "jest",
     "update-snapshot": "jest --updateSnapshot"
   },
@@ -48,17 +48,17 @@
   },
   "homepage": "https://github.com/streetsidesoftware/cspell#readme",
   "dependencies": {
-    "@cspell/cspell-bundled-dicts": "^6.4.2",
-    "@cspell/cspell-pipe": "^6.4.2",
-    "@cspell/cspell-types": "^6.4.2",
+    "@cspell/cspell-bundled-dicts": "^6.6.1-alpha.0",
+    "@cspell/cspell-pipe": "^6.6.1-alpha.0",
+    "@cspell/cspell-types": "^6.6.1-alpha.0",
     "clear-module": "^4.1.2",
     "comment-json": "^4.2.2",
     "configstore": "^5.0.1",
     "cosmiconfig": "^7.0.1",
-    "cspell-glob": "^6.4.2",
-    "cspell-grammar": "^6.4.2",
-    "cspell-io": "^6.4.2",
-    "cspell-trie-lib": "^6.4.2",
+    "cspell-glob": "^6.6.1-alpha.0",
+    "cspell-grammar": "^6.6.1-alpha.0",
+    "cspell-io": "^6.6.1-alpha.0",
+    "cspell-trie-lib": "^6.6.1-alpha.0",
     "fast-equals": "^4.0.1",
     "find-up": "^5.0.0",
     "fs-extra": "^10.1.0",
@@ -84,14 +84,14 @@
     "@types/configstore": "^5.0.1",
     "@types/fs-extra": "^9.0.13",
     "@types/jest": "^28.1.6",
-    "@types/node": "^18.6.1",
+    "@types/node": "^18.6.5",
     "cspell-dict-nl-nl": "^1.1.2",
     "jest": "^28.1.3",
     "lorem-ipsum": "^2.0.8",
     "rimraf": "^3.0.2",
-    "rollup": "^2.77.0",
+    "rollup": "^2.77.2",
     "rollup-plugin-dts": "^4.2.2",
     "ts-jest": "^28.0.7"
   },
-  "gitHead": "1f7481fd7d6a561de92ba49870da6eb1441a9d20"
+  "gitHead": "4c7eb0181563a4459da772fd736b252f07f020b9"
 }