cspell-lib 6.1.3 → 6.2.0

package/dist/Models/CSpellSettingsInternalDef.d.ts

@@ -1,12 +1,13 @@
-import { CSpellSettingsWithSourceTrace, DictionaryDefinitionAugmented, DictionaryDefinitionCustom, DictionaryDefinitionPreferred } from '@cspell/cspell-types';
+import { AdvancedCSpellSettingsWithSourceTrace, CSpellSettingsWithSourceTrace, DictionaryDefinitionAugmented, DictionaryDefinitionCustom, DictionaryDefinitionPreferred, Parser } from '@cspell/cspell-types';
 import { WeightMap } from 'cspell-trie-lib';
 import { OptionalOrUndefined } from '../util/types';
 export declare const SymbolCSpellSettingsInternal: unique symbol;
-export interface CSpellSettingsInternal extends Omit<CSpellSettingsWithSourceTrace, 'dictionaryDefinitions'> {
+export interface CSpellSettingsInternal extends Omit<AdvancedCSpellSettingsWithSourceTrace, 'dictionaryDefinitions'> {
     [SymbolCSpellSettingsInternal]: true;
     dictionaryDefinitions?: DictionaryDefinitionInternal[];
 }
 export interface CSpellSettingsInternalFinalized extends CSpellSettingsInternal {
+    parserFn: Parser | undefined;
     finalized: true;
     ignoreRegExpList: RegExp[];
     includeRegExpList: RegExp[];

package/dist/Settings/CSpellSettingsServer.d.ts

@@ -1,8 +1,8 @@
-import type { CSpellSettingsWithSourceTrace, Glob, ImportFileRef } from '@cspell/cspell-types';
+import type { AdvancedCSpellSettingsWithSourceTrace, Glob, ImportFileRef } from '@cspell/cspell-types';
 import { CSpellSettingsInternal, CSpellSettingsInternalFinalized } from '../Models/CSpellSettingsInternalDef';
 import { OptionalOrUndefined } from '../util/types';
-declare type CSpellSettingsWST = CSpellSettingsWithSourceTrace;
-declare type CSpellSettingsWSTO = OptionalOrUndefined<CSpellSettingsWithSourceTrace>;
+declare type CSpellSettingsWST = AdvancedCSpellSettingsWithSourceTrace;
+declare type CSpellSettingsWSTO = OptionalOrUndefined<AdvancedCSpellSettingsWithSourceTrace>;
 declare type CSpellSettingsI = CSpellSettingsInternal;
 export declare const configSettingsFileVersion0_1 = "0.1";
 export declare const configSettingsFileVersion0_2 = "0.2";

package/dist/Settings/CSpellSettingsServer.js

@@ -228,7 +228,7 @@ function _finalizeSettings(settings) {
         finalized: true,
         ignoreRegExpList: (0, patterns_1.resolvePatterns)(settings.ignoreRegExpList, settings.patterns),
         includeRegExpList: (0, patterns_1.resolvePatterns)(settings.includeRegExpList, settings.patterns),
-        parser: resolveParser(settings),
+        parserFn: resolveParser(settings),
     };
     finalized.name = 'Finalized ' + (finalized.name || '');
     finalized.source = { name: settings.name || 'src', sources: [settings] };

package/dist/Settings/DictionarySettings.js

@@ -50,14 +50,17 @@ function fixPath(def) {
     if (def instanceof _DictionaryDefinitionInternalWithSource) {
         return def;
     }
-    const { path: filePath = '', file = '' } = def;
-    const newPath = !filePath && !file ? '' : path.join(filePath, file);
+    const newPath = fixDicPath(def.path, def.file);
     return {
         ...def,
         file: undefined,
         path: newPath,
     };
 }
+function fixDicPath(defPath, defFile) {
+    const parts = [defPath || '', defFile || ''].filter((p) => !!p);
+    return parts.length > 1 ? path.join(...parts) : parts[0] || '';
+}
 function mapDictDefsToInternal(defs, pathToSettingsFile) {
     return defs?.map((def) => mapDictDefToInternal(def, pathToSettingsFile));
 }
@@ -103,7 +106,7 @@ class _DictionaryDefinitionInternalWithSource {
         const defAll = def;
         const { path: relPath = '', file = '', addWords, description, dictionaryInformation, type, repMap, noSuggest, scope, useCompounds, } = defAll;
         const defaultPath = path.dirname(__source);
-        const filePath = path.join(relPath, file);
+        const filePath = fixDicPath(relPath, file);
         const name = determineName(filePath, def);
         const r = (0, resolveFile_1.resolveFile)(filePath, defaultPath);
         const ddi = {

package/dist/SpellingDictionary/DictionaryLoader.d.ts

@@ -1,3 +1,4 @@
+import { Stats } from 'cspell-io';
 import { DictionaryDefinitionInternal } from '../Models/CSpellSettingsInternalDef';
 import { SpellingDictionary } from './SpellingDictionary';
 export declare type LoadOptions = DictionaryDefinitionInternal;
@@ -49,37 +50,6 @@ export declare const testing: {
     loadEntry: typeof loadEntry;
     load: typeof load;
 };
-/**
- * Copied from the Node definition to avoid a dependency upon a specific version of Node
- */
-interface StatsBase<T> {
-    isFile(): boolean;
-    isDirectory(): boolean;
-    isBlockDevice(): boolean;
-    isCharacterDevice(): boolean;
-    isSymbolicLink(): boolean;
-    isFIFO(): boolean;
-    isSocket(): boolean;
-    dev: T;
-    ino: T;
-    mode: T;
-    nlink: T;
-    uid: T;
-    gid: T;
-    rdev: T;
-    size: T;
-    blksize: T;
-    blocks: T;
-    atimeMs: T;
-    mtimeMs: T;
-    ctimeMs: T;
-    birthtimeMs: T;
-    atime: Date;
-    mtime: Date;
-    ctime: Date;
-    birthtime: Date;
-}
-export declare type Stats = StatsBase<number>;
 export declare const __testing__: {
     debugLog: string[];
 };

package/dist/SpellingDictionary/DictionaryLoader.js

@@ -24,11 +24,10 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.__testing__ = exports.testing = exports.refreshCacheEntries = exports.loadDictionarySync = exports.loadDictionary = void 0;
-const fs_1 = require("fs");
+const cspell_io_1 = require("cspell-io");
 const gensequence_1 = require("gensequence");
 const path = __importStar(require("path"));
 const util_1 = require("util");
-const errors_1 = require("../util/errors");
 const fileReader_1 = require("../util/fileReader");
 const createSpellingDictionary_1 = require("./createSpellingDictionary");
 const SpellingDictionaryError_1 = require("./SpellingDictionaryError");
@@ -120,7 +119,7 @@ async function refreshEntry(entry, maxAge, now) {
         // Write to the ts, so the next one will not do it.
         entry.sig = sig;
         entry.ts = now;
-        const pStat = getStat(entry.uri);
+        const pStat = (0, cspell_io_1.getStat)(entry.uri);
         const [newStat] = await Promise.all([pStat, entry.pending]);
         const hasChanged = !isEqual(newStat, entry.stat);
         const sigMatches = entry.sig === sig;
@@ -150,7 +149,7 @@ function isEqual(a, b) {
     if (isError(a)) {
         return isError(b) && a.message === b.message && a.name === b.name;
     }
-    return !isError(b) && (a.mtimeMs === b.mtimeMs || a.size === b.size);
+    return !isError(b) && a.mtimeMs === b.mtimeMs && a.size === b.size && a.eTag === b.eTag;
 }
 function isError(e) {
     const err = e;
@@ -158,7 +157,7 @@ function isError(e) {
 }
 function loadEntry(uri, options, now = Date.now()) {
     const pDictionary = load(uri, options).catch((e) => (0, createSpellingDictionary_1.createFailedToLoadDictionary)(new SpellingDictionaryError_1.SpellingDictionaryLoadError(uri, options, e, 'failed to load')));
-    const pStat = getStat(uri);
+    const pStat = (0, cspell_io_1.getStat)(uri);
     const pending = Promise.all([pDictionary, pStat]);
     const sig = now + Math.random();
     const entry = {
@@ -181,7 +180,7 @@ function loadEntry(uri, options, now = Date.now()) {
     return entry;
 }
 function loadEntrySync(uri, options, now = Date.now()) {
-    const stat = getStatSync(uri);
+    const stat = (0, cspell_io_1.getStatSync)(uri);
     const sig = now + Math.random();
     try {
         const dictionary = loadSync(uri, options);
@@ -289,24 +288,6 @@ exports.testing = {
     loadEntry,
     load,
 };
-function toError(e) {
-    if ((0, errors_1.isErrnoException)(e))
-        return e;
-    if (e instanceof Error)
-        return e;
-    return new Error((0, util_1.format)(e));
-}
-function getStat(uri) {
-    return fs_1.promises.stat(uri).catch((e) => toError(e));
-}
-function getStatSync(uri) {
-    try {
-        return (0, fs_1.statSync)(uri);
-    }
-    catch (e) {
-        return toError(e);
-    }
-}
 exports.__testing__ = {
     debugLog,
 };

package/dist/index.d.ts

@@ -4,7 +4,7 @@ import * as Link from './Settings/index.link';
 import { SpellingDictionaryCollection } from './SpellingDictionary';
 import * as Text from './util/text';
 export * from '@cspell/cspell-types';
-export * from 'cspell-io';
+export { asyncIterableToArray, readFile, readFileSync, writeToFile, writeToFileIterable, writeToFileIterableP, } from 'cspell-io';
 export { ExcludeFilesGlobMap, ExclusionFunction } from './exclusionHelper';
 export { getLanguagesForExt } from './LanguageIds';
 export { createTextDocument, updateTextDocument } from './Models/TextDocument';

package/dist/index.js

@@ -26,7 +26,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDictionary = exports.clearCachedFiles = exports.ExclusionHelper = exports.Link = exports.Text = exports.validateText = exports.IncludeExcludeFlag = exports.checkText = exports.resolveFile = exports.setLogger = exports.getLogger = exports.traceWordsAsync = exports.traceWords = exports.DocumentValidator = exports.suggestionsForWords = exports.suggestionsForWord = exports.SuggestionError = exports.SpellingDictionaryLoadError = exports.SpellingDictionaryCollection = exports.refreshDictionaryCache = exports.isSpellingDictionaryLoadError = exports.createSpellingDictionary = exports.CompoundWordsMethod = exports.spellCheckFile = exports.spellCheckDocument = exports.isBinaryFile = exports.fileToDocument = exports.determineFinalDocumentSettings = exports.constructSettingsForText = exports.combineTextAndLanguageSettings = exports.defaultSettingsFilename = exports.updateTextDocument = exports.createTextDocument = exports.getLanguagesForExt = void 0;
+exports.getDictionary = exports.clearCachedFiles = exports.ExclusionHelper = exports.Link = exports.Text = exports.validateText = exports.IncludeExcludeFlag = exports.checkText = exports.resolveFile = exports.setLogger = exports.getLogger = exports.traceWordsAsync = exports.traceWords = exports.DocumentValidator = exports.suggestionsForWords = exports.suggestionsForWord = exports.SuggestionError = exports.SpellingDictionaryLoadError = exports.SpellingDictionaryCollection = exports.refreshDictionaryCache = exports.isSpellingDictionaryLoadError = exports.createSpellingDictionary = exports.CompoundWordsMethod = exports.spellCheckFile = exports.spellCheckDocument = exports.isBinaryFile = exports.fileToDocument = exports.determineFinalDocumentSettings = exports.constructSettingsForText = exports.combineTextAndLanguageSettings = exports.defaultSettingsFilename = exports.updateTextDocument = exports.createTextDocument = exports.getLanguagesForExt = exports.writeToFileIterableP = exports.writeToFileIterable = exports.writeToFile = exports.readFileSync = exports.readFile = exports.asyncIterableToArray = void 0;
 const ExclusionHelper = __importStar(require("./exclusionHelper"));
 exports.ExclusionHelper = ExclusionHelper;
 const Settings_1 = require("./Settings");
@@ -37,7 +37,13 @@ const SpellingDictionary_1 = require("./SpellingDictionary");
 const Text = __importStar(require("./util/text"));
 exports.Text = Text;
 __exportStar(require("@cspell/cspell-types"), exports);
-__exportStar(require("cspell-io"), exports);
+var cspell_io_1 = require("cspell-io");
+Object.defineProperty(exports, "asyncIterableToArray", { enumerable: true, get: function () { return cspell_io_1.asyncIterableToArray; } });
+Object.defineProperty(exports, "readFile", { enumerable: true, get: function () { return cspell_io_1.readFile; } });
+Object.defineProperty(exports, "readFileSync", { enumerable: true, get: function () { return cspell_io_1.readFileSync; } });
+Object.defineProperty(exports, "writeToFile", { enumerable: true, get: function () { return cspell_io_1.writeToFile; } });
+Object.defineProperty(exports, "writeToFileIterable", { enumerable: true, get: function () { return cspell_io_1.writeToFileIterable; } });
+Object.defineProperty(exports, "writeToFileIterableP", { enumerable: true, get: function () { return cspell_io_1.writeToFileIterableP; } });
 var LanguageIds_1 = require("./LanguageIds");
 Object.defineProperty(exports, "getLanguagesForExt", { enumerable: true, get: function () { return LanguageIds_1.getLanguagesForExt; } });
 var TextDocument_1 = require("./Models/TextDocument");

package/dist/textValidation/docValidator.js

@@ -256,7 +256,7 @@ class DocumentValidator {
     }
     _parse() {
         (0, assert_1.default)(this._preparations, ERROR_NOT_PREPARED);
-        const parser = this._preparations.finalSettings.parser;
+        const parser = this._preparations.finalSettings.parserFn;
         if (typeof parser !== 'object')
             return this.defaultParser();
         return parser.parse(this.document.text, this.document.uri.path).parsedTexts;

package/dist/util/resolveFile.js

@@ -42,13 +42,14 @@ const testNodeModules = /^node_modules\//;
 function resolveFile(filename, relativeTo) {
     filename = filename.replace(/^~/, os.homedir());
     const steps = [
-        { filename: filename, fn: tryNodeResolve },
+        { filename, fn: tryUrl },
+        { filename, fn: tryNodeResolve },
         { filename: path.resolve(relativeTo, filename), fn: tryResolveExists },
         { filename: path.resolve(filename), fn: tryResolveExists },
-        { filename: filename, fn: tryNodeResolveDefaultPaths },
-        { filename: filename, fn: tryResolveFrom },
+        { filename, fn: tryNodeResolveDefaultPaths },
+        { filename, fn: tryResolveFrom },
         { filename: filename.replace(testNodeModules, ''), fn: tryResolveFrom },
-        { filename: filename, fn: tryResolveGlobal },
+        { filename, fn: tryResolveGlobal },
     ];
     for (const step of steps) {
         const r = step.fn(step.filename, relativeTo);
@@ -58,6 +59,23 @@ function resolveFile(filename, relativeTo) {
     return { filename: path.resolve(relativeTo, filename), relativeTo, found: false };
 }
 exports.resolveFile = resolveFile;
+const isUrlRegExp = /^\w+:\/\//i;
+/**
+ * Check to see if it is a URL.
+ * Note: URLs are absolute!
+ * @param filename - url string
+ * @returns ResolveFileResult
+ */
+function tryUrl(filename, relativeTo) {
+    if (isUrlRegExp.test(filename)) {
+        return { filename, relativeTo: undefined, found: true };
+    }
+    if (isUrlRegExp.test(relativeTo)) {
+        const url = new URL(filename, relativeTo);
+        return { filename: url.href, relativeTo, found: true };
+    }
+    return { filename, relativeTo: undefined, found: false };
+}
 function tryNodeResolveDefaultPaths(filename) {
     try {
         const r = require.resolve(filename);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cspell-lib",
-  "version": "6.1.3",
+  "version": "6.2.0",
   "description": "A library of useful functions used across various cspell tools.",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -48,16 +48,16 @@
   },
   "homepage": "https://github.com/streetsidesoftware/cspell#readme",
   "dependencies": {
-    "@cspell/cspell-bundled-dicts": "^6.1.3",
-    "@cspell/cspell-pipe": "^6.1.3",
-    "@cspell/cspell-types": "^6.1.3",
+    "@cspell/cspell-bundled-dicts": "^6.2.0",
+    "@cspell/cspell-pipe": "^6.2.0",
+    "@cspell/cspell-types": "^6.2.0",
     "clear-module": "^4.1.2",
     "comment-json": "^4.2.2",
     "configstore": "^5.0.1",
     "cosmiconfig": "^7.0.1",
-    "cspell-glob": "^6.1.3",
-    "cspell-io": "^6.1.3",
-    "cspell-trie-lib": "^6.1.3",
+    "cspell-glob": "^6.2.0",
+    "cspell-io": "^6.2.0",
+    "cspell-trie-lib": "^6.2.0",
     "fast-equals": "^4.0.1",
     "find-up": "^5.0.0",
     "fs-extra": "^10.1.0",
@@ -72,7 +72,7 @@
     "node": ">=14"
   },
   "devDependencies": {
-    "@cspell/dict-cpp": "^3.1.0",
+    "@cspell/dict-cpp": "^3.1.1",
     "@cspell/dict-csharp": "^3.0.1",
     "@cspell/dict-css": "^1.0.13",
     "@cspell/dict-fa-ir": "^2.0.0",
@@ -85,12 +85,12 @@
     "@types/jest": "^28.1.3",
     "@types/node": "^18.0.0",
     "cspell-dict-nl-nl": "^1.1.2",
-    "jest": "^28.1.1",
+    "jest": "^28.1.2",
     "lorem-ipsum": "^2.0.8",
     "rimraf": "^3.0.2",
     "rollup": "^2.75.7",
     "rollup-plugin-dts": "^4.2.2",
     "ts-jest": "^28.0.5"
   },
-  "gitHead": "e96b313542f2ec0a38ac04d1422d97e724ded3a6"
+  "gitHead": "ef9bf8e390692145b067843dbcc44a6dc2d9aa31"
 }