fix: Performance - only serialize config if in debug mode (#2640)

* fix: Performance - only serialize config if in debug mode * remove unused comment-json
streetsidesoftware · Apr 1, 2022 · d16c4f9 · d16c4f9
1 parent 5f07225
commit d16c4f9
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 7 deletions.
diff --git a/packages/cspell-lib/src/Settings/DictionarySettings.ts b/packages/cspell-lib/src/Settings/DictionarySettings.ts
@@ -116,6 +116,8 @@ export function isDictionaryDefinitionInternal(
     return def instanceof _DictionaryDefinitionInternalWithSource;
 }
 
+type DDI = Omit<RequireOptional<DictionaryDefinitionInternalWithSource>, '__source' | 'weightMap' | 'toJSON'>;
+
 class _DictionaryDefinitionInternalWithSource implements DictionaryDefinitionInternalWithSource {
     private _weightMap: WeightMap | undefined;
     readonly name: string;
@@ -129,6 +131,7 @@ class _DictionaryDefinitionInternalWithSource implements DictionaryDefinitionInt
     readonly useCompounds?: boolean;
     readonly noSuggest?: boolean;
     readonly scope?: CustomDictionaryScope | CustomDictionaryScope[];
+    private ddi: DDI;
     constructor(def: DictionaryDefinition, readonly __source: string) {
         // this bit of assignment is to have the compiler help use if any new fields are added.
         const defAll: DictDef = def;
@@ -150,7 +153,7 @@ class _DictionaryDefinitionInternalWithSource implements DictionaryDefinitionInt
 
         const r = resolveFile(filePath, defaultPath);
 
-        const ddi: Omit<RequireOptional<DictionaryDefinitionInternalWithSource>, '__source' | 'weightMap'> = {
+        const ddi: DDI = {
             name,
             file: undefined,
             path: r.filename,
@@ -165,6 +168,7 @@ class _DictionaryDefinitionInternalWithSource implements DictionaryDefinitionInt
         };
 
         Object.assign(this, clean(ddi));
+        this.ddi = ddi;
         this.name = ddi.name;
         this.file = ddi.file;
         this.path = ddi.path;
@@ -176,4 +180,8 @@ class _DictionaryDefinitionInternalWithSource implements DictionaryDefinitionInt
     get weightMap() {
         return this._weightMap;
     }
+
+    toJSON() {
+        return this.ddi;
+    }
 }
diff --git a/packages/cspell/package-lock.json b/packages/cspell/package-lock.json
diff --git a/packages/cspell/package.json b/packages/cspell/package.json
@@ -73,7 +73,6 @@
     "@cspell/cspell-pipe": "^5.19.3",
     "chalk": "^4.1.2",
     "commander": "^9.1.0",
-    "comment-json": "^4.2.2",
     "cspell-gitignore": "^5.19.3",
     "cspell-glob": "^5.19.3",
     "cspell-lib": "^5.19.3",

diff --git a/packages/cspell/src/lint/lint.ts b/packages/cspell/src/lint/lint.ts
@@ -1,14 +1,13 @@
+import { isAsyncIterable, opFilter, pipeAsync, pipeSync } from '@cspell/cspell-pipe';
 import type { CSpellReporter, CSpellSettings, Glob, Issue, RunResult, TextDocumentOffset } from '@cspell/cspell-types';
 import { MessageTypes } from '@cspell/cspell-types';
-import * as commentJson from 'comment-json';
 import { findRepoRoot, GitIgnore } from 'cspell-gitignore';
 import { GlobMatcher, type GlobMatchOptions, type GlobPatternNormalized, type GlobPatternWithRoot } from 'cspell-glob';
 import type { Logger, ValidationIssue } from 'cspell-lib';
 import * as cspell from 'cspell-lib';
 import * as path from 'path';
 import { format } from 'util';
 import { URI } from 'vscode-uri';
-import { opFilter, isAsyncIterable, pipeAsync, pipeSync } from '@cspell/cspell-pipe';
 import type { CSpellLintResultCache } from '../util/cache';
 import { calcCacheSettings, createCache, CreateCacheSettings } from '../util/cache';
 import { CheckFailed, toApplicationError, toError } from '../util/errors';
@@ -100,8 +99,12 @@ export async function runLint(cfg: LintRequest): Promise<RunResult> {
 
         result.configErrors += await reportConfigurationErrors(config);
 
-        const debugCfg = { config: { ...config, source: null }, source: spellResult.localConfigFilepath };
-        reporter.debug(commentJson.stringify(debugCfg, undefined, 2));
+        if (cfg.options.debug) {
+            const { id: _id, name: _name, ...cfg } = config;
+            const debugCfg = { config: { ...cfg, source: null }, source: spellResult.localConfigFilepath };
+            reporter.debug(JSON.stringify(debugCfg, undefined, 2));
+        }
+
         const elapsed = result.elapsedTimeMs / 1000.0;
         const dictionaries = config.dictionaries || [];
         reporter.info(