fix: Enable cli option --validate-directives (#3461)

* fix: Enable cli option `--validate-directives`
streetsidesoftware · Aug 21, 2022 · 52a5337 · 52a5337
1 parent 0adde68
commit 52a5337
Show file tree

Hide file tree

Showing 8 changed files with 23 additions and 3 deletions.
diff --git a/packages/cspell-lib/api/api.d.ts b/packages/cspell-lib/api/api.d.ts
@@ -647,6 +647,7 @@ declare class DocumentValidator {
      * The amount of time in ms to prepare for validation.
      */
     get prepTime(): number;
+    get validateDirectives(): boolean;
     checkText(range: SimpleRange, _text: string, scope: string[]): ValidationIssue[];
     check(parsedText: ParsedText): ValidationIssue[];
     /**

diff --git a/packages/cspell-lib/src/textValidation/docValidator.ts b/packages/cspell-lib/src/textValidation/docValidator.ts
@@ -216,6 +216,10 @@ export class DocumentValidator {
         return this._preparationTime;
     }
 
+    get validateDirectives(): boolean {
+        return this.options.validateDirectives ?? this._preparations?.config.validateDirectives ?? false;
+    }
+
     public checkText(range: SimpleRange, _text: string, scope: string[]): ValidationIssue[] {
         const text = this._document.text.slice(range[0], range[1]);
         return this.check({ text, range, scope: scope.join(' ') });
@@ -287,7 +291,7 @@ export class DocumentValidator {
         assert(this._ready);
         assert(this._preparations, ERROR_NOT_PREPARED);
 
-        const validateDirectives = forceCheck || this._preparations.config.validateDirectives;
+        const validateDirectives = forceCheck || this.validateDirectives;
         if (!validateDirectives) return [];
 
         const document = this.document;

diff --git a/packages/cspell/src/__snapshots__/app.test.ts.snap b/packages/cspell/src/__snapshots__/app.test.ts.snap
@@ -153,6 +153,8 @@ Array [
   "Options:",
   "  -c, --config <cspell.json>  Configuration file to use.  By default cspell",
   "                              looks for cspell.json in the current directory.",
+  "  --validate-directives       Validate in-document CSpell directives.",
+  "  --no-validate-directives    Do not validate in-document CSpell directives.",
   "  --no-color                  Turn off color.",
   "  --color                     Force color",
   "  --no-default-configuration  Do not load the default configuration and",
@@ -474,6 +476,8 @@ Array [
   "  --no-gitignore               Do NOT use .gitignore files.",
   "  --gitignore-root <path>      Prevent searching for .gitignore files past",
   "                               root.",
+  "  --validate-directives        Validate in-document CSpell directives.",
+  "  --no-validate-directives     Do not validate in-document CSpell directives.",
   "  --no-color                   Turn off color.",
   "  --color                      Force color.",
   "  --no-default-configuration   Do not load the default configuration and",

diff --git a/packages/cspell/src/application.ts b/packages/cspell/src/application.ts
@@ -48,10 +48,11 @@ export type CheckTextResult = CheckTextInfo;
 export async function checkText(filename: string, options: BaseOptions & LegacyOptions): Promise<CheckTextResult> {
     options = fixLegacy(options);
     const fileInfo = await readFileInfo(filename);
-    const { locale, languageId } = options;
+    const { locale, languageId, validateDirectives } = options;
     const doc = fileInfoToDocument(fileInfo, languageId, locale);
     const checkOptions = {
         configFile: options.config,
+        validateDirectives,
     };
     const settingsFromCommandLine = util.clean({
         languageId,

diff --git a/packages/cspell/src/commandCheck.ts b/packages/cspell/src/commandCheck.ts
@@ -15,6 +15,8 @@ export function commandCheck(prog: Command): Command {
             '-c, --config <cspell.json>',
             'Configuration file to use.  By default cspell looks for cspell.json in the current directory.'
         )
+        .option('--validate-directives', 'Validate in-document CSpell directives.')
+        .option('--no-validate-directives', 'Do not validate in-document CSpell directives.')
         .option('--no-color', 'Turn off color.')
         .option('--color', 'Force color')
         .addOption(

diff --git a/packages/cspell/src/commandLint.ts b/packages/cspell/src/commandLint.ts
@@ -95,6 +95,8 @@ export function commandLint(prog: Command): Command {
         .option('--gitignore', 'Ignore files matching glob patterns found in .gitignore files.')
         .option('--no-gitignore', 'Do NOT use .gitignore files.')
         .option('--gitignore-root <path>', 'Prevent searching for .gitignore files past root.', collect)
+        .option('--validate-directives', 'Validate in-document CSpell directives.')
+        .option('--no-validate-directives', 'Do not validate in-document CSpell directives.')
         .option('--no-color', 'Turn off color.')
         .option('--color', 'Force color.')
         .addOption(

diff --git a/packages/cspell/src/lint/lint.ts b/packages/cspell/src/lint/lint.ts
@@ -86,7 +86,8 @@ export async function runLint(cfg: LintRequest): Promise<RunResult> {
             MessageTypes.Info
         );
         try {
-            const validateOptions = { generateSuggestions: cfg.options.showSuggestions, numSuggestions: 5 };
+            const { showSuggestions: generateSuggestions, validateDirectives } = cfg.options;
+            const validateOptions = { generateSuggestions, numSuggestions: 5, validateDirectives };
             const r = await cspell.spellCheckDocument(doc, validateOptions, configInfo.config);
             spellResult = r;
             result.processed = r.checked;

diff --git a/packages/cspell/src/options.ts b/packages/cspell/src/options.ts
@@ -140,6 +140,11 @@ export interface BaseOptions {
      * @default true
      */
     defaultConfiguration?: boolean;
+
+    /**
+     * Check In-Document CSpell directives for correctness.
+     */
+    validateDirectives?: boolean;
 }
 
 export interface LinterCliOptions extends LinterOptions {