fix: change type to boolean for noGremlins

feat: add new rule 'noGremlins'

.all-contributorsrc

@@ -0,0 +1,113 @@
+{
+  "files": [
+    "README.md"
+  ],
+  "imageSize": 100,
+  "commit": false,
+  "contributors": [
+    {
+      "login": "Carus11",
+      "name": "Carus Kyle",
+      "avatar_url": "https://avatars.githubusercontent.com/u/4925828?v=4",
+      "profile": "https://github.com/Carus11",
+      "contributions": [
+        "ideas"
+      ]
+    },
+    {
+      "login": "allanbowe",
+      "name": "Allan Bowe",
+      "avatar_url": "https://avatars.githubusercontent.com/u/4420615?v=4",
+      "profile": "https://github.com/allanbowe",
+      "contributions": [
+        "code",
+        "test",
+        "review",
+        "video",
+        "doc"
+      ]
+    },
+    {
+      "login": "YuryShkoda",
+      "name": "Yury Shkoda",
+      "avatar_url": "https://avatars.githubusercontent.com/u/25773492?v=4",
+      "profile": "https://www.erudicat.com/",
+      "contributions": [
+        "code",
+        "test",
+        "projectManagement",
+        "video",
+        "doc"
+      ]
+    },
+    {
+      "login": "krishna-acondy",
+      "name": "Krishna Acondy",
+      "avatar_url": "https://avatars.githubusercontent.com/u/2980428?v=4",
+      "profile": "https://krishna-acondy.io/",
+      "contributions": [
+        "code",
+        "test",
+        "review",
+        "infra",
+        "platform",
+        "maintenance",
+        "content"
+      ]
+    },
+    {
+      "login": "saadjutt01",
+      "name": "Muhammad Saad ",
+      "avatar_url": "https://avatars.githubusercontent.com/u/8914650?v=4",
+      "profile": "https://github.com/saadjutt01",
+      "contributions": [
+        "code",
+        "test",
+        "review",
+        "mentoring",
+        "doc"
+      ]
+    },
+    {
+      "login": "sabhas",
+      "name": "Sabir Hassan",
+      "avatar_url": "https://avatars.githubusercontent.com/u/82647447?v=4",
+      "profile": "https://github.com/sabhas",
+      "contributions": [
+        "code",
+        "test",
+        "review",
+        "ideas"
+      ]
+    },
+    {
+      "login": "medjedovicm",
+      "name": "Mihajlo Medjedovic",
+      "avatar_url": "https://avatars.githubusercontent.com/u/18329105?v=4",
+      "profile": "https://github.com/medjedovicm",
+      "contributions": [
+        "code",
+        "test",
+        "review",
+        "infra"
+      ]
+    },
+    {
+      "login": "VladislavParhomchik",
+      "name": "Vladislav Parhomchik",
+      "avatar_url": "https://avatars.githubusercontent.com/u/83717836?v=4",
+      "profile": "https://github.com/VladislavParhomchik",
+      "contributions": [
+        "test",
+        "review"
+      ]
+    }
+  ],
+  "contributorsPerLine": 7,
+  "projectName": "lint",
+  "projectOwner": "sasjs",
+  "repoType": "github",
+  "repoHost": "https://github.com",
+  "skipCi": true,
+  "commitConvention": "none"
+}

.github/CONTRIBUTING.md

@@ -0,0 +1,54 @@
+# Contributing
+
+Contributions to `@sasjs/lint` are very welcome!
+Please fill in the pull request template and make sure that your code changes are adequately covered with tests when making a PR.
+
+## Architecture
+
+This project implements a number of rules for SAS projects and code. There are three types of rules:
+
+* File rules - rules applied at the file level
+* Line rules - rules applied to each line of a file 
+* Path rules - rules applied to paths and file names
+
+When implementing a new rule, place it in the appropriate folder for its type.
+Please also make sure to export it from the `index.ts` file in that folder.
+
+The file for each rule typically exports an object that conforms to the `LintRule` interface.
+This means it will have a `type`, `name`, `description` and `message` at a minimum.
+
+File, line and path lint rules also have a `test` property.
+This is a function that will run a piece of logic against the supplied item and produce an array of `Diagnostic` objects.
+These objects can be used in the consuming application to display the problems in the code.
+
+With some lint rules, we can also write logic that can automatically fix the issues found.
+These rules will also have a `fix` property, which is a function that takes the original content -
+either a line or the entire contents of a file, and returns the transformed content with the fix applied.
+
+## Testing
+
+Testing is one of the most important steps when developing a new lint rule.
+It helps us ensure that our lint rules do what they are intended to do.
+
+We use `jest` for testing, and since most of the code is based on pure functions, there is little mocking to do.
+This makes `@sasjs/lint` very easy to unit test, and so there is no excuse for not testing a new rule. :)
+
+When adding a new rule, please make sure that all positive and negative scenarios are tested in separate test cases.
+When modifying an existing rule, ensure that your changes haven't affected existing functionality by running the tests on your machine.
+
+You can run the tests using `npm test`.
+
+## Code Style
+
+This repository uses `Prettier` to ensure a uniform code style.
+If you are using VS Code for development, you can automatically fix your code to match the style as follows:
+
+- Install the `Prettier` extension for VS Code.
+- Open your `settings.json` file by choosing 'Preferences: Open Settings (JSON)' from the command palette.
+- Add the following items to the JSON.
+  ```
+    "editor.formatOnSave": true,
+    "editor.formatOnPaste": true,
+  ```
+
+If you are using another editor, or are unable to install the extension, you can run `npm run lint:fix` to fix the formatting after you've made your changes.

.github/dependabot.yml

@@ -1,7 +1,7 @@
 version: 2
 updates:
   - package-ecosystem: npm
-  directory: "/"
+    directory: '/'
     schedule:
-    interval: daily
+      interval: monthly
     open-pull-requests-limit: 10

.github/workflows/build.yml

