cspell-lib 6.19.2 → 6.20.0

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

@@ -89,7 +89,21 @@ declare class ConfigLoaderInternal extends ConfigLoader {
     readonly _readConfig: (fileRef: ImportFileRef) => import("@cspell/cspell-types").CSpellSettingsWithSourceTrace;
     readonly _normalizeSettings: (rawSettings: import("@cspell/cspell-types").CSpellSettingsWithSourceTrace, pathToSettingsFile: string, pnpSettings: OptionalOrUndefined<PnPSettingsStrict>) => import("../../../Models/CSpellSettingsInternalDef").CSpellSettingsInternal;
 }
+/**
+ *
+ * @param searchFrom the directory / file to start searching from.
+ * @param pnpSettings - related to Using Yarn PNP.
+ * @returns the resulting settings
+ */
 export declare function searchForConfig(searchFrom: string | undefined, pnpSettings?: PnPSettings): Promise<CSpellSettingsI | undefined>;
+/**
+ *
+ * @param searchFrom the directory / file to start searching from.
+ * @param pnpSettings - related to Using Yarn PNP.
+ * @returns the resulting settings
+ * @deprecated
+ * @deprecationMessage Use `searchForConfig`. It is very difficult to support Sync files when settings include web requests.
+ */
 export declare function searchForConfigSync(searchFrom: string | undefined, pnpSettings?: PnPSettings): CSpellSettingsI | undefined;
 /**
  * Load a CSpell configuration files.

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

@@ -302,10 +302,24 @@ function normalizeSearchForConfigResult(searchPath, searchResult, pnpSettings) {
         error,
     };
 }
+/**
+ *
+ * @param searchFrom the directory / file to start searching from.
+ * @param pnpSettings - related to Using Yarn PNP.
+ * @returns the resulting settings
+ */
 function searchForConfig(searchFrom, pnpSettings = defaultPnPSettings) {
     return normalizeSearchForConfigResultAsync(searchFrom || process.cwd(), cspellConfigExplorer().search(searchFrom), pnpSettings).then((r) => (r.filepath ? r.config : undefined));
 }
 exports.searchForConfig = searchForConfig;
+/**
+ *
+ * @param searchFrom the directory / file to start searching from.
+ * @param pnpSettings - related to Using Yarn PNP.
+ * @returns the resulting settings
+ * @deprecated
+ * @deprecationMessage Use `searchForConfig`. It is very difficult to support Sync files when settings include web requests.
+ */
 function searchForConfigSync(searchFrom, pnpSettings = defaultPnPSettings) {
     let searchResult;
     try {

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

@@ -1,2 +1,2 @@
-export { type LoadOptions, DictionaryLoader } from './DictionaryLoader';
+export { DictionaryLoader, type LoadOptions } from './DictionaryLoader';
 //# sourceMappingURL=index.d.ts.map

package/dist/textValidation/docValidator.d.ts

@@ -40,6 +40,13 @@ export declare class DocumentValidator {
      */
     constructor(doc: TextDocument, options: DocumentValidatorOptions, settings: CSpellUserSettings);
     get ready(): boolean;
+    /**
+     * Prepare to validate a document.
+     * This will load all the necessary configuration and dictionaries.
+     *
+     * @deprecated
+     * @deprecationMessage Use the async `prepare` method.
+     */
     prepareSync(): void;
     prepare(): Promise<void>;
     private _prepareAsync;

package/dist/textValidation/docValidator.js

@@ -42,6 +42,13 @@ class DocumentValidator {
     get ready() {
         return this._ready;
     }
+    /**
+     * Prepare to validate a document.
+     * This will load all the necessary configuration and dictionaries.
+     *
+     * @deprecated
+     * @deprecationMessage Use the async `prepare` method.
+     */
     prepareSync() {
         // @todo
         // Determine doc settings.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cspell-lib",
-  "version": "6.19.2",
+  "version": "6.20.0",
   "description": "A library of useful functions used across various cspell tools.",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -48,19 +48,19 @@
   },
   "homepage": "https://github.com/streetsidesoftware/cspell#readme",
   "dependencies": {
-    "@cspell/cspell-bundled-dicts": "6.19.2",
-    "@cspell/cspell-pipe": "6.19.2",
-    "@cspell/cspell-types": "6.19.2",
-    "@cspell/strong-weak-map": "6.19.2",
+    "@cspell/cspell-bundled-dicts": "6.20.0",
+    "@cspell/cspell-pipe": "6.20.0",
+    "@cspell/cspell-types": "6.20.0",
+    "@cspell/strong-weak-map": "6.20.0",
     "clear-module": "^4.1.2",
     "comment-json": "^4.2.3",
     "configstore": "^5.0.1",
     "cosmiconfig": "^8.0.0",
-    "cspell-dictionary": "6.19.2",
-    "cspell-glob": "6.19.2",
-    "cspell-grammar": "6.19.2",
-    "cspell-io": "6.19.2",
-    "cspell-trie-lib": "6.19.2",
+    "cspell-dictionary": "6.20.0",
+    "cspell-glob": "6.20.0",
+    "cspell-grammar": "6.20.0",
+    "cspell-io": "6.20.0",
+    "cspell-trie-lib": "6.20.0",
     "fast-equals": "^4.0.3",
     "find-up": "^5.0.0",
     "gensequence": "^4.0.3",
@@ -78,19 +78,19 @@
     "@cspell/dict-csharp": "^4.0.2",
     "@cspell/dict-css": "^3.0.0",
     "@cspell/dict-fa-ir": "^2.0.0",
-    "@cspell/dict-fr-fr": "^2.1.2",
+    "@cspell/dict-fr-fr": "^2.2.0",
     "@cspell/dict-html": "^4.0.2",
     "@cspell/dict-nl-nl": "^2.2.8",
     "@cspell/dict-python": "^4.0.1",
     "@types/configstore": "^5.0.1",
-    "@types/jest": "^29.2.5",
+    "@types/jest": "^29.4.0",
     "@types/node": "^18.11.18",
     "cspell-dict-nl-nl": "^1.1.2",
-    "jest": "^29.3.1",
+    "jest": "^29.4.1",
     "lorem-ipsum": "^2.0.8",
-    "rollup": "^3.10.0",
+    "rollup": "^3.12.1",
     "rollup-plugin-dts": "^5.1.1",
     "ts-jest": "^29.0.5"
   },
-  "gitHead": "0413716934fdfde59971d24773e7df83623bb529"
+  "gitHead": "9de0bdd5b8da54daa72ccd6c328274bd796ada33"
 }