@sasjs/lint 1.11.0 → 1.12.0

package/.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"
+}

package/.github/dependabot.yml

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

package/.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

package/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.

package/README.md

@@ -1,4 +1,9 @@
-[![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
 
@@ -44,7 +49,7 @@ The SASjs framework recommends the use of Doxygen headers for describing all typ
 * Severity: WARNING
 
 #### 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 will be the result of a popular vote by around 300 people.
+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
@@ -72,13 +77,13 @@ Code becomes far more readable when line lengths are short.  The most compelling
 
 In batch mode, long SAS code lines may also be truncated, causing hard-to-detect errors.  
 
-For this reason we strongly recommend a line length limit, and we set the bar at 80.  To turn this feature off, set the value to 0.
+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
 
 #### noNestedMacros
-Where macros are defined inside other macros, they are recompiled every time the outer maro is invoked.  Hence, it is widely considered inefficient, and bad practice, to nest macro definitions.  
+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
@@ -95,7 +100,7 @@ In addition, when such files are used in URLs, they are often padded with a mess
 * 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 save on characters) there are many, many, many developers who think otherwise.  We're in that camp.  Sorry (not sorry).
+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).
 
 * Default:  true
 * Severity: WARNING
@@ -116,14 +121,19 @@ This will highlight lines with trailing spaces.  Trailing spaces serve no useful
 
 A formatter will automatically apply rules when you hit SAVE, which can save a LOT of time.
 
-We're looking to implement the following rules:
+We've already implemented the following rules:
 
-* Remove trailing spaces
-* Change tabs to spaces 
 * Add the macro name to the %mend statement 
 * Add a doxygen header template if none exists 
+* Remove trailing spaces
 
-Later we will investigate some harder stuff, such as automatic indentation and code layout
+We're looking to implement the following rules:
+
+* 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
 
