[#46] feat: add support for ignore files

willofindie · Jul 24, 2022 · 1696c73 · 1696c73
1 parent 8af1406
commit 1696c73
Show file tree

Hide file tree

Showing 7 changed files with 30 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -43,7 +43,8 @@ This Extension supports the following properties as of now:
 
 | **Setting**                   | **Description**                                              | **Type** | **Example**                                | **Default**                                             |
 |-------------------------------|--------------------------------------------------------------|----------|--------------------------------------------|---------------------------------------------------------|
-| `cssvar.files`                  | Relative/Absolute paths to CSS variable file sources      | string[] | ["src/**/*.css"]                           | [**/*.css]                                              |                                                                                                                                                                                                                                                            |
+| `cssvar.files`                  | Relative/Absolute paths to CSS variable file sources      | string[] | ["input.css"]                           | [**/*.css]                                              |                                                                                                                                                                                                                                                            |
+| `cssvar.files`                  | Relative/Absolute paths to file/folder sources to be ignored      | string[] | ["input.css"]                           | [**/*.css]                                              |                                                                                                                                                                                                                                                            |
 | `cssvar.extensions`             | File extensions for which IntelliSense will be enabled    | string[] | [<br>&nbsp;&nbsp;"css",<br>&nbsp;&nbsp;"scss",<br>&nbsp;&nbsp;"jsx"<br>] | [<br>&nbsp;&nbsp;"css",<br>&nbsp;&nbsp;"scss",<br>&nbsp;&nbsp;"tsx",<br>&nbsp;&nbsp;"jsx"<br>]  |
 | `cssvar.themes`<br>Helps to bucket CSS variables based on themes used in any project | CSS Theme classnames used in source files                 | string[] | [<br>&nbsp;&nbsp;"dark",<br>&nbsp;&nbsp;"dim"<br>]             | []                                                      |
 | `cssvar.excludeThemedVariables`<br>If true, hides duplicate theme variables from the list | Exclude themed variables to remove unnecessary duplicates | boolean  |                                            | false                                                   |
@@ -56,10 +57,6 @@ This Extension supports the following properties as of now:
 
 ## Screeshots:
 
-### How to Install
-![How to install](https://user-images.githubusercontent.com/11786283/113474149-bdc37380-948b-11eb-847d-4c031912b9f4.gif)
-
-
 ### Working Example
 ![Working Example](https://user-images.githubusercontent.com/11786283/112746381-07174d00-8fcc-11eb-82eb-d9b27540a956.gif)
 

diff --git a/examples/multi-root/multi-root.code-workspace b/examples/multi-root/multi-root.code-workspace
@@ -17,6 +17,7 @@
 			"proj-2": true,
 			"proj-3": true,
 		},
+		"cssvar.files": ["*.css"],
 		"cssvar.enableGotoDef": true
 	}
 }
diff --git a/examples/multi-root/proj-1/.vscode/settings.json b/examples/multi-root/proj-1/.vscode/settings.json
@@ -0,0 +1,3 @@
+{
+  "cssvar.ignore": ["broken.css"]
+}
diff --git a/examples/multi-root/proj-1/broken.css b/examples/multi-root/proj-1/broken.css
@@ -0,0 +1,3 @@
+:root {
+  --blue #333;
+}
diff --git a/package.json b/package.json
@@ -66,6 +66,21 @@
             ]
           ]
         },
+        "cssvar.ignore": {
+          "type": "array",
+          "default": [],
+          "items": {
+            "type": "string"
+          },
+          "markdownDescription": "Relative/Absolute paths to file/folder sources to ignore",
+          "scope": "resource",
+          "examples": [
+            [
+              "**/node_modules/**",
+              "styles/ignore.css"
+            ]
+          ]
+        },
         "cssvar.extensions": {
           "type": "array",
           "default": [],

diff --git a/src/constants.ts b/src/constants.ts
@@ -43,7 +43,8 @@ export type SupportedExtensionNames =
   | "javascriptreact";
 
 export interface Config {
-  files: string[] | Record<string, string[]>;
+  files: string[];
+  ignore: string[];
   extensions: SupportedExtensionNames[];
   themes: string[];
   postcssPlugins: string[];
@@ -56,6 +57,7 @@ export interface Config {
 
 export const DEFAULT_CONFIG: Config = {
   files: ["**/*.css"],
+  ignore: ["**/node_modules/**"],
   extensions: [...CSS_IDS],
   themes: [],
   postcssPlugins: [],

diff --git a/src/main.ts b/src/main.ts
@@ -64,8 +64,10 @@ export async function setup(): Promise<{
         switch (key) {
           case "files": {
             const value = getConfigValue(_config, key);
+            const ignoreList = getConfigValue(_config, "ignore");
             const entries = await fastGlob(<string[]>value, {
               cwd: resourcePath,
+              ignore: ignoreList,
             });
             config[fsPathKey][key] = entries.map((path: string) =>
               resolve(resourcePath, path)
@@ -76,7 +78,7 @@ export async function setup(): Promise<{
             const value = getConfigValue(_config, key);
             config[fsPathKey][key] = value.map(ext => {
               const _ext = ext.startsWith(".")
-                ? (ext.substr(1) as SupportedExtensionNames)
+                ? (ext.substring(1) as SupportedExtensionNames)
                 : ext;
               return mapShortToFullExtension(_ext);
             });