Merge pull request #169 from sasjs/allanbowe/vs-code-error-when-adding-168

chore: updating docs for ignoreList

.gitpod.yml

@@ -0,0 +1,8 @@
+# This configuration file was automatically generated by Gitpod.
+# Please adjust to your needs (see https://www.gitpod.io/docs/config-gitpod-file)
+# and commit this file to your remote git repository to share the goodness with others.
+
+tasks:
+  - init: npm install && npm run build
+
+

README.md

@@ -23,6 +23,10 @@ Configuration is via a `.sasjslint` file with the following structure (these are
     "hasDoxygenHeader": true,
     "hasMacroNameInMend": true,
     "hasMacroParentheses": true,
+    "ignoreList": [
+      "sajsbuild/",
+      "sasjsresults/"
+    ],
     "indentationMultiple": 2,
     "lowerCaseFileNames": true,
     "maxLineLength": 80,
@@ -60,6 +64,9 @@ As per the example [here](https://github.com/sasjs/lint/issues/20), macros defin
 * Default:  true
 * Severity: WARNING
 
+#### ignoreList
+There may be specific files (or folders) that are not good candidates for linting.  Simply list them in this array and they will be ignored.  In addition, any files in the project `.gitignore` file will also be ignored.
+
 #### indentationMultiple
 This will check each line to ensure that the count of leading spaces can be divided cleanly by this multiple.
 

sasjslint-schema.json

@@ -17,7 +17,11 @@
     "noTabIndentation": true,
     "noTrailingSpaces": true,
     "lineEndings": "lf",
-    "strictMacroDefinition": true
+    "strictMacroDefinition": true,
+    "ignoreList": [
+      "sajsbuild",
+      "sasjsresults"
+    ]
   },
   "examples": [
     {
@@ -33,7 +37,8 @@
       "noNestedMacros": true,
       "hasMacroParentheses": true,
       "lineEndings": "crlf",
-      "strictMacroDefinition": true
+      "strictMacroDefinition": true,
+      "ignoreList": ["sajsbuild", "sasjsresults"]
     }
   ],
   "properties": {
@@ -143,11 +148,11 @@
     },
     "ignoreList": {
       "$id": "#/properties/ignoreList",
-      "type": "object",
+      "type": "array",
       "title": "ignoreList",
       "description": "An array of paths or path patterns to ignore matching resources from linting. Files or folders matching patterns in .gitignore will always be ignored.",
       "default": ["sasjsbuild/", "sasjsresults/"],
-      "examples": ["sasjs/services", "appinit.sas"]
+      "examples": ["sasjs/tests", "tmp/scratch.sas"]
     }
   }
 }