cspell-lib 10.3.6 → 10.4.0-alpha.1

package/dist/index.d.ts

@@ -1,2 +1,4 @@
-export * from './lib/index.js';
+export type { CheckTextInfo, ConfigurationDependencies, CreateTextDocumentParams, CSpellConfigFile, DetermineFinalDocumentSettingsResult, DictionaryReferenceCollection, Document, DocumentValidatorOptions, ExcludeFilesGlobMap, ExclusionFunction, FeatureFlag, ICSpellConfigFile, ImportFileRefWithError, IncludeExcludeOptions, Logger, PerfTimer, SpellCheckFileOptions, SpellCheckFilePerf, SpellCheckFileResult, SpellingDictionary, SpellingDictionaryCollection, SuggestedWord, SuggestionCollector, SuggestionOptions, SuggestionResult, SuggestionsForWordResult, SuggestOptions, TextDocument, TextDocumentLine, TextDocumentRef, TextInfoItem, TraceOptions, TraceResult, TraceWordResult, ValidationIssue, VFileSystemProvider, VirtualFS, } from './lib/index.js';
+export { asyncIterableToArray, calcOverrideSettings, checkFilenameMatchesGlob, checkText, checkTextDocument, clearCachedFiles, clearCaches, combineTextAndLanguageSettings, CompoundWordsMethod, constructSettingsForText, createConfigLoader, createDictionaryReferenceCollection, createPerfTimer, createSpellingDictionary, createSpellingDictionaryCollection, createTextDocument, currentSettingsFileVersion, defaultConfigFilenames, defaultFileName, defaultSettingsFilename, determineFinalDocumentSettings, DocumentValidator, ENV_CSPELL_GLOB_ROOT, ExclusionHelper, extractDependencies, extractImportErrors, FeatureFlags, fileToDocument, fileToTextDocument, finalizeSettings, FSCapabilityFlags, getCachedFileSize, getDefaultBundledSettingsAsync, getDefaultConfigLoader, getDefaultSettings, getDictionary, getGlobalSettings, getGlobalSettingsAsync, getLanguageIdsForBaseFilename, getLanguagesForExt, getLogger, getSources, getSystemFeatureFlags, getVirtualFS, ImportError, IncludeExcludeFlag, isBinaryFile, isSpellingDictionaryLoadError, Link, loadConfig, loadPnP, mergeInDocSettings, mergeSettings, readConfigFile, readFile, readFileSync, readRawSettings, readSettings, readSettingsFiles, refreshDictionaryCache, resolveConfigFileImports, resolveFile, searchForConfig, sectionCSpell, setLogger, shouldCheckDocument, spellCheckDocument, spellCheckDocumentRPC, spellCheckFile, SpellingDictionaryLoadError, SuggestionError, suggestionsForWord, suggestionsForWords, Text, toCSpellSettingsWithOutSourceTrace, traceWords, traceWordsAsync, UnknownFeatureFlagError, updateTextDocument, validateText, writeToFile, writeToFileIterable, writeToFileIterableP, } from './lib/index.js';
+export * from '@cspell/cspell-types';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1,2 +1,3 @@
-export * from './lib/index.js';
+export { asyncIterableToArray, calcOverrideSettings, checkFilenameMatchesGlob, checkText, checkTextDocument, clearCachedFiles, clearCaches, combineTextAndLanguageSettings, CompoundWordsMethod, constructSettingsForText, createConfigLoader, createDictionaryReferenceCollection, createPerfTimer, createSpellingDictionary, createSpellingDictionaryCollection, createTextDocument, currentSettingsFileVersion, defaultConfigFilenames, defaultFileName, defaultSettingsFilename, determineFinalDocumentSettings, DocumentValidator, ENV_CSPELL_GLOB_ROOT, ExclusionHelper, extractDependencies, extractImportErrors, FeatureFlags, fileToDocument, fileToTextDocument, finalizeSettings, FSCapabilityFlags, getCachedFileSize, getDefaultBundledSettingsAsync, getDefaultConfigLoader, getDefaultSettings, getDictionary, getGlobalSettings, getGlobalSettingsAsync, getLanguageIdsForBaseFilename, getLanguagesForExt, getLogger, getSources, getSystemFeatureFlags, getVirtualFS, ImportError, IncludeExcludeFlag, isBinaryFile, isSpellingDictionaryLoadError, Link, loadConfig, loadPnP, mergeInDocSettings, mergeSettings, readConfigFile, readFile, readFileSync, readRawSettings, readSettings, readSettingsFiles, refreshDictionaryCache, resolveConfigFileImports, resolveFile, searchForConfig, sectionCSpell, setLogger, shouldCheckDocument, spellCheckDocument, spellCheckDocumentRPC, spellCheckFile, SpellingDictionaryLoadError, SuggestionError, suggestionsForWord, suggestionsForWords, Text, toCSpellSettingsWithOutSourceTrace, traceWords, traceWordsAsync, UnknownFeatureFlagError, updateTextDocument, validateText, writeToFile, writeToFileIterable, writeToFileIterableP, } from './lib/index.js';
+export * from '@cspell/cspell-types';
 //# sourceMappingURL=index.js.map