@@ -13,14 +13,15 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [12.x]
+        node-version: [lts/*]
 
     steps:
       - uses: actions/checkout@v2
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v2
         with:
           node-version: ${{ matrix.node-version }}
+          cache: npm
       - name: Install Dependencies
         run: npm ci
       - name: Check Code Style

.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

@@ -1,14 +1,20 @@
-[![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=sasjs/lint)](https://dependabot.com)
+[![License](https://img.shields.io/apm/l/atomic-design-ui.svg)](/LICENSE)
+![GitHub top language](https://img.shields.io/github/languages/top/sasjs/lint)
+[![GitHub closed issues](https://img.shields.io/github/issues-closed-raw/sasjs/lint)](https://github.com/sasjs/lint/issues?q=is%3Aissue+is%3Aclosed)
+[![GitHub issues](https://img.shields.io/github/issues-raw/sasjs/lint)](https://github.com/sasjs/lint/issues)
+![total lines](https://tokei.rs/b1/github/sasjs/lint)
+[![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-908a85?logo=gitpod)](https://gitpod.io/#https://github.com/sasjs/lint)
 
 # SAS Code linting and formatting
 
 Our goal is to help SAS developers everywhere spend less time on code reviews, bug fixing and arguing about standards - and more time delivering extraordinary business value.
 
-## Linting
+# Linting
+
 @sasjs/lint is used by the following products:
 
-  * [@sasjs/vscode-extension](https://github.com/sasjs/vscode-extension) - just download SASjs in the VSCode marketplace, and select view/problems in the menu bar.
-  * [@sasjs/cli](https://cli.sasjs.io/lint) - run `sasjs lint` to get a list of all files with their problems, along with line and column indexes.
+- [@sasjs/vscode-extension](https://github.com/sasjs/vscode-extension) - just download SASjs in the VSCode marketplace, and select view/problems in the menu bar.
+- [@sasjs/cli](https://cli.sasjs.io/lint) - run `sasjs lint` to get a list of all files with their problems, along with line and column indexes.
 
 Configuration is via a `.sasjslint` file with the following structure (these are also the defaults if no .sasjslint file is found):
 
@@ -18,130 +24,231 @@ 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,
   "noNestedMacros": true,
+  "noGremlins": true,
   "noSpacesInFileNames": true,
-    "noTabIndentation": true,
-    "noTrailingSpaces": true
+  "noTabs": true,
+  "noTrailingSpaces": true,
+  "defaultHeader": "/**{lineEnding}  @file{lineEnding}  @brief <Your brief here>{lineEnding}  <h4> SAS Macros </h4>{lineEnding}**/"
 }
 ```
 
-### SAS Lint Settings
+## SAS Lint Settings
 
-#### noEncodedPasswords
+Each setting can have three states:
 
-This will highlight any rows that contain a `{sas00X}` type password, or `{sasenc}`.  These passwords (especially 001 and 002) are NOT secure, and should NEVER be pushed to source control or saved to the filesystem without special permissions applied.
+- OFF - usually by setting the value to `false` or 0. In this case, the rule won't be executed.
+- WARN - a warning is written to the log, but the return code will be 0
+- ERROR - an error is written to the log, and the return code is 1
 
-* Default:  true
-* Severity: ERROR
+For more details, and the default state, see the description of each rule below. It is also possible to change whether a rule returns ERROR or WARN using the `severityLevels` object.
+
+### defaultHeader
+
+This isn't actually a rule - but rather a formatting setting, which applies to SAS program that do NOT begin with `/**`. It can be triggered by running `sasjs lint fix` in the SASjs CLI, or by hitting "save" when using the SASjs VS Code extension (with "formatOnSave" in place)
+
+The default header is as follows:
+
+```sas
+/**
+  @file
+  @brief <Your brief here>
+  <h4> SAS Macros </h4>
+**/
+```
+
+If creating a new value, use `{lineEnding}` instead of `\n`, eg as follows:
+
+```json
+{
+  "defaultHeader": "/**{lineEnding}  @file{lineEnding}  @brief Our Company Brief{lineEnding}**/"
+}
+```
+
+### noEncodedPasswords
+
+This rule will highlight any rows that contain a `{sas00X}` type password, or `{sasenc}`. These passwords (especially 001 and 002) are NOT secure, and should NEVER be pushed to source control or saved to the filesystem without special permissions applied.
+
+- Default: true
+- Severity: ERROR
+
+### hasDoxygenHeader
 
-#### hasDoxygenHeader
 The SASjs framework recommends the use of Doxygen headers for describing all types of SAS program. This check will identify files where a doxygen header does not begin in the first line.
 
-* Default:  true
-* Severity: WARNING
+- Default: true
+- Severity: WARNING
+
+### hasMacroNameInMend
 
-#### hasMacroNameInMend
 The addition of the macro name in the `%mend` statement is optional, but can approve readability in large programs. A discussion on this topic can be found [here](https://www.linkedin.com/posts/allanbowe_sas-sasapps-sasjs-activity-6783413360781266945-1-7m). The default setting was the result of a poll with over 300 votes.
 
-* Default:  true
-* Severity: WARNING
+- Default: true
+- Severity: WARNING
+
+### hasMacroParentheses
 
-#### hasMacroParentheses
 As per the example [here](https://github.com/sasjs/lint/issues/20), macros defined without parentheses cause problems if that macro is ever extended (it's not possible to reliably extend that macro without potentially breaking some code that has used the macro). It's better to always define parentheses, even if they are not used. This check will also throw a warning if there are spaces between the macro name and the opening parenthesis.
 
-* Default:  true
-* Severity: WARNING
+- 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
 
-#### indentationMultiple
 This will check each line to ensure that the count of leading spaces can be divided cleanly by this multiple.
 
-* Default:  2
-* Severity: WARNING
+- Default: 2
+- Severity: WARNING
+
+### lowerCaseFileNames
 
-#### lowerCaseFileNames
 On *nix systems, it is imperative that autocall macros are in lowercase. When sharing code between windows and *nix systems, the difference in case sensitivity can also be a cause of lost developer time. For this reason, we recommend that sas filenames are always lowercase.
 
-* Default: true
-* Severity: WARNING
+- Default: true
+- Severity: WARNING
+
+### maxLineLength
 
-#### maxLineLength
 Code becomes far more readable when line lengths are short. The most compelling reason for short line lengths is to avoid the need to scroll when performing a side-by-side 'compare' between two files (eg as part of a GIT feature branch review). A longer discussion on optimal code line length can be found [here](https://stackoverflow.com/questions/578059/studies-on-optimal-code-width)
 
 In batch mode, long SAS code lines may also be truncated, causing hard-to-detect errors.
 
 We strongly recommend a line length limit, and set the bar at 80. To turn this feature off, set the value to 0.
 
-* Default: 80
-* Severity: WARNING
+- Default: 80
+- Severity: WARNING
+
+### noGremlins
+
+Capture zero-width whitespace and other non-standard characters.  The logic is borrowed from the [VSCode Gremlins Extension](https://github.com/nhoizey/vscode-gremlins) - if you are looking for more advanced gremlin zapping capabilities, we highly recommend to use their extension instead.
+
+The list of characters can be found in this file: [https://github.com/sasjs/lint/blob/main/src/rules/line/noGremlins.ts](https://github.com/sasjs/lint/blob/main/src/rules/line/noGremlins.ts)
+
+- Default: true
+- Severity: WARNING
+
+### noNestedMacros
 
-#### noNestedMacros
 Where macros are defined inside other macros, they are recompiled every time the outer macro is invoked. Hence, it is widely considered inefficient, and bad practice, to nest macro definitions.
 
-* Default:  true
-* Severity: WARNING
+- Default: true
+- Severity: WARNING
+
+### noSpacesInFileNames
 
-#### noSpacesInFileNames
 The 'beef' we have with spaces in filenames is twofold:
 
-* Loss of the in-built ability to 'click' a filepath and have the file open automatically
-* The need to quote such filepaths in order to use them in CLI commands
+- Loss of the in-built ability to 'click' a filepath and have the file open automatically
+- The need to quote such filepaths in order to use them in CLI commands
 
 In addition, when such files are used in URLs, they are often padded with a messy "%20" type quotation. And of course, for macros (where the macro should match the filename) then spaces are simply not valid.
 
-* Default:  true
-* Severity: WARNING
+- Default: true
+- Severity: WARNING
 
-#### noTabIndentation
-Whilst there are some arguments for using tabs to indent (such as the ability to set your own indentation width, and to reduce character count) there are many, many, many developers who think otherwise.  We're in that camp.  Sorry (not sorry).
+### noTabs
 
-* Default:  true
-* Severity: WARNING
+Whilst there are some arguments for using tabs (such as the ability to set your own indentation width, and to reduce character count) there are many, many, many developers who think otherwise. We're in that camp. Sorry (not sorry).
+
+- Alias: noTabIndentation
+- Default: true
+- Severity: WARNING
+
+### noTrailingSpaces
 
-#### noTrailingSpaces
 This will highlight lines with trailing spaces. Trailing spaces serve no useful purpose in a SAS program.
 
-* Default:  true
-* severity: WARNING
+- Default: true
+- severity: WARNING
 
-### Upcoming Linting Rules:
+## severityLevel
 
-* `noTabs` -> does what it says on the tin 
-* `noGremlins` -> identifies all invisible characters, other than spaces / tabs / line endings.  If you really need that bell character, use a hex literal!
-* `lineEndings` -> set a standard line ending, such as LF or CRLF
+This setting allows the default severity to be adjusted. This is helpful when running the lint in a pipeline or git hook. Simply list the rules you would like to adjust along with the desired setting ("warn" or "error"), eg as follows:
 
-## SAS Formatter
+```json
+{
+  "noTrailingSpaces": true,
+  "hasDoxygenHeader": true,
+  "maxLineLength": 100,
+  "severityLevel": {
+    "hasDoxygenHeader": "warn",
+    "maxLineLength": "error",
+    "noTrailingSpaces": "error"
+  }
+}
+```
+
+- "warn" - show warning in the log (doesn’t affect exit code)
+- "error" - show error in the log (exit code is 1 when triggered)
+
+## Upcoming Linting Rules:
+
+- `noGremlins` -> identifies all invisible characters, other than spaces / tabs / line endings. If you really need that bell character, use a hex literal!
+- `lineEndings` -> set a standard line ending, such as LF or CRLF
+
+# SAS Formatter
 
 A formatter will automatically apply rules when you hit SAVE, which can save a LOT of time.
 
 We've already implemented the following rules:
 
-* Add the macro name to the %mend statement 
-* Add a doxygen header template if none exists 
-* Remove trailing spaces
+- Add the macro name to the %mend statement
+- Add a doxygen header template if none exists
+- Remove trailing spaces
 
 We're looking to implement the following rules:
 
-* Change tabs to spaces 
-* zap gremlins
-* fix line endings
+- Change tabs to spaces
+- zap gremlins
+- fix line endings
 
 We are also investigating some harder stuff, such as automatic indentation and code layout
 
-## Sponsorship & Contributions
+# Sponsorship & Contributions
 
 SASjs is an open source framework! Contributions are welcomed. If you would like to see a feature, because it would be useful in your project, but you don't have the requisite (Typescript) experience - then how about you engage us on a short project and we build it for you?
 
 Contact [Allan Bowe](https://www.linkedin.com/in/allanbowe/) for further details.
 
-## SAS 9 Health check
+# Contributors ✨
 
-The SASjs Linter (and formatter) is a great way to de-risk and accelerate the delivery of SAS code into production environments.  However, code is just one part of a SAS estate.  If you are running SAS 9, you may be interested to know what 'gremlins' are lurking in your SAS 9 system.  Maybe you are preparing for a migration.  Maybe you are preparing to hand over the control of your environment.  Either way, an assessment of your existing system would put minds at rest and pro-actively identify trouble spots.
+<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
 
-The SAS 9 Health Check is a 'plug & play' product, that uses the [SAS 9 REST API](https://sas9api.io) to run hundreds of metadata and system checks to identify common problems.  The checks are non-invasive, and becuase it is a client app, there is NOTHING TO INSTALL on your SAS server.  We offer this assessment for a low fixed fee, and if you engage our (competitively priced) services to address the issues we highlight, then the assessment is free.
+[![All Contributors](https://img.shields.io/badge/all_contributors-8-orange.svg?style=flat-square)](#contributors-)
 
-Contact [Allan Bowe](https://www.linkedin.com/in/allanbowe/) for further details.
+<!-- ALL-CONTRIBUTORS-BADGE:END -->
 
+Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
 
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<table>
+  <tr>
+    <td align="center"><a href="https://github.com/Carus11"><img src="https://avatars.githubusercontent.com/u/4925828?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Carus Kyle</b></sub></a><br /><a href="#ideas-Carus11" title="Ideas, Planning, & Feedback">🤔</a></td>
+    <td align="center"><a href="https://github.com/allanbowe"><img src="https://avatars.githubusercontent.com/u/4420615?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Allan Bowe</b></sub></a><br /><a href="https://github.com/sasjs/lint/commits?author=allanbowe" title="Code">💻</a> <a href="https://github.com/sasjs/lint/commits?author=allanbowe" title="Tests">⚠️</a> <a href="https://github.com/sasjs/lint/pulls?q=is%3Apr+reviewed-by%3Aallanbowe" title="Reviewed Pull Requests">👀</a> <a href="#video-allanbowe" title="Videos">📹</a> <a href="https://github.com/sasjs/lint/commits?author=allanbowe" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://www.erudicat.com/"><img src="https://avatars.githubusercontent.com/u/25773492?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Yury Shkoda</b></sub></a><br /><a href="https://github.com/sasjs/lint/commits?author=YuryShkoda" title="Code">💻</a> <a href="https://github.com/sasjs/lint/commits?author=YuryShkoda" title="Tests">⚠️</a> <a href="#projectManagement-YuryShkoda" title="Project Management">📆</a> <a href="#video-YuryShkoda" title="Videos">📹</a> <a href="https://github.com/sasjs/lint/commits?author=YuryShkoda" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://krishna-acondy.io/"><img src="https://avatars.githubusercontent.com/u/2980428?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Krishna Acondy</b></sub></a><br /><a href="https://github.com/sasjs/lint/commits?author=krishna-acondy" title="Code">💻</a> <a href="https://github.com/sasjs/lint/commits?author=krishna-acondy" title="Tests">⚠️</a> <a href="https://github.com/sasjs/lint/pulls?q=is%3Apr+reviewed-by%3Akrishna-acondy" title="Reviewed Pull Requests">👀</a> <a href="#infra-krishna-acondy" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="#platform-krishna-acondy" title="Packaging/porting to new platform">📦</a> <a href="#maintenance-krishna-acondy" title="Maintenance">🚧</a> <a href="#content-krishna-acondy" title="Content">🖋</a></td>
+    <td align="center"><a href="https://github.com/saadjutt01"><img src="https://avatars.githubusercontent.com/u/8914650?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Muhammad Saad </b></sub></a><br /><a href="https://github.com/sasjs/lint/commits?author=saadjutt01" title="Code">💻</a> <a href="https://github.com/sasjs/lint/commits?author=saadjutt01" title="Tests">⚠️</a> <a href="https://github.com/sasjs/lint/pulls?q=is%3Apr+reviewed-by%3Asaadjutt01" title="Reviewed Pull Requests">👀</a> <a href="#mentoring-saadjutt01" title="Mentoring">🧑‍🏫</a> <a href="https://github.com/sasjs/lint/commits?author=saadjutt01" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://github.com/sabhas"><img src="https://avatars.githubusercontent.com/u/82647447?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Sabir Hassan</b></sub></a><br /><a href="https://github.com/sasjs/lint/commits?author=sabhas" title="Code">💻</a> <a href="https://github.com/sasjs/lint/commits?author=sabhas" title="Tests">⚠️</a> <a href="https://github.com/sasjs/lint/pulls?q=is%3Apr+reviewed-by%3Asabhas" title="Reviewed Pull Requests">👀</a> <a href="#ideas-sabhas" title="Ideas, Planning, & Feedback">🤔</a></td>
+    <td align="center"><a href="https://github.com/medjedovicm"><img src="https://avatars.githubusercontent.com/u/18329105?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Mihajlo Medjedovic</b></sub></a><br /><a href="https://github.com/sasjs/lint/commits?author=medjedovicm" title="Code">💻</a> <a href="https://github.com/sasjs/lint/commits?author=medjedovicm" title="Tests">⚠️</a> <a href="https://github.com/sasjs/lint/pulls?q=is%3Apr+reviewed-by%3Amedjedovicm" title="Reviewed Pull Requests">👀</a> <a href="#infra-medjedovicm" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a></td>
+  </tr>
+  <tr>
+    <td align="center"><a href="https://github.com/VladislavParhomchik"><img src="https://avatars.githubusercontent.com/u/83717836?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Vladislav Parhomchik</b></sub></a><br /><a href="https://github.com/sasjs/lint/commits?author=VladislavParhomchik" title="Tests">⚠️</a> <a href="https://github.com/sasjs/lint/pulls?q=is%3Apr+reviewed-by%3AVladislavParhomchik" title="Reviewed Pull Requests">👀</a></td>
+  </tr>
+</table>
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

checkNodeVersion.js

@@ -0,0 +1,16 @@
+const result = process.versions
+if (result && result.node) {
+  if (parseInt(result.node) < 14) {
+    console.log(
+      '\x1b[31m%s\x1b[0m',
+      `❌ Process failed due to Node Version,\nPlease install and use Node Version >= 14\nYour current Node Version is: ${result.node}`
+    )
+    process.exit(1)
+  }
+} else {
+  console.log(
+    '\x1b[31m%s\x1b[0m',
+    'Something went wrong while checking Node version'
+  )
+  process.exit(1)
+}

package.json

@@ -4,11 +4,13 @@
   "scripts": {
     "test": "jest --coverage",
     "build": "rimraf build && tsc",
+    "preinstall": "node checkNodeVersion",
+    "prebuild": "node checkNodeVersion",
     "prepublishOnly": "cp -r ./build/* . && rm -rf ./build && rm -rf ./src && rm tsconfig.json",
     "postpublish": "git clean -fd",
-    "package:lib": "npm run build && cp ./package.json build && cp README.md build && cd build && npm version \"5.0.0\" && npm pack",
-    "lint:fix": "npx prettier --write '{src,test}/**/*.{ts,tsx,js,jsx,html,css,sass,less,json,yml,md,graphql}'",
-    "lint": "npx prettier --check '{src,test}/**/*.{ts,tsx,js,jsx,html,css,sass,less,json,yml,md,graphql}'",
+    "package:lib": "npm run build && cp ./package.json ./checkNodeVersion.js build && cp README.md build && cd build && npm version \"5.0.0\" && npm pack",
+    "lint:fix": "npx prettier --write \"{src,test}/**/*.{ts,tsx,js,jsx,html,css,sass,less,json,yml,md,graphql}\"",
+    "lint": "npx prettier --check \"{src,test}/**/*.{ts,tsx,js,jsx,html,css,sass,less,json,yml,md,graphql}\"",
     "prepare": "git rev-parse --git-dir && git config core.hooksPath ./.git-hooks || true"
   },
   "publishConfig": {
@@ -39,12 +41,14 @@
   "devDependencies": {
     "@types/jest": "^26.0.23",
     "@types/node": "^15.12.2",
+    "all-contributors-cli": "^6.20.0",
     "jest": "^26.6.3",
     "rimraf": "^3.0.2",
     "ts-jest": "^26.5.6",
     "typescript": "^4.3.2"
   },
   "dependencies": {
-    "@sasjs/utils": "^2.19.0"
+    "@sasjs/utils": "^2.19.0",
+    "ignore": "^5.2.0"
   }
 }

sasjslint-schema.json

@@ -7,17 +7,20 @@
   "default": {
     "noEncodedPasswords": true,
     "hasDoxygenHeader": true,
+    "defaultHeader": "/**{lineEnding}  @file{lineEnding}  @brief <Your brief here>{lineEnding}  <h4> SAS Macros </h4>{lineEnding}**/",
     "hasMacroNameInMend": false,
     "hasMacroParentheses": true,
     "indentationMultiple": 2,
     "lowerCaseFileNames": true,
     "maxLineLength": 80,
+    "noGremlins": true,
     "noNestedMacros": true,
     "noSpacesInFileNames": true,
-    "noTabIndentation": true,
+    "noTabs": true,
     "noTrailingSpaces": true,
     "lineEndings": "lf",
-    "strictMacroDefinition": true
+    "strictMacroDefinition": true,
+    "ignoreList": ["sajsbuild", "sasjsresults"]
   },
   "examples": [
     {
@@ -27,13 +30,15 @@
       "noSpacesInFileNames": true,
       "lowerCaseFileNames": true,
       "maxLineLength": 80,
-      "noTabIndentation": true,
+      "noGremlins": true,
+      "noTabs": true,
       "indentationMultiple": 4,
       "hasMacroNameInMend": true,
       "noNestedMacros": true,
       "hasMacroParentheses": true,
       "lineEndings": "crlf",
-      "strictMacroDefinition": true
+      "strictMacroDefinition": true,
+      "ignoreList": ["sajsbuild", "sasjsresults"]
     }
   ],
   "properties": {
@@ -53,6 +58,22 @@
       "default": true,
       "examples": [true, false]
     },
+    "defaultHeader": {
+      "$id": "#/properties/defaultHeader",
+      "type": "string",
+      "title": "defaultHeader",
+      "description": "This sets the default program header - applies when a SAS program does NOT begin with `/**`.",
+      "default": "/**{lineEnding}  @file{lineEnding}  @brief <Your brief here>{lineEnding}  <h4> SAS Macros </h4>{lineEnding}**/",
+      "examples": []
+    },
+    "noGremlins": {
+      "$id": "#/properties/noGremlins",
+      "type": "boolean",
+      "title": "noGremlins",
+      "description": "Captures problematic characters such as zero-width whitespace and others that look valid but usually are not (such as the en dash)",
+      "default": [true],
+      "examples": [true, false]
+    },
     "hasMacroNameInMend": {
       "$id": "#/properties/hasMacroNameInMend",
       "type": "boolean",
@@ -109,11 +130,11 @@
       "default": true,
       "examples": [true, false]
     },
