feat: Add support for .gitignore (#1823)

* dev: Move cspell definitions out of nested directory * dev: enable publishing of cspell-gitignore * dev: wire-up `.gitignore` Refactor each command into its own file.
streetsidesoftware · Oct 4, 2021 · 9b0dfe4 · 9b0dfe4
1 parent df6275c
commit 9b0dfe4
Show file tree

Hide file tree

Showing 20 changed files with 370 additions and 249 deletions.
diff --git a/cspell.json b/cspell.json
@@ -45,6 +45,7 @@
         "test-fixtures/**",
         "test-packages/test-cspell-tools/src/*.txt"
     ],
+    "useGitignore": true,
     "ignoreWords": [
         "commitcomment"
     ],

diff --git a/cspell.schema.json b/cspell.schema.json
@@ -770,6 +770,20 @@
       },
       "type": "array"
     },
+    "gitignoreRoot": {
+      "anyOf": [
+        {
+          "$ref": "#/definitions/FsPath"
+        },
+        {
+          "items": {
+            "$ref": "#/definitions/FsPath"
+          },
+          "type": "array"
+        }
+      ],
+      "description": "Tells the spell checker to searching for `.gitignore` files when it reaches a matching root."
+    },
     "globRoot": {
       "$ref": "#/definitions/FsPath",
       "description": "The root to use for glop patterns found in this configuration. Default: location of the configuration file.   For compatibility reasons, config files with version 0.1, the glob root will   default to be `${cwd}`.\n\nUse `globRoot` to define a different location. `globRoot` can be relative to the location of this configuration file. Defining globRoot, does not impact imported configurations.\n\nSpecial Values:\n- `${cwd}` - will be replaced with the current working directory.\n- `.` - will be the location of the containing configuration file."
@@ -921,6 +935,11 @@
       "description": "The maximum amount of time in milliseconds to generate suggestions for a word.",
       "type": "number"
     },
