cspell-lib 8.8.0 → 8.8.1

package/dist/esm/Settings/CSpellSettingsServer.js

@@ -103,6 +103,7 @@ function _merge(left, right) {
         suggestWords: mergeWordsCached(_left.suggestWords, _right.suggestWords),
         enabledLanguageIds: replaceIfNotEmpty(_left.enabledLanguageIds, _right.enabledLanguageIds),
         enableFiletypes: mergeList(_left.enableFiletypes, _right.enableFiletypes),
+        enabledFileTypes: mergeObjects(_left.enabledFileTypes, _right.enabledFileTypes),
         ignoreRegExpList: mergeListUnique(_left.ignoreRegExpList, _right.ignoreRegExpList),
         patterns: mergeListUnique(_left.patterns, _right.patterns),
         dictionaryDefinitions: mergeListUnique(_left.dictionaryDefinitions, _right.dictionaryDefinitions),

package/dist/esm/Settings/GlobalSettings.js

@@ -1,59 +1,49 @@
 import { pathToFileURL } from 'node:url';
 import { CSpellConfigFileInMemory, CSpellConfigFileJson } from 'cspell-config-lib';
-import { isErrnoException } from '../util/errors.js';
-import { logError } from '../util/logger.js';
 import { getSourceDirectoryUrl, toFilePathOrHref } from '../util/url.js';
-import { ConfigStore } from './cfgStore.js';
+import { GlobalConfigStore } from './cfgStore.js';
 import { configToRawSettings } from './Controller/configLoader/configToRawSettings.js';
-const packageName = 'cspell';
+const globalConfig = new GlobalConfigStore();
 export async function getRawGlobalSettings() {
     return configToRawSettings(await getGlobalConfig());
 }
-export function getGlobalConfig() {
+export async function getGlobalConfig() {
     const name = 'CSpell Configstore';
     const configPath = getGlobalConfigPath();
-    const urlGlobal = configPath ? pathToFileURL(configPath) : new URL('global-config.json', getSourceDirectoryUrl());
+    let urlGlobal = configPath ? pathToFileURL(configPath) : new URL('global-config.json', getSourceDirectoryUrl());
     const source = {
         name,
         filename: toFilePathOrHref(urlGlobal),
     };
     const globalConf = { source };
     let hasGlobalConfig = false;
-    try {
-        const cfgStore = new ConfigStore(packageName);
-        const cfg = cfgStore.all;
+    const found = await globalConfig.readConfigFile();
+    if (found && found.config && found.filename) {
+        const cfg = found.config;
+        urlGlobal = pathToFileURL(found.filename);
         // Only populate globalConf is there are values.
         if (cfg && Object.keys(cfg).length) {
             Object.assign(globalConf, cfg);
             globalConf.source = {
                 name,
-                filename: cfgStore.path,
+                filename: found.filename,
             };
             hasGlobalConfig = Object.keys(cfg).length > 0;
         }
     }
-    catch (error) {
-        if (!isErrnoException(error) ||
-            !error.code ||
-            !['ENOENT', 'EACCES', 'ENOTDIR', 'EISDIR'].includes(error.code)) {
-            logError(error);
-        }
-    }
     const settings = { ...globalConf, name, source };
     const ConfigFile = hasGlobalConfig ? CSpellConfigFileJson : CSpellConfigFileInMemory;
-    return Promise.resolve(new ConfigFile(urlGlobal, settings));
+    return new ConfigFile(urlGlobal, settings);
 }
 export async function writeRawGlobalSettings(settings) {
     const toWrite = {
         import: settings.import,
     };
-    const cfgStore = new ConfigStore(packageName);
-    cfgStore.set(toWrite);
+    await globalConfig.writeConfigFile(toWrite);
 }
 export function getGlobalConfigPath() {
     try {
-        const cfgStore = new ConfigStore(packageName);
-        return cfgStore.path;
+        return globalConfig.location || GlobalConfigStore.defaultLocation;
     }
     catch {
         return undefined;

package/dist/esm/Settings/cfgStore.d.ts

@@ -1,4 +1,19 @@
-import ConfigStoreExport from 'configstore';
-export type ConfigStore = typeof ConfigStoreExport;
-export declare const ConfigStore: typeof ConfigStoreExport;
+import { CSpellSettings } from '@cspell/cspell-types';
+export declare const legacyLocationDir: string | undefined;
+export declare const cspellGlobalLocationDir: string;
+export declare const defaultConfigFileName = "cspell.json";
+interface GlobalConfigFile {
+    filename: string;
+    config: CSpellSettings;
+}
+export declare class GlobalConfigStore {
+    #private;
+    constructor(filename?: string);
+    readConfigFile(): Promise<GlobalConfigFile | undefined>;
+    writeConfigFile(cfg: CSpellSettings): Promise<string>;
+    get location(): string | undefined;
+    static create(): GlobalConfigStore;
+    static defaultLocation: string;
+}
+export {};
 //# sourceMappingURL=cfgStore.d.ts.map

package/dist/esm/Settings/cfgStore.js

@@ -1,3 +1,60 @@
-import ConfigStoreExport from 'configstore';
-export const ConfigStore = ConfigStoreExport;
+import fs from 'node:fs/promises';
+import path from 'node:path';
+import envPaths from 'env-paths';
+import { xdgConfig } from 'xdg-basedir';
+import { isDefined } from '../util/util.js';
+const packageName = 'cspell';
+export const legacyLocationDir = xdgConfig ? path.join(xdgConfig, 'configstore') : undefined;
+export const cspellGlobalLocationDir = envPaths(packageName, { suffix: '' }).config;
+export const defaultConfigFileName = 'cspell.json';
+const searchOrder = [cspellGlobalLocationDir, legacyLocationDir].filter(isDefined);
+export class GlobalConfigStore {
+    #foundLocation;
+    #baseFilename;
+    constructor(filename = defaultConfigFileName) {
+        this.#baseFilename = filename;
+    }
+    async #readConfigFile(location) {
+        try {
+            const json = await fs.readFile(location, 'utf8');
+            return { filename: location, config: JSON.parse(json) };
+        }
+        catch {
+            return undefined;
+        }
+    }
+    async readConfigFile() {
+        if (this.#foundLocation) {
+            const found = await this.#readConfigFile(this.#foundLocation);
+            if (found)
+                return found;
+        }
+        const firstFile = path.resolve(cspellGlobalLocationDir, this.#baseFilename);
+        const possibleLocations = new Set([
+            firstFile,
+            ...searchOrder.map((p) => path.resolve(p, defaultConfigFileName)),
+        ]);
+        for (const filename of possibleLocations) {
+            const found = await this.#readConfigFile(filename);
+            if (found) {
+                this.#foundLocation = found.filename;
+                return found;
+            }
+        }
+        return undefined;
+    }
+    async writeConfigFile(cfg) {
+        this.#foundLocation ??= path.join(cspellGlobalLocationDir, this.#baseFilename);
+        await fs.mkdir(path.dirname(this.#foundLocation), { recursive: true });
+        await fs.writeFile(this.#foundLocation, JSON.stringify(cfg, undefined, 2) + '\n');
+        return this.#foundLocation;
+    }
+    get location() {
+        return this.#foundLocation;
+    }
+    static create() {
+        return new this();
+    }
+    static defaultLocation = path.join(cspellGlobalLocationDir, defaultConfigFileName);
+}
 //# sourceMappingURL=cfgStore.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cspell-lib",
-  "version": "8.8.0",
+  "version": "8.8.1",
   "description": "A library of useful functions used across various cspell tools.",
   "type": "module",
   "sideEffects": false,
@@ -24,11 +24,11 @@
   "scripts": {
     "clean": "shx rm -rf dist temp coverage \"*.tsbuildInfo\"",
     "clean-build": "pnpm clean && pnpm build",
-    "build": "tsc -b . && pnpm run build:api",
+    "build": "tsc -b . -f && pnpm run build:api",
     "build:api": "rollup -c api/rollup.config.mjs",
-    "build:esm": "tsc -b tsconfig.esm.json",
-    "build:lib": "tsc -b src/lib/tsconfig.json",
-    "watch": "tsc -b . --watch",
+    "build:esm": "tsc -b tsconfig.esm.json -f",
+    "build:lib": "tsc -b src/lib/tsconfig.json -f",
+    "watch": "tsc -b . --watch -f",
     "coverage": "vitest run --coverage --pool=forks",
     "test-watch": "vitest",
     "prepublishOnly": "pnpm run clean-build",
@@ -59,27 +59,28 @@
   },
   "homepage": "https://github.com/streetsidesoftware/cspell#readme",
   "dependencies": {
-    "@cspell/cspell-bundled-dicts": "8.8.0",
-    "@cspell/cspell-pipe": "8.8.0",
-    "@cspell/cspell-resolver": "8.8.0",
-    "@cspell/cspell-types": "8.8.0",
-    "@cspell/dynamic-import": "8.8.0",
-    "@cspell/strong-weak-map": "8.8.0",
+    "@cspell/cspell-bundled-dicts": "8.8.1",
+    "@cspell/cspell-pipe": "8.8.1",
+    "@cspell/cspell-resolver": "8.8.1",
+    "@cspell/cspell-types": "8.8.1",
+    "@cspell/dynamic-import": "8.8.1",
+    "@cspell/strong-weak-map": "8.8.1",
     "clear-module": "^4.1.2",
     "comment-json": "^4.2.3",
-    "configstore": "^6.0.0",
-    "cspell-config-lib": "8.8.0",
-    "cspell-dictionary": "8.8.0",
-    "cspell-glob": "8.8.0",
-    "cspell-grammar": "8.8.0",
-    "cspell-io": "8.8.0",
-    "cspell-trie-lib": "8.8.0",
+    "cspell-config-lib": "8.8.1",
+    "cspell-dictionary": "8.8.1",
+    "cspell-glob": "8.8.1",
+    "cspell-grammar": "8.8.1",
+    "cspell-io": "8.8.1",
+    "cspell-trie-lib": "8.8.1",
+    "env-paths": "^3.0.0",
     "fast-equals": "^5.0.1",
     "gensequence": "^7.0.0",
     "import-fresh": "^3.3.0",
     "resolve-from": "^5.0.0",
     "vscode-languageserver-textdocument": "^1.0.11",
-    "vscode-uri": "^3.0.8"
+    "vscode-uri": "^3.0.8",
+    "xdg-basedir": "^5.1.0"
   },
   "engines": {
     "node": ">=18"
@@ -94,9 +95,10 @@
     "@cspell/dict-nl-nl": "^2.3.0",
     "@cspell/dict-python": "^4.1.11",
     "@types/configstore": "^6.0.2",
+    "configstore": "^6.0.0",
     "cspell-dict-nl-nl": "^1.1.2",
     "leaked-handles": "^5.2.0",
     "lorem-ipsum": "^2.0.8"
   },
-  "gitHead": "a42bce675c00cb2d51809b3ae3894119ea4f5ce7"
+  "gitHead": "6381846ffce8b9a349bfda03262297aa8e301ef5"
 }