-    "noTabIndentation": {
-      "$id": "#/properties/noTabIndentation",
+    "noTabs": {
+      "$id": "#/properties/noTabs",
       "type": "boolean",
-      "title": "noTabIndentation",
-      "description": "Enforces no indentation using tabs. Shows a warning when a line starts with a tab.",
+      "title": "noTabs",
+      "description": "Enforces no indentation using tabs. Shows a warning when a line contains a tab.",
       "default": true,
       "examples": [true, false]
     },
@@ -140,6 +161,133 @@
       "description": "Enforces Macro Definition syntax. Shows a warning when incorrect syntax is used.",
       "default": true,
       "examples": [true, false]
+    },
+    "ignoreList": {
+      "$id": "#/properties/ignoreList",
+      "type": "array",
+      "title": "ignoreList",
+      "description": "An array of paths or path patterns to ignore when linting. Any files or matching patterns in the .gitignore file will also be ignored.",
+      "default": ["sasjsbuild/", "sasjsresults/"],
+      "examples": ["sasjs/tests", "tmp/scratch.sas"]
+    },
+    "severityLevel": {
+      "$id": "#/properties/severityLevel",
+      "type": "object",
+      "title": "severityLevel",
+      "description": "An object which specifies the severity level of each rule.",
+      "default": {},
+      "examples": [
+        {
+          "hasDoxygenHeader": "warn",
+          "maxLineLength": "warn",
+          "noTrailingSpaces": "error"
+        },
+        {
+          "hasDoxygenHeader": "warn",
+          "maxLineLength": "error",
+          "noTrailingSpaces": "error"
+        }
+      ],
+      "properties": {
+        "noEncodedPasswords": {
+          "$id": "#/properties/severityLevel/noEncodedPasswords",
+          "title": "noEncodedPasswords",
+          "type": "string",
+          "enum": ["error", "warn"],
+          "default": "error"
+        },
+        "hasDoxygenHeader": {
+          "$id": "#/properties/severityLevel/hasDoxygenHeader",
+          "title": "hasDoxygenHeader",
+          "type": "string",
+          "enum": ["error", "warn"],
+          "default": "warn"
+        },
+        "noGremlins": {
+          "$id": "#/properties/severityLevel/noGremlins",
+          "title": "noGremlins",
+          "type": "string",
+          "enum": ["error", "warn"],
+          "default": "warn"
+        },
+        "hasMacroNameInMend": {
+          "$id": "#/properties/severityLevel/hasMacroNameInMend",
+          "title": "hasMacroNameInMend",
+          "type": "string",
+          "enum": ["error", "warn"],
+          "default": "warn"
+        },
+        "hasMacroParentheses": {
+          "$id": "#/properties/severityLevel/hasMacroParentheses",
+          "title": "hasMacroParentheses",
+          "type": "string",
+          "enum": ["error", "warn"],
+          "default": "warn"
+        },
+        "indentationMultiple": {
+          "$id": "#/properties/severityLevel/indentationMultiple",
+          "title": "indentationMultiple",
+          "type": "string",
+          "enum": ["error", "warn"],
+          "default": "warn"
+        },
+        "lowerCaseFileNames": {
+          "$id": "#/properties/severityLevel/lowerCaseFileNames",
+          "title": "lowerCaseFileNames",
+          "type": "string",
+          "enum": ["error", "warn"],
+          "default": "warn"
+        },
+        "maxLineLength": {
+          "$id": "#/properties/severityLevel/maxLineLength",
+          "title": "maxLineLength",
+          "type": "string",
+          "enum": ["error", "warn"],
+          "default": "warn"
+        },
+        "noNestedMacros": {
+          "$id": "#/properties/severityLevel/noNestedMacros",
+          "title": "noNestedMacros",
+          "type": "string",
+          "enum": ["error", "warn"],
+          "default": "warn"
+        },
+        "noSpacesInFileNames": {
+          "$id": "#/properties/severityLevel/noSpacesInFileNames",
+          "title": "noSpacesInFileNames",
+          "type": "string",
+          "enum": ["error", "warn"],
+          "default": "warn"
+        },
+        "noTabs": {
+          "$id": "#/properties/severityLevel/noTabs",
+          "title": "noTabs",
+          "type": "string",
+          "enum": ["error", "warn"],
+          "default": "warn"
+        },
+        "noTrailingSpaces": {
+          "$id": "#/properties/severityLevel/noTrailingSpaces",
+          "title": "noTrailingSpaces",
+          "type": "string",
+          "enum": ["error", "warn"],
+          "default": "warn"
+        },
+        "lineEndings": {
+          "$id": "#/properties/severityLevel/lineEndings",
+          "title": "lineEndings",
+          "type": "string",
+          "enum": ["error", "warn"],
+          "default": "warn"
+        },
+        "strictMacroDefinition": {
+          "$id": "#/properties/severityLevel/strictMacroDefinition",
+          "title": "strictMacroDefinition",
+          "type": "string",
+          "enum": ["error", "warn"],
+          "default": "warn"
+        }
+      }
     }
   }
 }