+    "useGitignore": {
+      "default": false,
+      "description": "Tells the spell checker to load `.gitignore` files and skip files that match the globs in the `.gitignore` files found.",
+      "type": "boolean"
+    },
     "usePnP": {
       "default": false,
       "description": "Packages managers like Yarn 2 use a `.pnp.cjs` file to assist in loading packages stored in the repository.\n\nWhen true, the spell checker will search up the directory structure for the existence of a PnP file and load it.",

diff --git a/packages/cspell-gitignore/package.json b/packages/cspell-gitignore/package.json
@@ -1,6 +1,5 @@
 {
   "name": "cspell-gitignore",
-  "private": true,
   "version": "5.11.1",
   "description": "Gitignore Glob matcher for cspell",
   "keywords": [

diff --git a/packages/cspell-types/cspell.schema.json b/packages/cspell-types/cspell.schema.json
@@ -770,6 +770,20 @@
       },
       "type": "array"
     },
+    "gitignoreRoot": {
+      "anyOf": [
+        {
+          "$ref": "#/definitions/FsPath"
+        },
+        {
+          "items": {
+            "$ref": "#/definitions/FsPath"
+          },
+          "type": "array"
+        }
+      ],
+      "description": "Tells the spell checker to searching for `.gitignore` files when it reaches a matching root."
+    },
     "globRoot": {
       "$ref": "#/definitions/FsPath",
       "description": "The root to use for glop patterns found in this configuration. Default: location of the configuration file.   For compatibility reasons, config files with version 0.1, the glob root will   default to be `${cwd}`.\n\nUse `globRoot` to define a different location. `globRoot` can be relative to the location of this configuration file. Defining globRoot, does not impact imported configurations.\n\nSpecial Values:\n- `${cwd}` - will be replaced with the current working directory.\n- `.` - will be the location of the containing configuration file."
@@ -921,6 +935,11 @@
       "description": "The maximum amount of time in milliseconds to generate suggestions for a word.",
       "type": "number"
     },
+    "useGitignore": {
+      "default": false,
+      "description": "Tells the spell checker to load `.gitignore` files and skip files that match the globs in the `.gitignore` files found.",
+      "type": "boolean"
+    },
     "usePnP": {
       "default": false,
       "description": "Packages managers like Yarn 2 use a `.pnp.cjs` file to assist in loading packages stored in the repository.\n\nWhen true, the spell checker will search up the directory structure for the existence of a PnP file and load it.",

diff --git a/packages/cspell-types/package.json b/packages/cspell-types/package.json
@@ -17,7 +17,7 @@
     "clean": "rimraf dist coverage .tsbuildinfo",
     "build": "npm run compile && npm run build-schema",
     "build-dev": "tsc -p tsconfig.dev.json",
-    "build-schema": "ts-json-schema-generator --no-top-ref --path src/settings/CSpellSettingsDef.ts --type CSpellSettings --validation-keywords markdownDescription  --validation-keywords scope --validation-keywords deprecated --validation-keywords deprecationMessage -o  ./cspell.schema.json && cp ./cspell.schema.json ../..",
+    "build-schema": "ts-json-schema-generator --no-top-ref --path src/CSpellSettingsDef.ts --type CSpellSettings --validation-keywords markdownDescription  --validation-keywords scope --validation-keywords deprecated --validation-keywords deprecationMessage -o  ./cspell.schema.json && cp ./cspell.schema.json ../..",
     "build-docs": "typedoc --out ../../docs/types/cspell-types src/index.ts",
     "clean-build": "npm run clean && npm run build",
     "compile": "tsc -p .",

diff --git a/...l-types/src/settings/CSpellSettingsDef.ts → ...ges/cspell-types/src/CSpellSettingsDef.ts b/...l-types/src/settings/CSpellSettingsDef.ts → ...ges/cspell-types/src/CSpellSettingsDef.ts
@@ -84,6 +84,17 @@ export interface FileSettings extends ExtendableSettings {
      * Custom reporters configuration
      */
     reporters?: ReporterSettings[];
+
+    /**
+     * Tells the spell checker to load `.gitignore` files and skip files that match the globs in the `.gitignore` files found.
+     * @default false
+     */
+    useGitignore?: boolean;
+
+    /**
+     * Tells the spell checker to searching for `.gitignore` files when it reaches a matching root.
+     */
+    gitignoreRoot?: FsPath | FsPath[];
 }
 
 export interface ExtendableSettings extends Settings {

diff --git a/packages/cspell-types/src/index.ts b/packages/cspell-types/src/index.ts
@@ -1,3 +1,3 @@
-export * from './settings';
+export * from './CSpellSettingsDef';
 export * from './CSpellReporter';
 export * from './TextOffset';
diff --git a/packages/cspell-types/src/settings/index.ts b/packages/cspell-types/src/settings/index.ts
diff --git a/packages/cspell/package.json b/packages/cspell/package.json
@@ -74,6 +74,7 @@
     "comment-json": "^4.1.1",
     "cspell-glob": "^5.11.1",
     "cspell-lib": "^5.11.1",
+    "cspell-gitignore": "^5.11.1",
     "fast-json-stable-stringify": "^2.1.0",
     "file-entry-cache": "^6.0.1",
     "fs-extra": "^10.0.0",

diff --git a/packages/cspell/samples/.cspell.json b/packages/cspell/samples/.cspell.json
@@ -14,12 +14,7 @@
     ],
     "maxNumberOfProblems": 10000,
     "ignorePaths": [
-        "forbidden-words.txt",
-        "dictionaries/**",
-        "node_modules/**",
-        "vscode-extension/**",
-        ".git/**",
-        ".vscode/**"
+        "forbidden-words.txt"
     ],
     // flagWords - list of words to be always considered incorrect
     // This is useful for offensive words and common spelling errors.

diff --git a/packages/cspell/samples/.gitignore b/packages/cspell/samples/.gitignore
@@ -0,0 +1,9 @@
+# Local globs to ignore
+
+ignore/**
+!ignore/keepme.md
+dictionaries/**
+node_modules/**
+vscode-extension/**
+.git/**
+.vscode/**
diff --git a/packages/cspell/samples/ignore/keepme.md b/packages/cspell/samples/ignore/keepme.md
diff --git a/packages/cspell/src/__snapshots__/app.test.ts.snap b/packages/cspell/src/__snapshots__/app.test.ts.snap
@@ -277,8 +277,6 @@ Array [
   "                               and French, or \\"en-GB\\" for British English.",
   "  --language-id <language>     Force programming language for unknown",
   "                               extensions. i.e. \\"php\\" or \\"scala\\"",
-  "  --languageId <language>      Force programming language for unknown",
-  "                               extensions. i.e. \\"php\\" or \\"scala\\"",
   "  --wordsOnly                  Only output the words not found in the",
   "                               dictionaries.",
   "  -u, --unique                 Only output the first instance of a word not",
@@ -296,15 +294,19 @@ Array [
   "  --relative                   Issues are displayed relative to root.",
   "  --show-context               Show the surrounding text around an issue.",
   "  --show-suggestions           Show spelling suggestions.",
-  "  --must-find-files            Error if no files are found (default: true)",
   "  --no-must-find-files         Do not error if no files are found",
   "  --legacy                     Legacy output",
-  "  --local <local>              Deprecated -- Use: --locale",
   "  --cache                      Only check changed files (default: false)",
   "  --cache-strategy <strategy>  Strategy to use for detecting changed files",
   "                               (choices: \\"metadata\\", \\"content\\")",
   "  --cache-location <path>      Path to the cache file or directory (default:",
   "                               \\".cspellcache\\")",
+  "  --gitignore                  Ignore files matching glob patterns found in",
+  "                               .gitignore files.",
+  "  --gitignore-root <path>      Prevent searching for .gitignore files past",
+  "                               root.",
+  "  --no-color                   Turn off color.",
+  "  --color                      Force color",
   "  -h, --help                   display help for command",
   "",
   "",