@@ -133,10 +143,41 @@ Contact [Allan Bowe](https://www.linkedin.com/in/allanbowe/) for further details
 
 ## SAS 9 Health check
 
-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 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.
+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.
 
 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.
 
 Contact [Allan Bowe](https://www.linkedin.com/in/allanbowe/) for further details.
 
 
+
+## Contributors ✨
+<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
+[![All Contributors](https://img.shields.io/badge/all_contributors-8-orange.svg?style=flat-square)](#contributors-)
+<!-- 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!

package/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/lint/lintFile.d.ts

@@ -1,8 +1,8 @@
-import { LintConfig } from '../types/LintConfig';
+import { Diagnostic, LintConfig } from '../types';
 /**
  * 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 declare const lintFile: (filePath: string, configuration?: LintConfig | undefined) => Promise<import("..").Diagnostic[]>;
+export declare const lintFile: (filePath: string, configuration?: LintConfig | undefined) => Promise<Diagnostic[]>;

package/lint/lintFile.js

@@ -59,29 +59,32 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.lintFile = void 0;
 var file_1 = require("@sasjs/utils/file");
-var getLintConfig_1 = require("../utils/getLintConfig");
+var utils_1 = require("../utils");
 var shared_1 = require("./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.
  */
 var lintFile = function (filePath, configuration) { return __awaiter(void 0, void 0, void 0, function () {
     var config, _a, text, fileDiagnostics, textDiagnostics;
     return __generator(this, function (_b) {
         switch (_b.label) {
-            case 0:
-                _a = configuration;
-                if (_a) return [3 /*break*/, 2];
-                return [4 /*yield*/, getLintConfig_1.getLintConfig()];
+            case 0: return [4 /*yield*/, utils_1.isIgnored(filePath)];
             case 1:
-                _a = (_b.sent());
-                _b.label = 2;
+                if (_b.sent())
+                    return [2 /*return*/, []];
+                _a = configuration;
+                if (_a) return [3 /*break*/, 3];
+                return [4 /*yield*/, utils_1.getLintConfig()];
             case 2:
+                _a = (_b.sent());
+                _b.label = 3;
+            case 3:
                 config = _a;
                 return [4 /*yield*/, file_1.readFile(filePath)];
-            case 3:
+            case 4:
                 text = _b.sent();
                 fileDiagnostics = shared_1.processFile(filePath, config);
                 textDiagnostics = shared_1.processText(text, config);

package/lint/lintFile.js.map

@@ -1 +1 @@
-{"version":3,"file":"lintFile.js","sourceRoot":"","sources":["../../src/lint/lintFile.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,0CAA4C;AAE5C,wDAAsD;AACtD,mCAAmD;AAEnD;;;;;GAKG;AACI,IAAM,QAAQ,GAAG,UACtB,QAAgB,EAChB,aAA0B;;;;;gBAEX,KAAA,aAAa,CAAA;wBAAb,wBAAa;gBAAK,qBAAM,6BAAa,EAAE,EAAA;;gBAAtB,KAAA,CAAC,SAAqB,CAAC,CAAA;;;gBAAjD,MAAM,KAA2C;gBAC1C,qBAAM,eAAQ,CAAC,QAAQ,CAAC,EAAA;;gBAA/B,IAAI,GAAG,SAAwB;gBAE/B,eAAe,GAAG,oBAAW,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;gBAC/C,eAAe,GAAG,oBAAW,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;gBAEjD,6DAAW,eAAe,WAAK,eAAe,IAAC;;;KAChD,CAAA;AAXY,QAAA,QAAQ,YAWpB"}
+{"version":3,"file":"lintFile.js","sourceRoot":"","sources":["../../src/lint/lintFile.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,0CAA4C;AAE5C,kCAAmD;AACnD,mCAAmD;AAEnD;;;;;GAKG;AACI,IAAM,QAAQ,GAAG,UACtB,QAAgB,EAChB,aAA0B;;;;oBAEtB,qBAAM,iBAAS,CAAC,QAAQ,CAAC,EAAA;;gBAA7B,IAAI,SAAyB;oBAAE,sBAAO,EAAE,EAAA;gBAEzB,KAAA,aAAa,CAAA;wBAAb,wBAAa;gBAAK,qBAAM,qBAAa,EAAE,EAAA;;gBAAtB,KAAA,CAAC,SAAqB,CAAC,CAAA;;;gBAAjD,MAAM,KAA2C;gBAC1C,qBAAM,eAAQ,CAAC,QAAQ,CAAC,EAAA;;gBAA/B,IAAI,GAAG,SAAwB;gBAE/B,eAAe,GAAG,oBAAW,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;gBAC/C,eAAe,GAAG,oBAAW,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;gBAEjD,6DAAW,eAAe,WAAK,eAAe,IAAC;;;KAChD,CAAA;AAbY,QAAA,QAAQ,YAapB"}

package/lint/lintFolder.d.ts

@@ -1,5 +1,4 @@
-import { Diagnostic } from '../types/Diagnostic';
-import { LintConfig } from '../types/LintConfig';
+import { Diagnostic, LintConfig } from '../types';
 /**
  * Analyses and produces a set of diagnostics for the folder at the given path.
  * @param {string} folderPath - the path to the folder to be linted.

package/lint/lintFolder.js

@@ -63,9 +63,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.lintFolder = void 0;
 var file_1 = require("@sasjs/utils/file");
 var path_1 = __importDefault(require("path"));
-var asyncForEach_1 = require("../utils/asyncForEach");
-var getLintConfig_1 = require("../utils/getLintConfig");
-var listSasFiles_1 = require("../utils/listSasFiles");
+var utils_1 = require("../utils");
 var lintFile_1 = require("./lintFile");
 var excludeFolders = [
     '.git',
@@ -88,17 +86,21 @@ var lintFolder = function (folderPath, configuration) { return __awaiter(void 0,
             case 0:
                 _a = configuration;
                 if (_a) return [3 /*break*/, 2];
-                return [4 /*yield*/, getLintConfig_1.getLintConfig()];
+                return [4 /*yield*/, utils_1.getLintConfig()];
             case 1:
                 _a = (_b.sent());
                 _b.label = 2;
             case 2:
                 config = _a;
                 diagnostics = new Map();
-                return [4 /*yield*/, listSasFiles_1.listSasFiles(folderPath)];
+                return [4 /*yield*/, utils_1.isIgnored(folderPath)];
             case 3:
+                if (_b.sent())
+                    return [2 /*return*/, diagnostics];
+                return [4 /*yield*/, utils_1.listSasFiles(folderPath)];
+            case 4:
                 fileNames = _b.sent();
-                return [4 /*yield*/, asyncForEach_1.asyncForEach(fileNames, function (fileName) { return __awaiter(void 0, void 0, void 0, function () {
+                return [4 /*yield*/, utils_1.asyncForEach(fileNames, function (fileName) { return __awaiter(void 0, void 0, void 0, function () {
                         var filePath, _a, _b, _c;
                         return __generator(this, function (_d) {
                             switch (_d.label) {
@@ -113,16 +115,18 @@ var lintFolder = function (folderPath, configuration) { return __awaiter(void 0,
                             }
                         });
                     }); })];
-            case 4:
+            case 5:
                 _b.sent();
                 return [4 /*yield*/, file_1.listSubFoldersInFolder(folderPath)];
-            case 5:
+            case 6:
                 subFolders = (_b.sent()).filter(function (f) { return !excludeFolders.includes(f); });
-                return [4 /*yield*/, asyncForEach_1.asyncForEach(subFolders, function (subFolder) { return __awaiter(void 0, void 0, void 0, function () {
-                        var subFolderDiagnostics;
+                return [4 /*yield*/, utils_1.asyncForEach(subFolders, function (subFolder) { return __awaiter(void 0, void 0, void 0, function () {
+                        var subFolderPath, subFolderDiagnostics;
                         return __generator(this, function (_a) {
                             switch (_a.label) {
-                                case 0: return [4 /*yield*/, exports.lintFolder(path_1.default.join(folderPath, subFolder), config)];
+                                case 0:
+                                    subFolderPath = path_1.default.join(folderPath, subFolder);
+                                    return [4 /*yield*/, exports.lintFolder(subFolderPath, config)];
                                 case 1:
                                     subFolderDiagnostics = _a.sent();
                                     diagnostics = new Map(__spreadArray(__spreadArray([], __read(diagnostics)), __read(subFolderDiagnostics)));
@@ -130,7 +134,7 @@ var lintFolder = function (folderPath, configuration) { return __awaiter(void 0,
                             }
                         });
                     }); })];
-            case 6:
+            case 7:
                 _b.sent();
                 return [2 /*return*/, diagnostics];
         }

package/lint/lintFolder.js.map

@@ -1 +1 @@
-{"version":3,"file":"lintFolder.js","sourceRoot":"","sources":["../../src/lint/lintFolder.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,0CAA0D;AAC1D,8CAAuB;AAGvB,sDAAoD;AACpD,wDAAsD;AACtD,sDAAoD;AACpD,uCAAqC;AAErC,IAAM,cAAc,GAAG;IACrB,MAAM;IACN,SAAS;IACT,SAAS;IACT,cAAc;IACd,YAAY;IACZ,cAAc;CACf,CAAA;AAED;;;;;GAKG;AACI,IAAM,UAAU,GAAG,UACxB,UAAkB,EAClB,aAA0B;;;;;gBAEX,KAAA,aAAa,CAAA;wBAAb,wBAAa;gBAAK,qBAAM,6BAAa,EAAE,EAAA;;gBAAtB,KAAA,CAAC,SAAqB,CAAC,CAAA;;;gBAAjD,MAAM,KAA2C;gBACnD,WAAW,GAA8B,IAAI,GAAG,EAAwB,CAAA;gBAC1D,qBAAM,2BAAY,CAAC,UAAU,CAAC,EAAA;;gBAA1C,SAAS,GAAG,SAA8B;gBAChD,qBAAM,2BAAY,CAAC,SAAS,EAAE,UAAO,QAAQ;;;;;oCACrC,QAAQ,GAAG,cAAI,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAA;oCAChD,KAAA,CAAA,KAAA,WAAW,CAAA,CAAC,GAAG,CAAA;0CAAC,QAAQ;oCAAE,qBAAM,mBAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAA;;oCAA1D,wBAA0B,SAAgC,GAAC,CAAA;;;;yBAC5D,CAAC,EAAA;;gBAHF,SAGE,CAAA;gBAEkB,qBAAM,6BAAsB,CAAC,UAAU,CAAC,EAAA;;gBAAtD,UAAU,GAAG,CAAC,SAAwC,CAAC,CAAC,MAAM,CAClE,UAAC,CAAS,IAAK,OAAA,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAC,EAA3B,CAA2B,CAC3C;gBAED,qBAAM,2BAAY,CAAC,UAAU,EAAE,UAAO,SAAS;;;;wCAChB,qBAAM,kBAAU,CAC3C,cAAI,CAAC,IAAI,CAAC,UAAU,EAAE,SAAS,CAAC,EAChC,MAAM,CACP,EAAA;;oCAHK,oBAAoB,GAAG,SAG5B;oCACD,WAAW,GAAG,IAAI,GAAG,wCAAK,WAAW,WAAK,oBAAoB,GAAE,CAAA;;;;yBACjE,CAAC,EAAA;;gBANF,SAME,CAAA;gBAEF,sBAAO,WAAW,EAAA;;;KACnB,CAAA;AAzBY,QAAA,UAAU,cAyBtB"}
+{"version":3,"file":"lintFolder.js","sourceRoot":"","sources":["../../src/lint/lintFolder.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,0CAA0D;AAC1D,8CAAuB;AAEvB,kCAA+E;AAC/E,uCAAqC;AAErC,IAAM,cAAc,GAAG;IACrB,MAAM;IACN,SAAS;IACT,SAAS;IACT,cAAc;IACd,YAAY;IACZ,cAAc;CACf,CAAA;AAED;;;;;GAKG;AACI,IAAM,UAAU,GAAG,UACxB,UAAkB,EAClB,aAA0B;;;;;gBAEX,KAAA,aAAa,CAAA;wBAAb,wBAAa;gBAAK,qBAAM,qBAAa,EAAE,EAAA;;gBAAtB,KAAA,CAAC,SAAqB,CAAC,CAAA;;;gBAAjD,MAAM,KAA2C;gBACnD,WAAW,GAA8B,IAAI,GAAG,EAAwB,CAAA;gBAExE,qBAAM,iBAAS,CAAC,UAAU,CAAC,EAAA;;gBAA/B,IAAI,SAA2B;oBAAE,sBAAO,WAAW,EAAA;gBAEjC,qBAAM,oBAAY,CAAC,UAAU,CAAC,EAAA;;gBAA1C,SAAS,GAAG,SAA8B;gBAChD,qBAAM,oBAAY,CAAC,SAAS,EAAE,UAAO,QAAQ;;;;;oCACrC,QAAQ,GAAG,cAAI,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAA;oCAChD,KAAA,CAAA,KAAA,WAAW,CAAA,CAAC,GAAG,CAAA;0CAAC,QAAQ;oCAAE,qBAAM,mBAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAA;;oCAA1D,wBAA0B,SAAgC,GAAC,CAAA;;;;yBAC5D,CAAC,EAAA;;gBAHF,SAGE,CAAA;gBAEkB,qBAAM,6BAAsB,CAAC,UAAU,CAAC,EAAA;;gBAAtD,UAAU,GAAG,CAAC,SAAwC,CAAC,CAAC,MAAM,CAClE,UAAC,CAAS,IAAK,OAAA,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAC,EAA3B,CAA2B,CAC3C;gBAED,qBAAM,oBAAY,CAAC,UAAU,EAAE,UAAO,SAAS;;;;;oCACvC,aAAa,GAAG,cAAI,CAAC,IAAI,CAAC,UAAU,EAAE,SAAS,CAAC,CAAA;oCACzB,qBAAM,kBAAU,CAAC,aAAa,EAAE,MAAM,CAAC,EAAA;;oCAA9D,oBAAoB,GAAG,SAAuC;oCACpE,WAAW,GAAG,IAAI,GAAG,wCAAK,WAAW,WAAK,oBAAoB,GAAE,CAAA;;;;yBACjE,CAAC,EAAA;;gBAJF,SAIE,CAAA;gBAEF,sBAAO,WAAW,EAAA;;;KACnB,CAAA;AA1BY,QAAA,UAAU,cA0BtB"}

package/package.json

@@ -4,12 +4,14 @@
   "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}'",
-    "postinstall": "[ -d .git ] && git config core.hooksPath ./.git-hooks || true"
+    "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": {
     "access": "public"
@@ -38,14 +40,16 @@
   "homepage": "https://github.com/sasjs/lint#readme",
   "devDependencies": {
     "@types/jest": "^26.0.23",
-    "@types/node": "^15.0.2",
+    "@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.2.4"
+    "typescript": "^4.3.2"
   },
   "dependencies": {
-    "@sasjs/utils": "^2.12.0"
+    "@sasjs/utils": "^2.19.0",
+    "ignore": "^5.2.0"
   },
-  "version": "1.11.0"
+  "version": "1.12.0"
 }

package/rules/file/hasDoxygenHeader.js

@@ -8,11 +8,26 @@ var DoxygenHeader = "/**{lineEnding}  @file{lineEnding}  @brief <Your brief here
 var name = 'hasDoxygenHeader';
 var description = 'Enforce the presence of a Doxygen header at the start of each file.';
 var message = 'File missing Doxygen header';
-var test = function (value) {
+var messageForSingleAsterisk = 'File not following Doxygen header style, use double asterisks';
+var test = function (value, config) {
+    var _a;
+    var lineEnding = (config === null || config === void 0 ? void 0 : config.lineEndings) === LineEndings_1.LineEndings.CRLF ? '\r\n' : '\n';
     try {
-        var hasFileHeader = value.trimStart().startsWith('/*');
+        var hasFileHeader = value.trimStart().startsWith('/**');
         if (hasFileHeader)
             return [];
+        var hasFileHeaderWithSingleAsterisk = value.trimStart().startsWith('/*');
+        if (hasFileHeaderWithSingleAsterisk)
+            return [
+                {
+                    message: messageForSingleAsterisk,
+                    lineNumber: ((_a = value.split('/*')[0].match(new RegExp(lineEnding, 'g'))) !== null && _a !== void 0 ? _a : [])
+                        .length + 1,
+                    startColumnNumber: 1,
+                    endColumnNumber: 1,
+                    severity: Severity_1.Severity.Warning
+                }
+            ];
         return [
             {
                 message: message,
@@ -36,9 +51,12 @@ var test = function (value) {
     }
 };
 var fix = function (value, config) {
-    if (test(value).length === 0) {
+    var result = test(value, config);
+    if (result.length === 0) {
         return value;
     }
+    else if (result[0].message == messageForSingleAsterisk)
+        return value.replace('/*', '/**');
     var lineEndingConfig = (config === null || config === void 0 ? void 0 : config.lineEndings) || LineEndings_1.LineEndings.LF;
     var lineEnding = lineEndingConfig === LineEndings_1.LineEndings.LF ? '\n' : '\r\n';
     return "" + DoxygenHeader.replace(/{lineEnding}/g, lineEnding) + lineEnding + value;

package/rules/file/hasDoxygenHeader.js.map

@@ -1 +1 @@
-{"version":3,"file":"hasDoxygenHeader.js","sourceRoot":"","sources":["../../../src/rules/file/hasDoxygenHeader.ts"],"names":[],"mappings":";;;AACA,uDAAqD;AAErD,yDAAuD;AACvD,iDAA+C;AAE/C,IAAM,aAAa,GAAG,gHAAgH,CAAA;AAEtI,IAAM,IAAI,GAAG,kBAAkB,CAAA;AAC/B,IAAM,WAAW,GACf,qEAAqE,CAAA;AACvE,IAAM,OAAO,GAAG,6BAA6B,CAAA;AAC7C,IAAM,IAAI,GAAG,UAAC,KAAa;IACzB,IAAI;QACF,IAAM,aAAa,GAAG,KAAK,CAAC,SAAS,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAA;QACxD,IAAI,aAAa;YAAE,OAAO,EAAE,CAAA;QAC5B,OAAO;YACL;gBACE,OAAO,SAAA;gBACP,UAAU,EAAE,CAAC;gBACb,iBAAiB,EAAE,CAAC;gBACpB,eAAe,EAAE,CAAC;gBAClB,QAAQ,EAAE,mBAAQ,CAAC,OAAO;aAC3B;SACF,CAAA;KACF;IAAC,OAAO,CAAC,EAAE;QACV,OAAO;YACL;gBACE,OAAO,SAAA;gBACP,UAAU,EAAE,CAAC;gBACb,iBAAiB,EAAE,CAAC;gBACpB,eAAe,EAAE,CAAC;gBAClB,QAAQ,EAAE,mBAAQ,CAAC,OAAO;aAC3B;SACF,CAAA;KACF;AACH,CAAC,CAAA;AAED,IAAM,GAAG,GAAG,UAAC,KAAa,EAAE,MAAmB;IAC7C,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;QAC5B,OAAO,KAAK,CAAA;KACb;IACD,IAAM,gBAAgB,GAAG,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,WAAW,KAAI,yBAAW,CAAC,EAAE,CAAA;IAC9D,IAAM,UAAU,GAAG,gBAAgB,KAAK,yBAAW,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAA;IAEtE,OAAO,KAAG,aAAa,CAAC,OAAO,CAC7B,eAAe,EACf,UAAU,CACX,GAAG,UAAU,GAAG,KAAO,CAAA;AAC1B,CAAC,CAAA;AAED;;GAEG;AACU,QAAA,gBAAgB,GAAiB;IAC5C,IAAI,EAAE,2BAAY,CAAC,IAAI;IACvB,IAAI,MAAA;IACJ,WAAW,aAAA;IACX,OAAO,SAAA;IACP,IAAI,MAAA;IACJ,GAAG,KAAA;CACJ,CAAA"}
+{"version":3,"file":"hasDoxygenHeader.js","sourceRoot":"","sources":["../../../src/rules/file/hasDoxygenHeader.ts"],"names":[],"mappings":";;;AACA,uDAAqD;AAErD,yDAAuD;AACvD,iDAA+C;AAE/C,IAAM,aAAa,GAAG,gHAAgH,CAAA;AAEtI,IAAM,IAAI,GAAG,kBAAkB,CAAA;AAC/B,IAAM,WAAW,GACf,qEAAqE,CAAA;AACvE,IAAM,OAAO,GAAG,6BAA6B,CAAA;AAC7C,IAAM,wBAAwB,GAC5B,+DAA+D,CAAA;AACjE,IAAM,IAAI,GAAG,UAAC,KAAa,EAAE,MAAmB;;IAC9C,IAAM,UAAU,GAAG,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,WAAW,MAAK,yBAAW,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAA;IAC3E,IAAI;QACF,IAAM,aAAa,GAAG,KAAK,CAAC,SAAS,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,CAAA;QACzD,IAAI,aAAa;YAAE,OAAO,EAAE,CAAA;QAE5B,IAAM,+BAA+B,GAAG,KAAK,CAAC,SAAS,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAA;QAC1E,IAAI,+BAA+B;YACjC,OAAO;gBACL;oBACE,OAAO,EAAE,wBAAwB;oBACjC,UAAU,EACR,CAAC,MAAA,KAAK,CAAC,KAAK,CAAC,IAAI,CAAE,CAAC,CAAC,CAAE,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC,mCAAI,EAAE,CAAC;yBAC9D,MAAM,GAAG,CAAC;oBACf,iBAAiB,EAAE,CAAC;oBACpB,eAAe,EAAE,CAAC;oBAClB,QAAQ,EAAE,mBAAQ,CAAC,OAAO;iBAC3B;aACF,CAAA;QAEH,OAAO;YACL;gBACE,OAAO,SAAA;gBACP,UAAU,EAAE,CAAC;gBACb,iBAAiB,EAAE,CAAC;gBACpB,eAAe,EAAE,CAAC;gBAClB,QAAQ,EAAE,mBAAQ,CAAC,OAAO;aAC3B;SACF,CAAA;KACF;IAAC,OAAO,CAAC,EAAE;QACV,OAAO;YACL;gBACE,OAAO,SAAA;gBACP,UAAU,EAAE,CAAC;gBACb,iBAAiB,EAAE,CAAC;gBACpB,eAAe,EAAE,CAAC;gBAClB,QAAQ,EAAE,mBAAQ,CAAC,OAAO;aAC3B;SACF,CAAA;KACF;AACH,CAAC,CAAA;AAED,IAAM,GAAG,GAAG,UAAC,KAAa,EAAE,MAAmB;IAC7C,IAAM,MAAM,GAAG,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;IAClC,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE;QACvB,OAAO,KAAK,CAAA;KACb;SAAM,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,IAAI,wBAAwB;QACtD,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;IAEnC,IAAM,gBAAgB,GAAG,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,WAAW,KAAI,yBAAW,CAAC,EAAE,CAAA;IAC9D,IAAM,UAAU,GAAG,gBAAgB,KAAK,yBAAW,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAA;IAEtE,OAAO,KAAG,aAAa,CAAC,OAAO,CAC7B,eAAe,EACf,UAAU,CACX,GAAG,UAAU,GAAG,KAAO,CAAA;AAC1B,CAAC,CAAA;AAED;;GAEG;AACU,QAAA,gBAAgB,GAAiB;IAC5C,IAAI,EAAE,2BAAY,CAAC,IAAI;IACvB,IAAI,MAAA;IACJ,WAAW,aAAA;IACX,OAAO,SAAA;IACP,IAAI,MAAA;IACJ,GAAG,KAAA;CACJ,CAAA"}

package/sasjslint-schema.json

@@ -140,6 +140,14 @@
       "description": "Enforces Macro Definition syntax. Shows a warning when incorrect syntax is used.",
       "default": true,
       "examples": [true, false]
+    },
+    "ignoreList": {
+      "$id": "#/properties/ignoreList",
+      "type": "object",
+      "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"]
     }
   }
 }

package/types/LintConfig.d.ts

@@ -8,6 +8,7 @@ import { FileLintRule, LineLintRule, PathLintRule } from './LintRule';
  * More types of rules, when available, will be added here.
  */
 export declare class LintConfig {
+    readonly ignoreList: string[];
     readonly lineLintRules: LineLintRule[];
     readonly fileLintRules: FileLintRule[];
     readonly pathLintRules: PathLintRule[];

package/types/LintConfig.js

@@ -14,12 +14,27 @@ var LineEndings_1 = require("./LineEndings");
  */
 var LintConfig = /** @class */ (function () {
     function LintConfig(json) {
+        var _this = this;
+        this.ignoreList = [];
         this.lineLintRules = [];
         this.fileLintRules = [];
         this.pathLintRules = [];
         this.maxLineLength = 80;
         this.indentationMultiple = 2;
         this.lineEndings = LineEndings_1.LineEndings.LF;
+        if (json === null || json === void 0 ? void 0 : json.ignoreList) {
+            if (Array.isArray(json.ignoreList)) {
+                json.ignoreList.forEach(function (item) {
+                    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 === null || json === void 0 ? void 0 : json.noTrailingSpaces) {
             this.lineLintRules.push(line_1.noTrailingSpaces);
         }

package/types/LintConfig.js.map

@@ -1 +1 @@
-{"version":3,"file":"LintConfig.js","sourceRoot":"","sources":["../../src/types/LintConfig.ts"],"names":[],"mappings":";;;AAAA,sCAOsB;AACtB,sCAMsB;AACtB,sCAAuE;AACvE,6CAA2C;AAG3C;;;;;;GAMG;AACH;IAQE,oBAAY,IAAU;QAPb,kBAAa,GAAmB,EAAE,CAAA;QAClC,kBAAa,GAAmB,EAAE,CAAA;QAClC,kBAAa,GAAmB,EAAE,CAAA;QAClC,kBAAa,GAAW,EAAE,CAAA;QAC1B,wBAAmB,GAAW,CAAC,CAAA;QAC/B,gBAAW,GAAgB,yBAAW,CAAC,EAAE,CAAA;QAGhD,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,gBAAgB,EAAE;YAC1B,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,uBAAgB,CAAC,CAAA;SAC1C;QAED,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,kBAAkB,EAAE;YAC5B,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,yBAAkB,CAAC,CAAA;SAC5C;QAED,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,gBAAgB,EAAE;YAC1B,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,uBAAgB,CAAC,CAAA;SAC1C;QAED,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,aAAa,EAAE;YACvB,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,CAAA;YACvC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,oBAAa,CAAC,CAAA;SACvC;QAED,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,WAAW,EAAE;YACrB,IACE,IAAI,CAAC,WAAW,KAAK,yBAAW,CAAC,EAAE;gBACnC,IAAI,CAAC,WAAW,KAAK,yBAAW,CAAC,IAAI,EACrC;gBACA,MAAM,IAAI,KAAK,CACb,2CAAyC,yBAAW,CAAC,EAAE,YAAO,yBAAW,CAAC,IAAM,CACjF,CAAA;aACF;YACD,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAA;YACnC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,kBAAW,CAAC,CAAA;SACrC;QAED,IAAI,CAAC,KAAK,CAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,mBAAmB,CAAC,EAAE;YACrC,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,mBAA6B,CAAA;YAC7D,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,0BAAmB,CAAC,CAAA;SAC7C;QAED,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,gBAAgB,EAAE;YAC1B,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,uBAAgB,CAAC,CAAA;SAC1C;QAED,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,mBAAmB,EAAE;YAC7B,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,0BAAmB,CAAC,CAAA;SAC7C;QAED,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,kBAAkB,EAAE;YAC5B,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,yBAAkB,CAAC,CAAA;SAC5C;QAED,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,kBAAkB,EAAE;YAC5B,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,yBAAkB,CAAC,CAAA;SAC5C;QAED,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,cAAc,EAAE;YACxB,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,qBAAc,CAAC,CAAA;SACxC;QAED,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,mBAAmB,EAAE;YAC7B,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,0BAAmB,CAAC,CAAA;SAC7C;QAED,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,qBAAqB,EAAE;YAC/B,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,4BAAqB,CAAC,CAAA;SAC/C;IACH,CAAC;IACH,iBAAC;AAAD,CAAC,AAxED,IAwEC;AAxEY,gCAAU"}
+{"version":3,"file":"LintConfig.js","sourceRoot":"","sources":["../../src/types/LintConfig.ts"],"names":[],"mappings":";;;AAAA,sCAOsB;AACtB,sCAMsB;AACtB,sCAAuE;AACvE,6CAA2C;AAG3C;;;;;;GAMG;AACH;IASE,oBAAY,IAAU;QAAtB,iBA6EC;QArFQ,eAAU,GAAa,EAAE,CAAA;QACzB,kBAAa,GAAmB,EAAE,CAAA;QAClC,kBAAa,GAAmB,EAAE,CAAA;QAClC,kBAAa,GAAmB,EAAE,CAAA;QAClC,kBAAa,GAAW,EAAE,CAAA;QAC1B,wBAAmB,GAAW,CAAC,CAAA;QAC/B,gBAAW,GAAgB,yBAAW,CAAC,EAAE,CAAA;QAGhD,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,UAAU,EAAE;YACpB,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE;gBAClC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,UAAC,IAAS;oBAChC,IAAI,OAAO,IAAI,KAAK,QAAQ;wBAAE,KAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;;wBAEtD,MAAM,IAAI,KAAK,CACb,kFAAgF,CACjF,CAAA;gBACL,CAAC,CAAC,CAAA;aACH;iBAAM;gBACL,MAAM,IAAI,KAAK,CAAC,yDAAuD,CAAC,CAAA;aACzE;SACF;QAED,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,gBAAgB,EAAE;YAC1B,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,uBAAgB,CAAC,CAAA;SAC1C;QAED,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,kBAAkB,EAAE;YAC5B,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,yBAAkB,CAAC,CAAA;SAC5C;QAED,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,gBAAgB,EAAE;YAC1B,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,uBAAgB,CAAC,CAAA;SAC1C;QAED,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,aAAa,EAAE;YACvB,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,CAAA;YACvC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,oBAAa,CAAC,CAAA;SACvC;QAED,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,WAAW,EAAE;YACrB,IACE,IAAI,CAAC,WAAW,KAAK,yBAAW,CAAC,EAAE;gBACnC,IAAI,CAAC,WAAW,KAAK,yBAAW,CAAC,IAAI,EACrC;gBACA,MAAM,IAAI,KAAK,CACb,2CAAyC,yBAAW,CAAC,EAAE,YAAO,yBAAW,CAAC,IAAM,CACjF,CAAA;aACF;YACD,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAA;YACnC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,kBAAW,CAAC,CAAA;SACrC;QAED,IAAI,CAAC,KAAK,CAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,mBAAmB,CAAC,EAAE;YACrC,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,mBAA6B,CAAA;YAC7D,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,0BAAmB,CAAC,CAAA;SAC7C;QAED,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,gBAAgB,EAAE;YAC1B,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,uBAAgB,CAAC,CAAA;SAC1C;QAED,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,mBAAmB,EAAE;YAC7B,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,0BAAmB,CAAC,CAAA;SAC7C;QAED,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,kBAAkB,EAAE;YAC5B,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,yBAAkB,CAAC,CAAA;SAC5C;QAED,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,kBAAkB,EAAE;YAC5B,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,yBAAkB,CAAC,CAAA;SAC5C;QAED,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,cAAc,EAAE;YACxB,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,qBAAc,CAAC,CAAA;SACxC;QAED,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,mBAAmB,EAAE;YAC7B,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,0BAAmB,CAAC,CAAA;SAC7C;QAED,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,qBAAqB,EAAE;YAC/B,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,4BAAqB,CAAC,CAAA;SAC/C;IACH,CAAC;IACH,iBAAC;AAAD,CAAC,AAvFD,IAuFC;AAvFY,gCAAU"}

package/utils/index.d.ts

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

package/utils/index.js

@@ -10,8 +10,10 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./asyncForEach"), exports);
 __exportStar(require("./getLintConfig"), exports);
 __exportStar(require("./getProjectRoot"), exports);
+__exportStar(require("./isIgnored"), exports);
 __exportStar(require("./listSasFiles"), exports);
 __exportStar(require("./splitText"), exports);
 //# sourceMappingURL=index.js.map

package/utils/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,kDAA+B;AAC/B,mDAAgC;AAChC,iDAA8B;AAC9B,8CAA2B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,iDAA8B;AAC9B,kDAA+B;AAC/B,mDAAgC;AAChC,8CAA2B;AAC3B,iDAA8B;AAC9B,8CAA2B"}

package/utils/isIgnored.d.ts

@@ -0,0 +1,8 @@
+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 declare const isIgnored: (fPath: string, configuration?: LintConfig | undefined) => Promise<boolean>;

package/utils/isIgnored.js

@@ -0,0 +1,90 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isIgnored = void 0;
+var utils_1 = require("@sasjs/utils");
+var path_1 = __importDefault(require("path"));
+var ignore_1 = __importDefault(require("ignore"));
+var _1 = require(".");
+/**
+ * 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
+ */
+var isIgnored = function (fPath, configuration) { return __awaiter(void 0, void 0, void 0, function () {
+    var config, _a, projectRoot, gitIgnoreFilePath, rootPath, relativePath, gitIgnoreFileContent;
+    return __generator(this, function (_b) {
+        switch (_b.label) {
+            case 0:
+                _a = configuration;
+                if (_a) return [3 /*break*/, 2];
+                return [4 /*yield*/, _1.getLintConfig()];
+            case 1:
+                _a = (_b.sent());
+                _b.label = 2;
+            case 2:
+                config = _a;
+                return [4 /*yield*/, _1.getProjectRoot()];
+            case 3:
+                projectRoot = _b.sent();
+                gitIgnoreFilePath = path_1.default.join(projectRoot, '.gitignore');
+                rootPath = projectRoot + path_1.default.sep;
+                relativePath = fPath.replace(rootPath, '');
+                if (fPath === projectRoot)
+                    return [2 /*return*/, false];
+                gitIgnoreFileContent = '';
+                return [4 /*yield*/, utils_1.fileExists(gitIgnoreFilePath)];
+            case 4:
+                if (!_b.sent()) return [3 /*break*/, 6];
+                return [4 /*yield*/, utils_1.readFile(gitIgnoreFilePath)];
+            case 5:
+                gitIgnoreFileContent = _b.sent();
+                _b.label = 6;
+            case 6: return [2 /*return*/, ignore_1.default()
+                    .add(gitIgnoreFileContent)
+                    .add(config.ignoreList)
+                    .ignores(relativePath)];
+        }
+    });
+}); };
+exports.isIgnored = isIgnored;
+//# sourceMappingURL=isIgnored.js.map

package/utils/isIgnored.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"isIgnored.js","sourceRoot":"","sources":["../../src/utils/isIgnored.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,sCAAmD;AACnD,8CAAuB;AACvB,kDAA2B;AAC3B,sBAAiD;AAGjD;;;;;GAKG;AACI,IAAM,SAAS,GAAG,UACvB,KAAa,EACb,aAA0B;;;;;gBAEX,KAAA,aAAa,CAAA;wBAAb,wBAAa;gBAAK,qBAAM,gBAAa,EAAE,EAAA;;gBAAtB,KAAA,CAAC,SAAqB,CAAC,CAAA;;;gBAAjD,MAAM,KAA2C;gBACnC,qBAAM,iBAAc,EAAE,EAAA;;gBAApC,WAAW,GAAG,SAAsB;gBACpC,iBAAiB,GAAG,cAAI,CAAC,IAAI,CAAC,WAAW,EAAE,YAAY,CAAC,CAAA;gBACxD,QAAQ,GAAG,WAAW,GAAG,cAAI,CAAC,GAAG,CAAA;gBACjC,YAAY,GAAG,KAAK,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAA;gBAEhD,IAAI,KAAK,KAAK,WAAW;oBAAE,sBAAO,KAAK,EAAA;gBAEnC,oBAAoB,GAAG,EAAE,CAAA;gBAEzB,qBAAM,kBAAU,CAAC,iBAAiB,CAAC,EAAA;;qBAAnC,SAAmC,EAAnC,wBAAmC;gBACd,qBAAM,gBAAQ,CAAC,iBAAiB,CAAC,EAAA;;gBAAxD,oBAAoB,GAAG,SAAiC,CAAA;;oBAE1D,sBAAO,gBAAM,EAAE;qBACZ,GAAG,CAAC,oBAAoB,CAAC;qBACzB,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC;qBACtB,OAAO,CAAC,YAAY,CAAC,EAAA;;;KACzB,CAAA;AArBY,QAAA,SAAS,aAqBrB"}