src/format/formatText.ts

@@ -1,7 +1,8 @@
+import { LintConfig } from '../types'
 import { getLintConfig } from '../utils'
 import { processText } from './shared'
 
-export const formatText = async (text: string) => {
-  const config = await getLintConfig()
+export const formatText = async (text: string, configuration?: LintConfig) => {
+  const config = configuration || (await getLintConfig())
   return processText(text, config)
 }

src/format/shared.ts

@@ -19,7 +19,7 @@ const processContent = (config: LintConfig, content: string): string => {
   config.fileLintRules
     .filter((r) => !!r.fix)
     .forEach((rule) => {
-      processedContent = rule.fix!(processedContent)
+      processedContent = rule.fix!(processedContent, config)
     })
 
   return processedContent
@@ -30,7 +30,7 @@ export const processLine = (config: LintConfig, line: string): string => {
   config.lineLintRules
     .filter((r) => !!r.fix)
     .forEach((rule) => {
-      processedLine = rule.fix!(line)
+      processedLine = rule.fix!(line, config)
     })
 
   return processedLine

src/lint/lintFile.spec.ts

@@ -46,10 +46,10 @@ const expectedDiagnostics = [
     severity: Severity.Error
   },
   {
-    message: 'Line is indented with a tab',
+    message: 'Line contains a tab character (09x)',
     lineNumber: 7,
     startColumnNumber: 1,
-    endColumnNumber: 1,
+    endColumnNumber: 2,
     severity: Severity.Warning
   },
   {

src/lint/lintFile.ts

@@ -1,18 +1,20 @@
 import { readFile } from '@sasjs/utils/file'
-import { LintConfig } from '../types/LintConfig'
-import { getLintConfig } from '../utils/getLintConfig'
+import { Diagnostic, LintConfig } from '../types'
+import { getLintConfig, isIgnored } from '../utils'
 import { processFile, processText } from './shared'
 
 /**
  * Analyses and produces a set of diagnostics for the file at the given path.
  * @param {string} filePath - the path to the file to be linted.
  * @param {LintConfig} configuration - an optional configuration. When not passed in, this is read from the .sasjslint file.
- * @returns {Diagnostic[]} array of diagnostic objects, each containing a warning, line number and column number.
+ * @returns {Promise<Diagnostic[]>} array of diagnostic objects, each containing a warning, line number and column number.
  */
 export const lintFile = async (
   filePath: string,
   configuration?: LintConfig
-) => {
+): Promise<Diagnostic[]> => {
+  if (await isIgnored(filePath)) return []
+
   const config = configuration || (await getLintConfig())
   const text = await readFile(filePath)
 

src/lint/lintFolder.spec.ts

@@ -53,10 +53,10 @@ const expectedDiagnostics = [
     severity: Severity.Error
   },
   {
-    message: 'Line is indented with a tab',
+    message: 'Line contains a tab character (09x)',
     lineNumber: 7,
     startColumnNumber: 1,
-    endColumnNumber: 1,
+    endColumnNumber: 2,
     severity: Severity.Warning
   },
   {

src/lint/lintFolder.ts

@@ -1,10 +1,7 @@
 import { listSubFoldersInFolder } from '@sasjs/utils/file'
 import path from 'path'
-import { Diagnostic } from '../types/Diagnostic'
-import { LintConfig } from '../types/LintConfig'
-import { asyncForEach } from '../utils/asyncForEach'
-import { getLintConfig } from '../utils/getLintConfig'
-import { listSasFiles } from '../utils/listSasFiles'
+import { Diagnostic, LintConfig } from '../types'
+import { asyncForEach, getLintConfig, isIgnored, listSasFiles } from '../utils'
 import { lintFile } from './lintFile'
 
 const excludeFolders = [
@@ -28,6 +25,9 @@ export const lintFolder = async (
 ) => {
   const config = configuration || (await getLintConfig())
   let diagnostics: Map<string, Diagnostic[]> = new Map<string, Diagnostic[]>()
+
+  if (await isIgnored(folderPath)) return diagnostics
+
   const fileNames = await listSasFiles(folderPath)
   await asyncForEach(fileNames, async (fileName) => {
     const filePath = path.join(folderPath, fileName)
@@ -39,10 +39,8 @@ export const lintFolder = async (
   )
 
   await asyncForEach(subFolders, async (subFolder) => {
-    const subFolderDiagnostics = await lintFolder(
-      path.join(folderPath, subFolder),
-      config
-    )
+    const subFolderPath = path.join(folderPath, subFolder)
+    const subFolderDiagnostics = await lintFolder(subFolderPath, config)
     diagnostics = new Map([...diagnostics, ...subFolderDiagnostics])
   })
 

src/lint/lintProject.spec.ts

@@ -51,10 +51,10 @@ const expectedDiagnostics = [
     severity: Severity.Error
   },
   {
-    message: 'Line is indented with a tab',
+    message: 'Line contains a tab character (09x)',
     lineNumber: 7,
     startColumnNumber: 1,
-    endColumnNumber: 1,
+    endColumnNumber: 2,
     severity: Severity.Warning
   },
   {

src/lint/shared.ts

@@ -18,7 +18,7 @@ export const processFile = (
 ): Diagnostic[] => {
   const diagnostics: Diagnostic[] = []
   config.pathLintRules.forEach((rule) => {
-    diagnostics.push(...rule.test(filePath))
+    diagnostics.push(...rule.test(filePath, config))
   })
 
   return diagnostics
@@ -27,7 +27,7 @@ export const processFile = (
 const processContent = (config: LintConfig, content: string): Diagnostic[] => {
   const diagnostics: Diagnostic[] = []
   config.fileLintRules.forEach((rule) => {
-    diagnostics.push(...rule.test(content))
+    diagnostics.push(...rule.test(content, config))
   })
 
   return diagnostics

src/rules/file/hasDoxygenHeader.ts

@@ -3,8 +3,7 @@ import { LineEndings } from '../../types/LineEndings'
 import { FileLintRule } from '../../types/LintRule'
 import { LintRuleType } from '../../types/LintRuleType'
 import { Severity } from '../../types/Severity'
-
-const DoxygenHeader = `/**{lineEnding}  @file{lineEnding}  @brief <Your brief here>{lineEnding}  <h4> SAS Macros </h4>{lineEnding}**/`
+import { DefaultLintConfiguration } from '../../utils/getLintConfig'
 
 const name = 'hasDoxygenHeader'
 const description =
@@ -12,8 +11,11 @@ const description =
 const message = 'File missing Doxygen header'
 const messageForSingleAsterisk =
   'File not following Doxygen header style, use double asterisks'
+
 const test = (value: string, config?: LintConfig) => {
   const lineEnding = config?.lineEndings === LineEndings.CRLF ? '\r\n' : '\n'
+  const severity = config?.severityLevel[name] || Severity.Warning
+
   try {
     const hasFileHeader = value.trimStart().startsWith('/**')
     if (hasFileHeader) return []
@@ -28,7 +30,7 @@ const test = (value: string, config?: LintConfig) => {
               .length + 1,
           startColumnNumber: 1,
           endColumnNumber: 1,
-          severity: Severity.Warning
+          severity
         }
       ]
 
@@ -38,7 +40,7 @@ const test = (value: string, config?: LintConfig) => {
         lineNumber: 1,
         startColumnNumber: 1,
         endColumnNumber: 1,
-        severity: Severity.Warning
+        severity
       }
     ]
   } catch (e) {
@@ -48,7 +50,7 @@ const test = (value: string, config?: LintConfig) => {
         lineNumber: 1,
         startColumnNumber: 1,
         endColumnNumber: 1,
-        severity: Severity.Warning
+        severity
       }
     ]
   }
@@ -61,10 +63,11 @@ const fix = (value: string, config?: LintConfig): string => {
   } else if (result[0].message == messageForSingleAsterisk)
     return value.replace('/*', '/**')
 
+  config = config || new LintConfig(DefaultLintConfiguration)
   const lineEndingConfig = config?.lineEndings || LineEndings.LF
   const lineEnding = lineEndingConfig === LineEndings.LF ? '\n' : '\r\n'
 
-  return `${DoxygenHeader.replace(
+  return `${config?.defaultHeader.replace(
     /{lineEnding}/g,
     lineEnding
   )}${lineEnding}${value}`

src/rules/file/hasMacroNameInMend.ts

@@ -11,11 +11,14 @@ const name = 'hasMacroNameInMend'
 const description =
   'Enforces the presence of the macro name in each %mend statement.'
 const message = '%mend statement has missing or incorrect macro name'
+
 const test = (value: string, config?: LintConfig) => {
   const lineEnding = config?.lineEndings === LineEndings.CRLF ? '\r\n' : '\n'
   const lines: string[] = value ? value.split(lineEnding) : []
   const macros = parseMacros(value, config)
+  const severity = config?.severityLevel[name] || Severity.Warning
   const diagnostics: Diagnostic[] = []
+
   macros.forEach((macro) => {
     if (macro.startLineNumbers.length === 0 && macro.endLineNumber !== null) {
       const endLine = lines[macro.endLineNumber - 1]
@@ -25,7 +28,7 @@ const test = (value: string, config?: LintConfig) => {
         startColumnNumber: getColumnNumber(endLine, '%mend'),
         endColumnNumber:
           getColumnNumber(endLine, '%mend') + macro.termination.length,
-        severity: Severity.Warning
+        severity
       })
     } else if (
       macro.endLineNumber === null &&
@@ -36,7 +39,7 @@ const test = (value: string, config?: LintConfig) => {
         lineNumber: macro.startLineNumbers![0],
         startColumnNumber: 1,
         endColumnNumber: 1,
-        severity: Severity.Warning
+        severity
       })
     } else if (macro.mismatchedMendMacroName) {
       const endLine = lines[(macro.endLineNumber as number) - 1]
@@ -53,7 +56,7 @@ const test = (value: string, config?: LintConfig) => {
           getColumnNumber(endLine, macro.mismatchedMendMacroName) +
           macro.mismatchedMendMacroName.length -
           1,
-        severity: Severity.Warning
+        severity
       })
     } else if (!macro.hasMacroNameInMend) {
       const endLine = lines[(macro.endLineNumber as number) - 1]
@@ -62,7 +65,7 @@ const test = (value: string, config?: LintConfig) => {
         lineNumber: macro.endLineNumber as number,
         startColumnNumber: getColumnNumber(endLine, '%mend'),
         endColumnNumber: getColumnNumber(endLine, '%mend') + 6,
-        severity: Severity.Warning
+        severity
       })
     }
   })

src/rules/file/hasMacroParentheses.ts

@@ -9,9 +9,12 @@ import { LintConfig } from '../../types'
 const name = 'hasMacroParentheses'
 const description = 'Enforces the presence of parentheses in macro definitions.'
 const message = 'Macro definition missing parentheses'
+
 const test = (value: string, config?: LintConfig) => {
   const diagnostics: Diagnostic[] = []
   const macros = parseMacros(value, config)
+  const severity = config?.severityLevel[name] || Severity.Warning
+
   macros.forEach((macro) => {
     if (!macro.name) {
       diagnostics.push({
@@ -24,7 +27,7 @@ const test = (value: string, config?: LintConfig) => {
         endColumnNumber:
           getColumnNumber(macro.declarationLines![0], '%macro') +
           macro.declaration.length,
-        severity: Severity.Warning
+        severity
       })
     } else if (!macro.declarationLines.find((dl) => dl.includes('('))) {
       const macroNameLineIndex = macro.declarationLines.findIndex((dl) =>
@@ -44,7 +47,7 @@ const test = (value: string, config?: LintConfig) => {
           ) +
           macro.name.length -
           1,
-        severity: Severity.Warning
+        severity
       })
     }
   })

src/rules/file/lineEndings.ts

@@ -7,6 +7,7 @@ import { Severity } from '../../types/Severity'
 const name = 'lineEndings'
 const description = 'Ensures line endings conform to the configured type.'
 const message = 'Incorrect line ending - {actual} instead of {expected}'
+
 const test = (value: string, config?: LintConfig) => {
   const lineEndingConfig = config?.lineEndings || LineEndings.LF
   const expectedLineEnding =
@@ -18,8 +19,10 @@ const test = (value: string, config?: LintConfig) => {
     .replace(/\n/g, '{lf}')
     .split(new RegExp(`(?<=${expectedLineEnding})`))
   const diagnostics: Diagnostic[] = []
+  const severity = config?.severityLevel[name] || Severity.Warning
 
   let indexOffset = 0
+
   lines.forEach((line, index) => {
     if (line.endsWith(incorrectLineEnding)) {
       diagnostics.push({
@@ -29,7 +32,7 @@ const test = (value: string, config?: LintConfig) => {
         lineNumber: index + 1 + indexOffset,
         startColumnNumber: line.indexOf(incorrectLineEnding),
         endColumnNumber: line.indexOf(incorrectLineEnding) + 1,
-        severity: Severity.Warning
+        severity
       })
     } else {
       const splitLine = line.split(new RegExp(`(?<=${incorrectLineEnding})`))
@@ -51,7 +54,7 @@ const test = (value: string, config?: LintConfig) => {
             lineNumber: index + i + 1,
             startColumnNumber: l.indexOf(incorrectLineEnding),
             endColumnNumber: l.indexOf(incorrectLineEnding) + 1,
-            severity: Severity.Warning
+            severity
           })
         }
       })

src/rules/file/noNestedMacros.ts

@@ -10,11 +10,14 @@ import { LineEndings } from '../../types/LineEndings'
 const name = 'noNestedMacros'
 const description = 'Enfoces the absence of nested macro definitions.'
 const message = `Macro definition for '{macro}' present in macro '{parent}'`
+
 const test = (value: string, config?: LintConfig) => {
   const lineEnding = config?.lineEndings === LineEndings.CRLF ? '\r\n' : '\n'
   const lines: string[] = value ? value.split(lineEnding) : []
   const diagnostics: Diagnostic[] = []
   const macros = parseMacros(value, config)
+  const severity = config?.severityLevel[name] || Severity.Warning
+
   macros
     .filter((m) => !!m.parentMacro)
     .forEach((macro) => {
@@ -34,7 +37,7 @@ const test = (value: string, config?: LintConfig) => {
           ) +
           lines[(macro.startLineNumbers![0] as number) - 1].trim().length -
           1,
-        severity: Severity.Warning
+        severity
       })
     })
   return diagnostics

src/rules/file/strictMacroDefinition.ts

@@ -25,9 +25,11 @@ const validOptions = [
 const processParams = (
   content: string,
   macro: Macro,
-  diagnostics: Diagnostic[]
+  diagnostics: Diagnostic[],
+  config?: LintConfig
 ): string => {
   const declaration = macro.declaration
+  const severity = config?.severityLevel[name] || Severity.Warning
 
   const regExpParams = new RegExp(/(?<=\().*(?=\))/)
   const regExpParamsResult = regExpParams.exec(declaration)
@@ -88,7 +90,7 @@ const processParams = (
           lineNumber: paramLineNumber,
           startColumnNumber: paramStartIndex + 1,
           endColumnNumber: paramEndIndex,
-          severity: Severity.Warning
+          severity
         })
       }
     })
@@ -101,9 +103,11 @@ const processParams = (
 const processOptions = (
   _declaration: string,
   macro: Macro,
-  diagnostics: Diagnostic[]
+  diagnostics: Diagnostic[],
+  config?: LintConfig
 ): void => {
   let optionsPresent = _declaration.split('/')?.[1]?.trim()
+  const severity = config?.severityLevel[name] || Severity.Warning
 
   if (optionsPresent) {
     const regex = new RegExp(/="(.*?)"/, 'g')
@@ -136,7 +140,7 @@ const processOptions = (
             startColumnNumber: declarationLine.indexOf(trimmedOption) + 1,
             endColumnNumber:
               declarationLine.indexOf(trimmedOption) + trimmedOption.length,
-            severity: Severity.Warning
+            severity
           })
         }
       })
@@ -149,9 +153,9 @@ const test = (value: string, config?: LintConfig) => {
   const macros = parseMacros(value, config)
 
   macros.forEach((macro) => {
-    const _declaration = processParams(value, macro, diagnostics)
+    const _declaration = processParams(value, macro, diagnostics, config)
 
-    processOptions(_declaration, macro, diagnostics)
+    processOptions(_declaration, macro, diagnostics, config)
   })
 
   return diagnostics

src/rules/line/indentationMultiple.ts

@@ -6,9 +6,11 @@ import { Severity } from '../../types/Severity'
 const name = 'indentationMultiple'
 const description = 'Ensure indentation by a multiple of the configured number.'
 const message = 'Line has incorrect indentation'
+
 const test = (value: string, lineNumber: number, config?: LintConfig) => {
   if (!value.startsWith(' ')) return []
 
+  const severity = config?.severityLevel[name] || Severity.Warning
   const indentationMultiple = isNaN(config?.indentationMultiple as number)
     ? 2
     : config!.indentationMultiple
@@ -24,7 +26,7 @@ const test = (value: string, lineNumber: number, config?: LintConfig) => {
       lineNumber,
       startColumnNumber: 1,
       endColumnNumber: 1,
-      severity: Severity.Warning
+      severity
     }
   ]
 }

src/rules/line/index.ts

@@ -1,5 +1,6 @@
+export { noGremlins } from './noGremlins'
 export { indentationMultiple } from './indentationMultiple'
 export { maxLineLength } from './maxLineLength'
 export { noEncodedPasswords } from './noEncodedPasswords'
-export { noTabIndentation } from './noTabIndentation'
+export { noTabs } from './noTabs'
 export { noTrailingSpaces } from './noTrailingSpaces'

src/rules/line/maxLineLength.ts

@@ -6,7 +6,9 @@ import { Severity } from '../../types/Severity'
 const name = 'maxLineLength'
 const description = 'Restrict lines to the specified length.'
 const message = 'Line exceeds maximum length'
+
 const test = (value: string, lineNumber: number, config?: LintConfig) => {
+  const severity = config?.severityLevel[name] || Severity.Warning
   const maxLineLength = config?.maxLineLength || 80
   if (value.length <= maxLineLength) return []
   return [
@@ -15,7 +17,7 @@ const test = (value: string, lineNumber: number, config?: LintConfig) => {
       lineNumber,
       startColumnNumber: 1,
       endColumnNumber: 1,
-      severity: Severity.Warning
+      severity
     }
   ]
 }

src/rules/line/noEncodedPasswords.ts

@@ -1,3 +1,4 @@
+import { LintConfig } from '../../types'
 import { LineLintRule } from '../../types/LintRule'
 import { LintRuleType } from '../../types/LintRuleType'
 import { Severity } from '../../types/Severity'
@@ -5,7 +6,9 @@ import { Severity } from '../../types/Severity'
 const name = 'noEncodedPasswords'
 const description = 'Disallow encoded passwords in SAS code.'
 const message = 'Line contains encoded password'
-const test = (value: string, lineNumber: number) => {
+
+const test = (value: string, lineNumber: number, config?: LintConfig) => {
+  const severity = config?.severityLevel[name] || Severity.Error
   const regex = new RegExp(/{sas(\d{2,4}|enc)}[^;"'\s]*/, 'gi')
   const matches = value.match(regex)
   if (!matches || !matches.length) return []
@@ -14,7 +17,7 @@ const test = (value: string, lineNumber: number) => {
     lineNumber,
     startColumnNumber: value.indexOf(match) + 1,
     endColumnNumber: value.indexOf(match) + match.length + 1,
-    severity: Severity.Error
+    severity
   }))
 }
 

src/rules/line/noGremlins.spec.ts

@@ -0,0 +1,15 @@
+import { Severity } from '../../types/Severity'
+import { noGremlins } from './noGremlins'
+
+describe('noTabs', () => {
+  it('should return an empty array when the line does not have any gremlin', () => {
+    const line = "%put 'hello';"
+    expect(noGremlins.test(line, 1)).toEqual([])
+  })
+
+  it('should return a diagnostic array when the line contains gremlins', () => {
+    const line = "–  ‘ %put 'hello';"
+    const diagnostics = noGremlins.test(line, 1)
+    expect(diagnostics.length).toEqual(2)
+  })
+})

src/rules/line/noGremlins.ts

@@ -0,0 +1,128 @@
+import { Diagnostic, LintConfig } from '../../types'
+import { LineLintRule } from '../../types/LintRule'
+import { LintRuleType } from '../../types/LintRuleType'
+import { Severity } from '../../types/Severity'
+
+const name = 'noGremlins'
+const description = 'Disallow characters specified in gremlins array'
+const message = 'Line contains a gremlin'
+
+const test = (value: string, lineNumber: number, config?: LintConfig) => {
+  const severity = config?.severityLevel[name] || Severity.Warning
+
+  const diagnostics: Diagnostic[] = []
+
+  const gremlins: any = {}
+
+  for (const [hexCode, config] of Object.entries(gremlinCharacters)) {
+    gremlins[charFromHex(hexCode)] = Object.assign({}, config, {
+      hexCode
+    })
+  }
+
+  const regexpWithAllChars = new RegExp(
+    Object.keys(gremlins)
+      .map((char) => `${char}+`)
+      .join('|'),
+    'g'
+  )
+
+  let match
+  while ((match = regexpWithAllChars.exec(value))) {
+    const matchedCharacter = match[0][0]
+    const gremlin = gremlins[matchedCharacter]
+
+    diagnostics.push({
+      message: `${message}: ${gremlin.description}, hexCode(${gremlin.hexCode})`,
+      lineNumber,
+      startColumnNumber: match.index + 1,
+      endColumnNumber: match.index + 1 + match[0].length,
+      severity
+    })
+  }
+
+  return diagnostics
+}
+
+/**
+ * Lint rule that checks if a given line of text contains any gremlins.
+ */
+export const noGremlins: LineLintRule = {
+  type: LintRuleType.Line,
+  name,
+  description,
+  message,
+  test
+}
+
+const charFromHex = (hexCode: string) => String.fromCodePoint(parseInt(hexCode))
+
+const gremlinCharacters = {
+  '0x2013': {
+    description: 'en dash'
+  },
+  '0x2018': {
+    description: 'left single quotation mark'
+  },
+  '0x2019': {
+    description: 'right single quotation mark'
+  },
+  '0x2029': {
+    zeroWidth: true,
+    description: 'paragraph separator'
+  },
+  '0x2066': {
+    zeroWidth: true,
+    description: 'Left to right'
+  },
+  '0x2069': {
+    zeroWidth: true,
+    description: 'Pop directional'
+  },
+  '0x0003': {
+    description: 'end of text'
+  },
+  '0x000b': {
+    description: 'line tabulation'
+  },
+  '0x00a0': {
+    description: 'non breaking space'
+  },
+  '0x00ad': {
+    description: 'soft hyphen'
+  },
+  '0x200b': {
+    zeroWidth: true,
+    description: 'zero width space'
+  },
+  '0x200c': {
+    zeroWidth: true,
+    description: 'zero width non-joiner'
+  },
+  '0x200e': {
+    zeroWidth: true,
+    description: 'left-to-right mark'
+  },
+  '0x201c': {
+    description: 'left double quotation mark'
+  },
+  '0x201d': {
+    description: 'right double quotation mark'
+  },
+  '0x202c': {
+    zeroWidth: true,
+    description: 'pop directional formatting'
+  },
+  '0x202d': {
+    zeroWidth: true,
+    description: 'left-to-right override'
+  },
+  '0x202e': {
+    zeroWidth: true,
+    description: 'right-to-left override'
+  },
+  '0xfffc': {
+    zeroWidth: true,
+    description: 'object replacement character'
+  }
+}

src/rules/line/noTabIndentation.ts

@@ -1,30 +0,0 @@
-import { LineLintRule } from '../../types/LintRule'
-import { LintRuleType } from '../../types/LintRuleType'
-import { Severity } from '../../types/Severity'
-
-const name = 'noTabs'
-const description = 'Disallow indenting with tabs.'
-const message = 'Line is indented with a tab'
-const test = (value: string, lineNumber: number) => {
-  if (!value.startsWith('\t')) return []
-  return [
-    {
-      message,
-      lineNumber,
-      startColumnNumber: 1,
-      endColumnNumber: 1,
-      severity: Severity.Warning
-    }
-  ]
-}
-
-/**
- * Lint rule that checks if a given line of text is indented with a tab.
- */
-export const noTabIndentation: LineLintRule = {
-  type: LintRuleType.Line,
-  name,
-  description,
-  message,
-  test
-}

src/rules/line/noTabs.spec.ts

@@ -1,20 +1,20 @@
 import { Severity } from '../../types/Severity'
-import { noTabIndentation } from './noTabIndentation'
+import { noTabs } from './noTabs'
 
 describe('noTabs', () => {
   it('should return an empty array when the line is not indented with a tab', () => {
     const line = "%put 'hello';"
-    expect(noTabIndentation.test(line, 1)).toEqual([])
+    expect(noTabs.test(line, 1)).toEqual([])
   })
 
   it('should return an array with a single diagnostic when the line is indented with a tab', () => {
     const line = "\t%put 'hello';"
-    expect(noTabIndentation.test(line, 1)).toEqual([
+    expect(noTabs.test(line, 1)).toEqual([
       {
-        message: 'Line is indented with a tab',
+        message: 'Line contains a tab character (09x)',
         lineNumber: 1,
         startColumnNumber: 1,
-        endColumnNumber: 1,
+        endColumnNumber: 2,
         severity: Severity.Warning
       }
     ])

src/rules/line/noTabs.ts

@@ -0,0 +1,38 @@
+import { LintConfig } from '../../types'
+import { LineLintRule } from '../../types/LintRule'
+import { LintRuleType } from '../../types/LintRuleType'
+import { Severity } from '../../types/Severity'
+import { getIndicesOf } from '../../utils'
+
+const name = 'noTabs'
+const alias = 'noTabIndentation'
+const description = 'Disallow indenting with tabs.'
+const message = 'Line contains a tab character (09x)'
+
+const test = (value: string, lineNumber: number, config?: LintConfig) => {
+  const severity =
+    config?.severityLevel[name] ||
+    config?.severityLevel[alias] ||
+    Severity.Warning
+
+  const indices = getIndicesOf('\t', value)
+
+  return indices.map((index) => ({
+    message,
+    lineNumber,
+    startColumnNumber: index + 1,
+    endColumnNumber: index + 2,
+    severity
+  }))
+}
+
+/**
+ * Lint rule that checks if a given line of text is indented with a tab.
+ */
+export const noTabs: LineLintRule = {
+  type: LintRuleType.Line,
+  name,
+  description,
+  message,
+  test
+}

src/rules/line/noTrailingSpaces.ts

@@ -1,3 +1,4 @@
+import { LintConfig } from '../../types'
 import { LineLintRule } from '../../types/LintRule'
 import { LintRuleType } from '../../types/LintRuleType'
 import { Severity } from '../../types/Severity'
@@ -5,8 +6,11 @@ import { Severity } from '../../types/Severity'
 const name = 'noTrailingSpaces'
 const description = 'Disallow trailing spaces on lines.'
 const message = 'Line contains trailing spaces'
-const test = (value: string, lineNumber: number) =>
-  value.trimEnd() === value
+
+const test = (value: string, lineNumber: number, config?: LintConfig) => {
+  const severity = config?.severityLevel[name] || Severity.Warning
+
+  return value.trimEnd() === value
     ? []
     : [
         {
@@ -14,9 +18,11 @@ const test = (value: string, lineNumber: number) =>
           lineNumber,
           startColumnNumber: value.trimEnd().length + 1,
           endColumnNumber: value.length,
-          severity: Severity.Warning
+          severity
         }
       ]
+}
+
 const fix = (value: string) => value.trimEnd()
 
 /**

src/rules/path/lowerCaseFileNames.ts

@@ -2,20 +2,25 @@ import { PathLintRule } from '../../types/LintRule'
 import { LintRuleType } from '../../types/LintRuleType'
 import { Severity } from '../../types/Severity'
 import path from 'path'
+import { LintConfig } from '../../types'
 
 const name = 'lowerCaseFileNames'
 const description = 'Enforce the use of lower case file names.'
 const message = 'File name contains uppercase characters'
-const test = (value: string) => {
+
+const test = (value: string, config?: LintConfig) => {
+  const severity = config?.severityLevel[name] || Severity.Warning
   const fileName = path.basename(value)
+
   if (fileName.toLocaleLowerCase() === fileName) return []
+
   return [
     {
       message,
       lineNumber: 1,
       startColumnNumber: 1,
       endColumnNumber: 1,
-      severity: Severity.Warning
+      severity
     }
   ]
 }

src/rules/path/noSpacesInFileNames.ts

@@ -2,12 +2,16 @@ import { PathLintRule } from '../../types/LintRule'
 import { LintRuleType } from '../../types/LintRuleType'
 import { Severity } from '../../types/Severity'
 import path from 'path'
+import { LintConfig } from '../../types'
 
 const name = 'noSpacesInFileNames'
 const description = 'Enforce the absence of spaces within file names.'
 const message = 'File name contains spaces'
-const test = (value: string) => {
+
+const test = (value: string, config?: LintConfig) => {
+  const severity = config?.severityLevel[name] || Severity.Warning
   const fileName = path.basename(value)
+
   if (fileName.includes(' ')) {
     return [
       {
@@ -15,7 +19,7 @@ const test = (value: string) => {
         lineNumber: 1,
         startColumnNumber: 1,
         endColumnNumber: 1,
-        severity: Severity.Warning
+        severity
       }
     ]
   }

src/types/LintConfig.spec.ts

@@ -1,6 +1,7 @@
 import { LineEndings } from './LineEndings'
 import { LintConfig } from './LintConfig'
 import { LintRuleType } from './LintRuleType'
+import { Severity } from './Severity'
 
 describe('LintConfig', () => {
   it('should create an empty instance', () => {
@@ -123,6 +124,23 @@ describe('LintConfig', () => {
     expect(config.lineEndings).toEqual(LineEndings.CRLF)
   })
 
+  it('should create an instance with the severityLevel config', () => {
+    const config = new LintConfig({
+      severityLevel: {
+        hasDoxygenHeader: 'warn',
+        maxLineLength: 'error',
+        noTrailingSpaces: 'error'
+      }
+    })
+
+    expect(config).toBeTruthy()
+    expect(config.severityLevel).toEqual({
+      hasDoxygenHeader: Severity.Warning,
+      maxLineLength: Severity.Error,
+      noTrailingSpaces: Severity.Error
+    })
+  })
+
   it('should create an instance with the line endings set to LF by default', () => {
     const config = new LintConfig({})
 

src/types/LintConfig.ts

@@ -10,12 +10,15 @@ import {
   indentationMultiple,
   maxLineLength,
   noEncodedPasswords,
-  noTabIndentation,
-  noTrailingSpaces
+  noTabs,
+  noTrailingSpaces,
+  noGremlins
 } from '../rules/line'
 import { lowerCaseFileNames, noSpacesInFileNames } from '../rules/path'
 import { LineEndings } from './LineEndings'
 import { FileLintRule, LineLintRule, PathLintRule } from './LintRule'
+import { getDefaultHeader } from '../utils'
+import { Severity } from './Severity'
 
 /**
  * LintConfig is the logical representation of the .sasjslint file.
@@ -25,14 +28,31 @@ import { FileLintRule, LineLintRule, PathLintRule } from './LintRule'
  * More types of rules, when available, will be added here.
  */
 export class LintConfig {
+  readonly ignoreList: string[] = []
   readonly lineLintRules: LineLintRule[] = []
   readonly fileLintRules: FileLintRule[] = []
   readonly pathLintRules: PathLintRule[] = []
   readonly maxLineLength: number = 80
   readonly indentationMultiple: number = 2
   readonly lineEndings: LineEndings = LineEndings.LF
+  readonly defaultHeader: string = getDefaultHeader()
+  readonly severityLevel: { [key: string]: Severity } = {}
 
   constructor(json?: any) {
+    if (json?.ignoreList) {
+      if (Array.isArray(json.ignoreList)) {
+        json.ignoreList.forEach((item: any) => {
+          if (typeof item === 'string') this.ignoreList.push(item)
+          else
+            throw new Error(
+              `Property "ignoreList" has invalid type of values. It can contain only strings.`
+            )
+        })
+      } else {
+        throw new Error(`Property "ignoreList" can only be an array of strings`)
+      }
+    }
+
     if (json?.noTrailingSpaces) {
       this.lineLintRules.push(noTrailingSpaces)
     }
@@ -41,8 +61,8 @@ export class LintConfig {
       this.lineLintRules.push(noEncodedPasswords)
     }
 
-    if (json?.noTabIndentation) {
-      this.lineLintRules.push(noTabIndentation)
+    if (json?.noTabs || json?.noTabIndentation) {
+      this.lineLintRules.push(noTabs)
     }
 
     if (json?.maxLineLength) {
@@ -72,6 +92,10 @@ export class LintConfig {
       this.fileLintRules.push(hasDoxygenHeader)
     }
 
+    if (json?.defaultHeader) {
+      this.defaultHeader = json.defaultHeader
+    }
+
     if (json?.noSpacesInFileNames) {
       this.pathLintRules.push(noSpacesInFileNames)
     }
@@ -95,5 +119,16 @@ export class LintConfig {
     if (json?.strictMacroDefinition) {
       this.fileLintRules.push(strictMacroDefinition)
     }
+
+    if (json?.noGremlins) {
+      this.lineLintRules.push(noGremlins)
+    }
+
+    if (json?.severityLevel) {
+      for (const [rule, severity] of Object.entries(json.severityLevel)) {
+        if (severity === 'warn') this.severityLevel[rule] = Severity.Warning
+        if (severity === 'error') this.severityLevel[rule] = Severity.Error
+      }
+    }
   }
 }

src/types/LintRule.ts

@@ -36,5 +36,5 @@ export interface FileLintRule extends LintRule {
  */
 export interface PathLintRule extends LintRule {
   type: LintRuleType.Path
-  test: (value: string) => Diagnostic[]
+  test: (value: string, config?: LintConfig) => Diagnostic[]
 }

src/utils/getIndicesOf.ts

@@ -0,0 +1,26 @@
+export const getIndicesOf = (
+  searchStr: string,
+  str: string,
+  caseSensitive: boolean = true
+) => {
+  const searchStrLen = searchStr.length
+  if (searchStrLen === 0) {
+    return []
+  }
+
+  let startIndex = 0,
+    index,
+    indices = []
+
+  if (!caseSensitive) {
+    str = str.toLowerCase()
+    searchStr = searchStr.toLowerCase()
+  }
+
+  while ((index = str.indexOf(searchStr, startIndex)) > -1) {
+    indices.push(index)
+    startIndex = index + searchStrLen
+  }
+
+  return indices
+}

src/utils/getLintConfig.ts

@@ -3,6 +3,9 @@ import { LintConfig } from '../types/LintConfig'
 import { readFile } from '@sasjs/utils/file'
 import { getProjectRoot } from './getProjectRoot'
 
+export const getDefaultHeader = () =>
+  `/**{lineEnding}  @file{lineEnding}  @brief <Your brief here>{lineEnding}  <h4> SAS Macros </h4>{lineEnding}**/`
+
 /**
  * Default configuration that is used when a .sasjslint file is not found
  */
@@ -18,7 +21,8 @@ export const DefaultLintConfiguration = {
   hasMacroNameInMend: true,
   noNestedMacros: true,
   hasMacroParentheses: true,
-  strictMacroDefinition: true
+  strictMacroDefinition: true,
+  defaultHeader: getDefaultHeader()
 }
 
 /**

src/utils/index.ts

@@ -1,4 +1,7 @@
+export * from './asyncForEach'
 export * from './getLintConfig'
 export * from './getProjectRoot'
+export * from './isIgnored'
 export * from './listSasFiles'
 export * from './splitText'
+export * from './getIndicesOf'

src/utils/isIgnored.spec.ts

@@ -0,0 +1,119 @@
+import path from 'path'
+import * as fileModule from '@sasjs/utils/file'
+import * as getLintConfigModule from './getLintConfig'
+import { getProjectRoot, DefaultLintConfiguration, isIgnored } from '.'
+import { LintConfig } from '../types'
+
+describe('isIgnored', () => {
+  it('should return true if provided path matches the patterns from .gitignore', async () => {
+    jest
+      .spyOn(getLintConfigModule, 'getLintConfig')
+      .mockImplementationOnce(
+        async () => new LintConfig(DefaultLintConfiguration)
+      )
+    jest
+      .spyOn(fileModule, 'fileExists')
+      .mockImplementationOnce(async () => true)
+
+    jest
+      .spyOn(fileModule, 'readFile')
+      .mockImplementationOnce(async () => 'sasjs')
+
+    const projectRoot = await getProjectRoot()
+    const pathToTest = path.join(projectRoot, 'sasjs')
+
+    const ignored = await isIgnored(pathToTest)
+
+    expect(ignored).toBeTruthy()
+  })
+
+  it('should return true if top level path of provided path is in .gitignore', async () => {
+    jest
+      .spyOn(getLintConfigModule, 'getLintConfig')
+      .mockImplementationOnce(
+        async () => new LintConfig(DefaultLintConfiguration)
+      )
+    jest
+      .spyOn(fileModule, 'fileExists')
+      .mockImplementationOnce(async () => true)
+
+    jest
+      .spyOn(fileModule, 'readFile')
+      .mockImplementationOnce(async () => 'sasjs/common')
+
+    const projectRoot = await getProjectRoot()
+    const pathToTest = path.join(projectRoot, 'sasjs/common/init/init.sas')
+
+    const ignored = await isIgnored(pathToTest)
+
+    expect(ignored).toBeTruthy()
+  })
+
+  it('should return true if provided path matches any pattern from ignoreList (.sasjslint)', async () => {
+    jest
+      .spyOn(fileModule, 'fileExists')
+      .mockImplementationOnce(async () => false)
+
+    const projectRoot = await getProjectRoot()
+    const pathToTest = path.join(projectRoot, 'sasjs')
+
+    const ignored = await isIgnored(
+      pathToTest,
+      new LintConfig({
+        ...DefaultLintConfiguration,
+        ignoreList: ['sasjs']
+      })
+    )
+
+    expect(ignored).toBeTruthy()
+  })
+
+  it('should return true if top level path of provided path is in ignoreList (.sasjslint)', async () => {
+    jest
+      .spyOn(fileModule, 'fileExists')
+      .mockImplementationOnce(async () => false)
+
+    const projectRoot = await getProjectRoot()
+    const pathToTest = path.join(projectRoot, 'sasjs/common/init/init.sas')
+
+    const ignored = await isIgnored(
+      pathToTest,
+      new LintConfig({
+        ...DefaultLintConfiguration,
+        ignoreList: ['sasjs']
+      })
+    )
+
+    expect(ignored).toBeTruthy()
+  })
+
+  it('should return false if provided path does not matches any pattern from .gitignore and ignoreList (.sasjslint)', async () => {
+    jest
+      .spyOn(fileModule, 'fileExists')
+      .mockImplementationOnce(async () => true)
+
+    jest.spyOn(fileModule, 'readFile').mockImplementationOnce(async () => '')
+
+    const projectRoot = await getProjectRoot()
+    const pathToTest = path.join(projectRoot, 'sasjs')
+
+    const ignored = await isIgnored(
+      pathToTest,
+      new LintConfig(DefaultLintConfiguration)
+    )
+
+    expect(ignored).toBeFalsy()
+  })
+
+  it('should return false if provided path is equal to projectRoot', async () => {
+    const projectRoot = await getProjectRoot()
+    const pathToTest = path.join(projectRoot, '')
+
+    const ignored = await isIgnored(
+      pathToTest,
+      new LintConfig(DefaultLintConfiguration)
+    )
+
+    expect(ignored).toBeFalsy()
+  })
+})

src/utils/isIgnored.ts

@@ -0,0 +1,34 @@
+import { fileExists, readFile } from '@sasjs/utils'
+import path from 'path'
+import ignore from 'ignore'
+import { getLintConfig, getProjectRoot } from '.'
+import { LintConfig } from '../types'
+
+/**
+ * A function to check if file/folder path matches any pattern from .gitignore or ignoreList (.sasjsLint)
+ *
+ * @param {string} fPath - absolute path of file or folder
+ * @returns {Promise<boolean>} true if path matches the patterns from .gitignore file otherwise false
+ */
+export const isIgnored = async (
+  fPath: string,
+  configuration?: LintConfig
+): Promise<boolean> => {
+  const config = configuration || (await getLintConfig())
+  const projectRoot = await getProjectRoot()
+  const gitIgnoreFilePath = path.join(projectRoot, '.gitignore')
+  const rootPath = projectRoot + path.sep
+  const relativePath = fPath.replace(rootPath, '')
+
+  if (fPath === projectRoot) return false
+
+  let gitIgnoreFileContent = ''
+
+  if (await fileExists(gitIgnoreFilePath))
+    gitIgnoreFileContent = await readFile(gitIgnoreFilePath)
+
+  return ignore()
+    .add(gitIgnoreFileContent)
+    .add(config.ignoreList)
+    .ignores(relativePath)
+}