package/dist/lib/Document/resolveDocument.d.ts

@@ -1,10 +1,14 @@
+import type { TextEncoding } from 'cspell-io';
+import type { BufferEncoding } from '../Models/BufferEncoding.js';
 import type { TextDocument } from '../Models/TextDocument.js';
 import type { Document, DocumentWithText } from './Document.js';
+type DocumentEncoding = Extract<BufferEncoding, TextEncoding>;
 export declare function fileToDocument(file: string): Document;
 export declare function fileToDocument(file: string, text: string, languageId?: string, locale?: string): DocumentWithText;
 export declare function fileToDocument(file: string, text?: string, languageId?: string, locale?: string): Document | DocumentWithText;
 export declare function fileToTextDocument(file: string): Promise<TextDocument>;
 export declare function documentToTextDocument(document: DocumentWithText): TextDocument;
 export declare function resolveDocumentToTextDocument(doc: Document): Promise<TextDocument>;
-export declare function resolveDocument(document: DocumentWithText | Document, encoding?: BufferEncoding): Promise<DocumentWithText>;
+export declare function resolveDocument(document: DocumentWithText | Document, encoding?: DocumentEncoding): Promise<DocumentWithText>;
+export {};
 //# sourceMappingURL=resolveDocument.d.ts.map

package/dist/lib/Document/resolveDocument.js

@@ -1,4 +1,5 @@
 import { readFile } from 'node:fs/promises';
+import { readTextFile } from '../fileSystem.js';
 import { createTextDocument } from '../Models/TextDocument.js';
 import * as Uri from '../util/Uri.js';
 import { clean } from '../util/util.js';
