Merge branch 'master' of github.com:testthedocs/vscode-vale

Author: Chris Ward

README.md

@@ -26,29 +26,30 @@ Vale automatically checks a document when you open or save it.  Use the `Vale: L
 
 Vale always runs from the workspace directory in either case, so if you put a [Vale configuration][config] in the workspace directory it will automatically pick it up.
 
-This extension supports:
+This extension supports the following file extensions by default, but you can change them with the `vscode-vale.fileExtensions` config item (see below):
 
 -   **Asciidoc**: _.adoc_ and _.asciidoc_
 -   **Markdown**: _.md_ and _.markdown_
 -   **reStructuredText**: _.rst_
 -   **LaTeX**: _.tex_
 -   **plain text**: _.txt_
 
-[Open an issue][issue] or a pull request if you need support for **more document formats**, provided that [Vale][] supports them.
-
 [config]: https://errata-ai.github.io/vale/config/
 
 ## Configuration
 
-- `vscode-vale.path`: (default `vale`). Absolute path to the `vale` binary, useful if you don't want to use the global binary.
+-   `vscode-vale.path`: (default `vale`). Absolute path to the `vale` binary, useful if you don't want to use the global binary.
+
+**Example**
+
+```js
+{
+  // You can use ${workspaceFolder} it will be replaced by workspace folder path
+  "vscode-vale.path": "${workspaceFolder}/node_modules/.bin/vale"
 
-  **Example**
-  ```js
-  {
-    // You can use ${workspaceFolder} it will be replaced by workspace folder path
-    "vscode-vale.path": "${workspaceFolder}/node_modules/.bin/vale"
+  // or use some absolute path
+  "vscode-vale.path": "/some/path/to/vale"
+}
+```
 
-    // or use some absolute path
-    "vscode-vale.path": "/some/path/to/vale"
-  }
-  ```
+-   `vscode-vale.fileExtensions`: (default `md, markdown, txt, rst, tex, adoc, asciidoc`). File extensions to lint. Note, these also need to be in your Vale config file.

package.json

@@ -60,7 +60,24 @@
                     "type": "string",
                     "default": "vale",
                     "description": "Absolute path to Vale binary. Special var ${workspaceFolder} can be used in path (NOTE: in windows you can use '/' and can omit '.cmd' in path)"
-                }
+                },
+                "vscode-vale.fileExtensions": {
+                    "scope": "resource",
+                    "type": "array",
+                    "default": [
+                        "md",
+                        "markdown",
+                        "txt",
+                        "rst",
+                        "tex",
+                        "adoc",
+                        "asciidoc"
+                    ],
+                    "description": "File extensions to lint. Note, these also need to be in your Vale config file.",
+                    "items": {
+                        "type": "string"
+                    }
+                },
             }
         }
     },

src/extension.ts

@@ -357,15 +357,11 @@ const runValeOnWorkspace = async (): Promise<ValeDiagnostics> => {
     // Explicitly find all elligible files ourselves so that we respect
     // "files.exclude", ie, only look at files that are included in the
     // workspace.
-    const extensions: ReadonlyArray<string> = [
-        "md",
-        "markdown",
-        "txt",
-        "rst",
-        "tex",
-        "adoc",
-        "asciidoc",
-    ];
+
+    const extensions = workspace
+      .getConfiguration("vscode-vale")
+      .get<ReadonlyArray<string>>("fileExtensions")!;
+
     const pattern = `**/*.{${extensions.join(",")}}`;
     const uris = await workspace.findFiles(pattern);
     const results: ValeDiagnostics = new Map();