@@ -33,11 +34,18 @@ export function resolveDocument(document, encoding) {
     if (isDocumentWithText(document))
         return Promise.resolve(document);
     const uri = Uri.toUri(document.uri);
-    if (uri.scheme !== 'file') {
+    if (uri.scheme === 'stdin') {
         throw new Error(`Unsupported schema: "${uri.scheme}", open "${uri.toString()}"`);
     }
+    if (uri.scheme !== 'file') {
+        return readDocumentFromUrl(document.uri, encoding);
+    }
     return readDocument(Uri.uriToFilePath(uri), encoding);
 }
+async function readDocumentFromUrl(uri, encoding = defaultEncoding) {
+    const text = await readTextFile(Uri.documentUriToURL(uri), encoding);
+    return { uri, text };
+}
 function isDocumentWithText(doc) {
     return doc.text !== undefined;
 }

package/dist/lib/Models/BufferEncoding.d.ts

@@ -0,0 +1,6 @@
+/**
+ * The text encodings Node.js supports, the same as its global `BufferEncoding`.
+ * Declared here so the published types do not need `@types/node`.
+ */
+export type BufferEncoding = 'ascii' | 'utf8' | 'utf-8' | 'utf16le' | 'utf-16le' | 'ucs2' | 'ucs-2' | 'base64' | 'base64url' | 'latin1' | 'binary' | 'hex';
+//# sourceMappingURL=BufferEncoding.d.ts.map

package/dist/lib/Models/BufferEncoding.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=BufferEncoding.js.map

package/dist/lib/SpellingDictionary/index.d.ts

@@ -1,4 +1,6 @@
-export * from './Dictionaries.js';
-export * from './SpellingDictionary.js';
-export * from './SpellingDictionaryError.js';
+export type { DictionaryNameFields } from './Dictionaries.js';
+export { getDictionaryInternal, getInlineConfigDictionaries, loadDictionaryDefs, mapSpecialDictionaryNamesToSettings, refreshDictionaryCache, specialDictionaryNames, } from './Dictionaries.js';
+export type { FindOptions, FindResult, HasOptions, SearchOptions, SpellingDictionary, SpellingDictionaryCollection, SpellingDictionaryOptions, SuggestionCollector, SuggestionResult, SuggestOptions, } from './SpellingDictionary.js';
+export { CompoundWordsMethod, createCollection, createInlineSpellingDictionary, createSpellingDictionary, } from './SpellingDictionary.js';
+export { isSpellingDictionaryLoadError, SpellingDictionaryLoadError } from './SpellingDictionaryError.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/lib/SpellingDictionary/index.js

@@ -1,4 +1,4 @@
-export * from './Dictionaries.js';
-export * from './SpellingDictionary.js';
-export * from './SpellingDictionaryError.js';
+export { getDictionaryInternal, getInlineConfigDictionaries, loadDictionaryDefs, mapSpecialDictionaryNamesToSettings, refreshDictionaryCache, specialDictionaryNames, } from './Dictionaries.js';
+export { CompoundWordsMethod, createCollection, createInlineSpellingDictionary, createSpellingDictionary, } from './SpellingDictionary.js';
+export { isSpellingDictionaryLoadError, SpellingDictionaryLoadError } from './SpellingDictionaryError.js';
 //# sourceMappingURL=index.js.map

package/dist/lib/spellCheckFile.d.ts

@@ -1,6 +1,7 @@
 import type { CSpellSettingsWithSourceTrace, CSpellUserSettings } from '@cspell/cspell-types';
 import type { ICSpellConfigFile } from 'cspell-config-lib';
 import type { Document, DocumentWithText } from './Document/index.js';
+import type { BufferEncoding } from './Models/BufferEncoding.js';
 import type { ValidationIssueRPC } from './Models/ValidationIssue.js';
 import type { ImportFileRefWithError } from './Settings/index.js';
 import type { Uri } from './util/IUri.js';

package/dist/rpc.d.ts

@@ -1,2 +1,47 @@
-export * from '@cspell/rpc';
+export type { 
+/** @deprecated Import from `@cspell/rpc` instead. */
+MessagePortLike, 
+/** @deprecated Import from `@cspell/rpc` instead. */
+NotifyEvent, 
+/** @deprecated Import from `@cspell/rpc` instead. */
+NotifyHandler, 
+/** @deprecated Import from `@cspell/rpc` instead. */
+NotifyOnceEvent, 
+/** @deprecated Import from `@cspell/rpc` instead. */
+RPCClientConfiguration, 
+/** @deprecated Import from `@cspell/rpc` instead. */
+RPCClientOptions, 
+/** @deprecated Import from `@cspell/rpc` instead. */
+RPCProtocol, 
+/** @deprecated Import from `@cspell/rpc` instead. */
+RPCProtocolMethods, 
+/** @deprecated Import from `@cspell/rpc` instead. */
+RPCServerConfiguration, 
+/** @deprecated Import from `@cspell/rpc` instead. */
+RPCServerOptions, } from '@cspell/rpc';
+export { 
+/** @deprecated Import from `@cspell/rpc` instead. */
+AbortRPCRequestError, 
+/** @deprecated Import from `@cspell/rpc` instead. */
+CanceledRPCRequestError, 
+/** @deprecated Import from `@cspell/rpc` instead. */
+NotifyEmitter, 
+/** @deprecated Import from `@cspell/rpc` instead. */
+notifyEventOnce, 
+/** @deprecated Import from `@cspell/rpc` instead. */
+notifyEventToPromise, 
+/** @deprecated Import from `@cspell/rpc` instead. */
+protocolDefinition, 
+/** @deprecated Import from `@cspell/rpc` instead. */
+protocolMethods, 
+/** @deprecated Import from `@cspell/rpc` instead. */
+RPCClient, 
+/** @deprecated Import from `@cspell/rpc` instead. */
+RPCRequestError, 
+/** @deprecated Import from `@cspell/rpc` instead. */
+RPCServer, 
+/** @deprecated Import from `@cspell/rpc` instead. */
+TimeoutRPCRequestError, 
+/** @deprecated Import from `@cspell/rpc` instead. */
+UnknownMethodRPCRequestError, } from '@cspell/rpc';
 //# sourceMappingURL=rpc.d.ts.map

package/dist/rpc.js

@@ -1,2 +1,26 @@
-export * from '@cspell/rpc';
+export { 
+/** @deprecated Import from `@cspell/rpc` instead. */
+AbortRPCRequestError, 
+/** @deprecated Import from `@cspell/rpc` instead. */
+CanceledRPCRequestError, 
+/** @deprecated Import from `@cspell/rpc` instead. */
+NotifyEmitter, 
+/** @deprecated Import from `@cspell/rpc` instead. */
+notifyEventOnce, 
+/** @deprecated Import from `@cspell/rpc` instead. */
+notifyEventToPromise, 
+/** @deprecated Import from `@cspell/rpc` instead. */
+protocolDefinition, 
+/** @deprecated Import from `@cspell/rpc` instead. */
+protocolMethods, 
+/** @deprecated Import from `@cspell/rpc` instead. */
+RPCClient, 
+/** @deprecated Import from `@cspell/rpc` instead. */
+RPCRequestError, 
+/** @deprecated Import from `@cspell/rpc` instead. */
+RPCServer, 
+/** @deprecated Import from `@cspell/rpc` instead. */
+TimeoutRPCRequestError, 
+/** @deprecated Import from `@cspell/rpc` instead. */
+UnknownMethodRPCRequestError, } from '@cspell/rpc';
 //# sourceMappingURL=rpc.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cspell-lib",
-  "version": "10.3.6",
+  "version": "10.4.0-alpha.1",
   "description": "A library of useful functions used across various cspell tools.",
   "publishConfig": {
     "access": "public",
@@ -75,41 +75,41 @@
     "watch": "tsc -p . --watch"
   },
   "dependencies": {
-    "@cspell/cspell-bundled-dicts": "10.3.6",
-    "@cspell/cspell-performance-monitor": "10.3.6",
-    "@cspell/cspell-pipe": "10.3.6",
-    "@cspell/cspell-resolver": "10.3.6",
-    "@cspell/cspell-types": "10.3.6",
-    "@cspell/dynamic-import": "10.3.6",
-    "@cspell/filetypes": "10.3.6",
-    "@cspell/rpc": "10.3.6",
-    "@cspell/strong-weak-map": "10.3.6",
-    "@cspell/url": "10.3.6",
-    "cspell-config-lib": "10.3.6",
-    "cspell-dictionary": "10.3.6",
-    "cspell-glob": "10.3.6",
-    "cspell-grammar": "10.3.6",
-    "cspell-io": "10.3.6",
-    "cspell-trie-lib": "10.3.6",
+    "@cspell/cspell-bundled-dicts": "10.4.0-alpha.1",
+    "@cspell/cspell-performance-monitor": "10.4.0-alpha.1",
+    "@cspell/cspell-pipe": "10.4.0-alpha.1",
+    "@cspell/cspell-resolver": "10.4.0-alpha.1",
+    "@cspell/cspell-types": "10.4.0-alpha.1",
+    "@cspell/dynamic-import": "10.4.0-alpha.1",
+    "@cspell/filetypes": "10.4.0-alpha.1",
+    "@cspell/rpc": "10.4.0-alpha.1",
+    "@cspell/strong-weak-map": "10.4.0-alpha.1",
+    "@cspell/url": "10.4.0-alpha.1",
+    "cspell-config-lib": "10.4.0-alpha.1",
+    "cspell-dictionary": "10.4.0-alpha.1",
+    "cspell-glob": "10.4.0-alpha.1",
+    "cspell-grammar": "10.4.0-alpha.1",
+    "cspell-io": "10.4.0-alpha.1",
+    "cspell-trie-lib": "10.4.0-alpha.1",
     "env-paths": "^4.0.0",
     "gensequence": "^8.0.8",
-    "import-fresh": "^4.0.0",
+    "import-fresh": "^4.0.1",
     "resolve-from": "^5.0.0",
-    "vscode-languageserver-textdocument": "^1.0.14",
+    "vscode-languageserver-textdocument": "^1.0.15",
     "vscode-uri": "^3.2.0",
     "xdg-basedir": "^5.1.0"
   },
   "devDependencies": {
-    "@cspell/dict-cpp": "^7.1.0",
+    "@cspell/dict-cpp": "^7.1.2",
     "@cspell/dict-csharp": "^4.0.8",
     "@cspell/dict-css": "^4.1.2",
-    "@cspell/dict-en_us": "^4.4.37",
+    "@cspell/dict-en_us": "^4.4.40",
     "@cspell/dict-fa-ir": "^4.0.5",
     "@cspell/dict-fr-fr": "^2.3.2",
     "@cspell/dict-html": "^4.0.16",
     "@cspell/dict-nl-nl": "^2.4.2",
-    "@cspell/dict-python": "^4.5.0",
-    "@cspell/dict-th-th": "^1.0.0",
+    "@cspell/dict-python": "^4.5.2",
+    "@cspell/dict-th-th": "^1.0.1",
     "@cspell/dictionary-bundler-plugin": "",
     "@types/configstore": "^6.0.2",
     "comment-json": "^5.0.0",
@@ -122,5 +122,5 @@
   "engines": {
     "node": ">=22.18.0"
   },
-  "gitHead": "8559198ccfcac2f745911db1ffe2ee62c17cba49"
+  "gitHead": "628768a6e62b792e628189b41e63e12e5d3d8fe3"
 }

package/dist/api.d.ts

@@ -1,2 +0,0 @@
-export * from './lib/index.js';
-//# sourceMappingURL=api.d.ts.map

package/dist/api.js

@@ -1,2 +0,0 @@
-export * from './lib/index.js';
-//# sourceMappingURL=api.js.map