Merge pull request #220 from sasjs/rev

Rev

.all-contributorsrc

@@ -101,6 +101,15 @@
         "test",
         "review"
       ]
+    },
+    {
+      "login": "McGwire-Jones",
+      "name": "McGwire-Jones",
+      "avatar_url": "https://avatars.githubusercontent.com/u/51411005?v=4",
+      "profile": "https://github.com/McGwire-Jones",
+      "contributions": [
+        "code"
+      ]
     }
   ],
   "contributorsPerLine": 7,
@@ -109,5 +118,6 @@
   "repoType": "github",
   "repoHost": "https://github.com",
   "skipCi": true,
-  "commitConvention": "none"
+  "commitConvention": "none",
+  "commitType": "docs"
 }

.github/dependabot.yml

@@ -4,4 +4,4 @@ updates:
     directory: '/'
     schedule:
       interval: monthly
-    open-pull-requests-limit: 10
+    open-pull-requests-limit: 3

.github/reviewer-lottery.yml

@@ -2,8 +2,6 @@ groups:
   - name: SASjs Devs # name of the group
     reviewers: 1 # how many reviewers do you want to assign?
     usernames: # github usernames of the reviewers
-      - krishna-acondy
       - YuryShkoda
-      - saadjutt01
       - medjedovicm
       - allanbowe

.github/workflows/assign-reviewer.yml

@@ -8,6 +8,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - uses: uesteibar/reviewer-lottery@v1
+      - uses: uesteibar/reviewer-lottery@v3
         with:
-          repo-token: ${{ secrets.GH_TOKEN }}
+          repo-token: ${{ secrets.GH_TOKEN }}

README.md

@@ -8,6 +8,8 @@
 
 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.
 
+*Note:* The SASjs project and its repositories are not affiliated with SAS Institute.
+
 # Linting
 
 @sasjs/lint is used by the following products:
@@ -19,16 +21,19 @@ Configuration is via a `.sasjslint` file with the following structure (these are
 
 ```json
 {
-  "noEncodedPasswords": true,
   "hasDoxygenHeader": true,
   "hasMacroNameInMend": true,
   "hasMacroParentheses": true,
-  "ignoreList": ["sajsbuild/", "sasjsresults/"],
+  "hasRequiredMacroOptions": false,
+  "requiredMacroOptions": ["SECURE", "SRC"],
+  "ignoreList": ["sasjsbuild/", "sasjsresults/"],
   "indentationMultiple": 2,
+  "lineEndings": "off",
   "lowerCaseFileNames": true,
   "maxDataLineLength": 80,
   "maxHeaderLineLength": 80,
   "maxLineLength": 80,
+  "noEncodedPasswords": true,
   "noNestedMacros": true,
   "noGremlins": true,
   "noSpacesInFileNames": true,
@@ -48,16 +53,18 @@ Each setting can have three states:
 
 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.
 
+Configuring a non-zero return code (ERROR) is helpful when running `sasjs lint` as part of a git pre-commit hook.  An example is available [here](https://github.com/sasjs/template_jobs/blob/main/.git-hooks/pre-commit).
+
 ### allowedGremlins
 
-An array of hex codes that represents allowed gremlins (invisible / undesirable characters).  To allow all gremlins, you can also set the `noGremlins` rule to `false`.
+An array of hex codes that represents allowed gremlins (invisible / undesirable characters). To allow all gremlins, you can also set the `noGremlins` rule to `false`.  The full gremlin list is [here](https://github.com/sasjs/lint/blob/main/src/utils/gremlinCharacters.ts).
 
 Example:
 
 ```json
 {
-      "noGremlins": true,
+  "noGremlins": true,
-      "allowedGremlins": ["0x0080", "0x3000"]
+  "allowedGremlins": ["0x0080", "0x3000"]
 }
 ```
 
@@ -83,13 +90,6 @@ If creating a new value, use `{lineEnding}` instead of `\n`, eg as follows:
 }
 ```
 
-### 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
 
 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.
@@ -111,6 +111,21 @@ As per the example [here](https://github.com/sasjs/lint/issues/20), macros defin
 - Default: true
 - Severity: WARNING
 
+### hasRequiredMacroOptions
+
+This will require macros to have the options listed as "requiredMacroOptions." This is helpful if you want to ensure all macros are SECURE.
+
+- Default: false
+- severity: WARNING
+
+Example
+```json
+{
+  "hasRequiredMacroOptions": true,
+  "requiredMacroOptions": ["SECURE", "SRC"]
+}
+```
+
 ### 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.
@@ -122,6 +137,21 @@ This will check each line to ensure that the count of leading spaces can be divi
 - Default: 2
 - Severity: WARNING
 
+### lineEndings
+
+This setting ensures the line endings in a file to conform the configured type. Possible values are `lf`, `crlf` and `off` (off means rule is set to be off). If the value is missing, null or undefined then the check would also be switched off (no default applied).
+
+- Default: "off"
+- Severity: WARNING
+
+Example (to enforce unix line endings):
+
+```json
+{
+  "lineEndings": "lf"
+}
+```
+
 ### 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.
@@ -131,16 +161,16 @@ On *nix systems, it is imperative that autocall macros are in lowercase. When sh
 
 ### maxDataLineLength
 
-Datalines can be very wide, so to avoid the need to increase `maxLineLength` for the entire project, it is possible to raise the line length limit for the data records only. On a related note, as a developer, you should also be aware that code submitted in batch may have a default line length limit which is lower than you expect.  See this [usage note](https://support.sas.com/kb/15/883.html) (and thanks to [sasutils for reminding us](https://github.com/sasjs/lint/issues/47#issuecomment-1064340104)).
+Datalines can be very wide, so to avoid the need to increase `maxLineLength` for the entire project, it is possible to raise the line length limit for the data records only. On a related note, as a developer, you should also be aware that code submitted in batch may have a default line length limit which is lower than you expect. See this [usage note](https://support.sas.com/kb/15/883.html) (and thanks to [sasutils for reminding us](https://github.com/sasjs/lint/issues/47#issuecomment-1064340104)).
 
 This feature will work for the following statements:
 
-* cards
+- cards
-* cards4
+- cards4
-* datalines
+- datalines
-* datalines4
+- datalines4
-* parmcards
+- parmcards
-* parmcards4
+- parmcards4
 
 The `maxDataLineLength` setting is always the _higher_ of `maxDataLineLength` and `maxLineLength` (if you set a lower number, it is ignored).
 
@@ -149,13 +179,13 @@ The `maxDataLineLength` setting is always the _higher_ of `maxDataLineLength` an
 
 See also:
 
- * [hasDoxygenHeader](#hasdoxygenheader)
+- [hasDoxygenHeader](#hasdoxygenheader)
- * [maxHeaderLineLength](#maxheaderlinelength)
+- [maxHeaderLineLength](#maxheaderlinelength)
- * [maxLineLength](#maxlinelength)
+- [maxLineLength](#maxlinelength)
 
 ### maxHeaderLineLength
 
-In a program header it can be necessary to insert items such as URLs or markdown tables, that cannot be split over multiple lines.  To avoid the need to increase `maxLineLength` for the entire project, it is possible to raise the line length limit for the header section only.
+In a program header it can be necessary to insert items such as URLs or markdown tables, that cannot be split over multiple lines. To avoid the need to increase `maxLineLength` for the entire project, it is possible to raise the line length limit for the header section only.
 
 The `maxHeaderLineLength` setting is always the _higher_ of `maxHeaderLineLength` and `maxLineLength` (if you set a lower number, it is ignored).
 
@@ -164,9 +194,9 @@ The `maxHeaderLineLength` setting is always the _higher_ of `maxHeaderLineLength
 
 See also:
 
- * [hasDoxygenHeader](#hasdoxygenheader)
+- [hasDoxygenHeader](#hasdoxygenheader)
- * [maxDataLineLength](#maxdatalinelength)
+- [maxDataLineLength](#maxdatalinelength)
- * [maxLineLength](#maxlinelength)
+- [maxLineLength](#maxlinelength)
 
 ### maxLineLength
 
@@ -181,12 +211,19 @@ We strongly recommend a line length limit, and set the bar at 80. To turn this f
 
 See also:
 
- * [maxDataLineLength](#maxdatalinelength)
+- [maxDataLineLength](#maxdatalinelength)
- * [maxHeaderLineLength](#maxheaderlinelength)
+- [maxHeaderLineLength](#maxheaderlinelength)
+
+### 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
 
 ### 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.
+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/utils/gremlinCharacters.ts](https://github.com/sasjs/lint/blob/main/src/utils/gremlinCharacters.ts)
 
@@ -212,6 +249,13 @@ In addition, when such files are used in URLs, they are often padded with a mess
 - Default: true
 - Severity: WARNING
 
+As an alternative (or in addition) to using a lint rule, you can also set the following in your `.gitignore` file to prevent files with spaces from being committed:
+
+```
+# prevent files/folders with spaces
+**\ **
+```
+
 ### noTabs
 
 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).
@@ -227,6 +271,7 @@ This will highlight lines with trailing spaces. Trailing spaces serve no useful
 - Default: true
 - severity: WARNING
 
+
 ## severityLevel
 
 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:
@@ -247,11 +292,6 @@ This setting allows the default severity to be adjusted. This is helpful when ru
 - "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.
@@ -270,6 +310,12 @@ We're looking to implement the following rules:
 
 We are also investigating some harder stuff, such as automatic indentation and code layout
 
+# Further resources
+
+* Using the linter on terminal: https://vid.4gl.io/w/vmJspCjcBoc5QtzwZkZRvi
+* Longer intro to sasjs lint: https://vid.4gl.io/w/nDtkQFV1E8rtaa2BuM6U5s
+* CLI docs:  https://cli.sasjs.io/lint
+
 # 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?
@@ -279,9 +325,7 @@ 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-9-orange.svg?style=flat-square)](#contributors-)
-[![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)):
@@ -290,18 +334,21 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 <!-- prettier-ignore-start -->
 <!-- markdownlint-disable -->
 <table>
-  <tr>
+  <tbody>
-    <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>
+    <tr>
-    <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" valign="top" width="14.28%"><a href="https://github.com/Carus11"><img src="https://avatars.githubusercontent.com/u/4925828?v=4?s=100" width="100px;" alt="Carus Kyle"/><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://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" valign="top" width="14.28%"><a href="https://github.com/allanbowe"><img src="https://avatars.githubusercontent.com/u/4420615?v=4?s=100" width="100px;" alt="Allan Bowe"/><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://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" valign="top" width="14.28%"><a href="https://www.erudicat.com/"><img src="https://avatars.githubusercontent.com/u/25773492?v=4?s=100" width="100px;" alt="Yury Shkoda"/><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://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" valign="top" width="14.28%"><a href="https://krishna-acondy.io/"><img src="https://avatars.githubusercontent.com/u/2980428?v=4?s=100" width="100px;" alt="Krishna Acondy"/><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/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" valign="top" width="14.28%"><a href="https://github.com/saadjutt01"><img src="https://avatars.githubusercontent.com/u/8914650?v=4?s=100" width="100px;" alt="Muhammad Saad "/><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/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>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/sabhas"><img src="https://avatars.githubusercontent.com/u/82647447?v=4?s=100" width="100px;" alt="Sabir Hassan"/><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>
-  </tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/medjedovicm"><img src="https://avatars.githubusercontent.com/u/18329105?v=4?s=100" width="100px;" alt="Mihajlo Medjedovic"/><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>
-  </tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/VladislavParhomchik"><img src="https://avatars.githubusercontent.com/u/83717836?v=4?s=100" width="100px;" alt="Vladislav Parhomchik"/><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>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/McGwire-Jones"><img src="https://avatars.githubusercontent.com/u/51411005?v=4?s=100" width="100px;" alt="McGwire-Jones"/><br /><sub><b>McGwire-Jones</b></sub></a><br /><a href="https://github.com/sasjs/lint/commits?author=McGwire-Jones" title="Code">💻</a></td>
+    </tr>
+  </tbody>
 </table>
 
 <!-- markdownlint-restore -->

package.json

@@ -43,12 +43,12 @@
     "@types/node": "18.11.18",
     "all-contributors-cli": "6.24.0",
     "jest": "29.3.1",
-    "rimraf": "^3.0.2",
+    "rimraf": "^5.0.10",
     "ts-jest": "29.0.3",
     "typescript": "^4.3.2"
   },
   "dependencies": {
-    "@sasjs/utils": "2.52.0",
+    "@sasjs/utils": "3.5.0",
     "ignore": "5.2.4"
   }
 }

sasjslint-schema.json

@@ -20,9 +20,11 @@
     "noSpacesInFileNames": true,
     "noTabs": true,
     "noTrailingSpaces": true,
-    "lineEndings": "lf",
+    "lineEndings": "off",
     "strictMacroDefinition": true,
-    "ignoreList": ["sajsbuild", "sasjsresults"]
+    "ignoreList": ["sajsbuild", "sasjsresults"],
+    "hasRequiredMacroOptions": false,
+    "requiredMacroOptions": []
   },
   "examples": [
     {
@@ -43,7 +45,9 @@
       "hasMacroParentheses": true,
       "lineEndings": "crlf",
       "strictMacroDefinition": true,
-      "ignoreList": ["sajsbuild", "sasjsresults"]
+      "ignoreList": ["sajsbuild", "sasjsresults"],
+      "hasRequiredMacroOptions": false,
+      "requiredMacroOptions": []
     }
   ],
   "properties": {
@@ -182,9 +186,10 @@
     "lineEndings": {
       "$id": "#/properties/lineEndings",
       "type": "string",
+      "enum": ["lf", "crlf", "off"],
       "title": "lineEndings",
       "description": "Enforces the configured terminating character for each line. Shows a warning when incorrect line endings are present.",
-      "default": "lf",
+      "default": "off",
       "examples": ["lf", "crlf"]
     },
     "strictMacroDefinition": {
@@ -203,6 +208,22 @@
       "default": ["sasjsbuild/", "sasjsresults/"],
       "examples": ["sasjs/tests", "tmp/scratch.sas"]
     },
+    "hasRequiredMacroOptions": {
+      "$id": "#/properties/hasRequiredMacroOptions",
+      "type": "boolean",
+      "title": "hasRequiredMacroOptions",
+      "description": "Enforces required macro options as defined by requiredMacroOptions",
+      "default": false,
+      "examples": [true, false]
+    },
+    "requiredMacroOptions": {
+      "$id": "#/properties/requiredMacroOptions",
+      "type": "array",
+      "title": "requiredMacroOptions",
+      "description": "An array of macro options to require all macros to include.",
+      "default": [],
+      "examples": ["['SECURE']", "['SRC', 'STMT']"]
+    },
     "severityLevel": {
       "$id": "#/properties/severityLevel",
       "type": "object",
@@ -319,6 +340,13 @@
           "type": "string",
           "enum": ["error", "warn"],
           "default": "warn"
+        },
+        "hasRequiredMacroOptions": {
+          "$id": "#/properties/severityLevel/hasRequiredMacroOptions",
+          "title": "hasRequiredMacroOptions",
+          "type": "string",
+          "enum": ["error", "warn"],
+          "default": "warn"
         }
       }
     }

src/format/formatProject.ts

@@ -8,11 +8,12 @@ import { formatFolder } from './formatFolder'
  * @returns {Promise<FormatResult>} Resolves successfully when all SAS files in the current project have been formatted.
  */
 export const formatProject = async (): Promise<FormatResult> => {
-  const projectRoot =
+  const projectRoot = (await getProjectRoot()) || process.currentDir
-    (await getProjectRoot()) || process.projectDir || process.currentDir
   if (!projectRoot) {
     throw new Error('SASjs Project Root was not found.')
   }
 
+  console.info(`Formatting all .sas files under ${projectRoot}`)
+
   return await formatFolder(projectRoot)
 }

src/lint/lintFile.ts

@@ -13,7 +13,7 @@ export const lintFile = async (
   filePath: string,
   configuration?: LintConfig
 ): Promise<Diagnostic[]> => {
-  if (await isIgnored(filePath)) return []
+  if (await isIgnored(filePath, configuration)) return []
 
   const config = configuration || (await getLintConfig())
   const text = await readFile(filePath)

src/lint/lintFolder.ts

@@ -26,7 +26,7 @@ export const lintFolder = async (
   const config = configuration || (await getLintConfig())
   let diagnostics: Map<string, Diagnostic[]> = new Map<string, Diagnostic[]>()
 
-  if (await isIgnored(folderPath)) return diagnostics
+  if (await isIgnored(folderPath, config)) return diagnostics
 
   const fileNames = await listSasFiles(folderPath)
   await asyncForEach(fileNames, async (fileName) => {

src/lint/lintProject.ts

@@ -6,10 +6,12 @@ import { lintFolder } from './lintFolder'
  * @returns {Promise<Map<string, Diagnostic[]>>} Resolves with a map with array of diagnostic objects, each containing a warning, line number and column number, and grouped by file path.
  */
 export const lintProject = async () => {
-  const projectRoot =
+  const projectRoot = (await getProjectRoot()) || process.currentDir
-    (await getProjectRoot()) || process.projectDir || process.currentDir
   if (!projectRoot) {
     throw new Error('SASjs Project Root was not found.')
   }
+
+  console.info(`Linting all .sas files under ${projectRoot}`)
+
   return await lintFolder(projectRoot)
 }

src/rules/file/hasRequiredMacroOptions.spec.ts

@@ -0,0 +1,123 @@
+import { LintConfig, Severity } from '../../types'
+import { hasRequiredMacroOptions } from './hasRequiredMacroOptions'
+
+describe('hasRequiredMacroOptions - test', () => {
+  it('should return an empty array when the content has the required macro option(s)', () => {
+    const contentSecure = '%macro somemacro/ SECURE;'
+    const configSecure = new LintConfig({
+      hasRequiredMacroOptions: true,
+      requiredMacroOptions: ['SECURE']
+    })
+    expect(hasRequiredMacroOptions.test(contentSecure, configSecure)).toEqual(
+      []
+    )
+
+    const contentSecureSrc = '%macro somemacro/ SECURE SRC;'
+    const configSecureSrc = new LintConfig({
+      hasRequiredMacroOptions: true,
+      requiredMacroOptions: ['SECURE', 'SRC']
+    })
+    expect(
+      hasRequiredMacroOptions.test(contentSecureSrc, configSecureSrc)
+    ).toEqual([])
+
+    const configEmpty = new LintConfig({
+      hasRequiredMacroOptions: true,
+      requiredMacroOptions: ['']
+    })
+    expect(hasRequiredMacroOptions.test(contentSecureSrc, configEmpty)).toEqual(
+      []
+    )
+  })
+
+  it('should return an array with a single diagnostic when Macro does not contain the required option', () => {
+    const configSecure = new LintConfig({
+      hasRequiredMacroOptions: true,
+      requiredMacroOptions: ['SECURE']
+    })
+
+    const contentMinXOperator = '%macro somemacro(var1, var2)/minXoperator;'
+    expect(
+      hasRequiredMacroOptions.test(contentMinXOperator, configSecure)
+    ).toEqual([
+      {
+        message: `Macro 'somemacro' does not contain the required option 'SECURE'`,
+        lineNumber: 1,
+        startColumnNumber: 0,
+        endColumnNumber: 0,
+        severity: Severity.Warning
+      }
+    ])
+
+    const contentSecureSplit = '%macro somemacro(var1, var2)/ SE CURE;'
+    expect(
+      hasRequiredMacroOptions.test(contentSecureSplit, configSecure)
+    ).toEqual([
+      {
+        message: `Macro 'somemacro' does not contain the required option 'SECURE'`,
+        lineNumber: 1,
+        startColumnNumber: 0,
+        endColumnNumber: 0,
+        severity: Severity.Warning
+      }
+    ])
+
+    const contentNoOption = '%macro somemacro(var1, var2);'
+    expect(hasRequiredMacroOptions.test(contentNoOption, configSecure)).toEqual(
+      [
+        {
+          message: `Macro 'somemacro' does not contain the required option 'SECURE'`,
+          lineNumber: 1,
+          startColumnNumber: 0,
+          endColumnNumber: 0,
+          severity: Severity.Warning
+        }
+      ]
+    )
+  })
+
+  it('should return an array with a two diagnostics when Macro does not contain the required options', () => {
+    const configSrcStmt = new LintConfig({
+      hasRequiredMacroOptions: true,
+      requiredMacroOptions: ['SRC', 'STMT'],
+      severityLevel: { hasRequiredMacroOptions: 'warn' }
+    })
+    const contentMinXOperator = '%macro somemacro(var1, var2)/minXoperator;'
+    expect(
+      hasRequiredMacroOptions.test(contentMinXOperator, configSrcStmt)
+    ).toEqual([
+      {
+        message: `Macro 'somemacro' does not contain the required option 'SRC'`,
+        lineNumber: 1,
+        startColumnNumber: 0,
+        endColumnNumber: 0,
+        severity: Severity.Warning
+      },
+      {
+        message: `Macro 'somemacro' does not contain the required option 'STMT'`,
+        lineNumber: 1,
+        startColumnNumber: 0,
+        endColumnNumber: 0,
+        severity: Severity.Warning
+      }
+    ])
+  })
+
+  it('should return an array with a one diagnostic when Macro contains 1 of 2 required options', () => {
+    const configSrcStmt = new LintConfig({
+      hasRequiredMacroOptions: true,
+      requiredMacroOptions: ['SRC', 'STMT'],
+      severityLevel: { hasRequiredMacroOptions: 'error' }
+    })
+    const contentSrc = '%macro somemacro(var1, var2)/ SRC;'
+    expect(hasRequiredMacroOptions.test(contentSrc, configSrcStmt)).toEqual([
+      {
+        message: `Macro 'somemacro' does not contain the required option 'STMT'`,
+        lineNumber: 1,
+        startColumnNumber: 0,
+        endColumnNumber: 0,
+        severity: Severity.Error
+      }
+    ])
+  })
+})

src/rules/file/hasRequiredMacroOptions.ts

@@ -0,0 +1,52 @@
+import { Diagnostic, LintConfig, Macro, Severity } from '../../types'
+import { FileLintRule } from '../../types/LintRule'
+import { LintRuleType } from '../../types/LintRuleType'
+import { parseMacros } from '../../utils/parseMacros'
+
+const name = 'hasRequiredMacroOptions'
+const description = 'Enforce required macro options'
+const message = 'Macro defined without required options'
+
+const processOptions = (
+  macro: Macro,
+  diagnostics: Diagnostic[],
+  config?: LintConfig
+): void => {
+  const optionsPresent = macro.declaration.split('/')?.[1]?.trim() ?? ''
+  const severity = config?.severityLevel[name] || Severity.Warning
+
+  config?.requiredMacroOptions.forEach((option) => {
+    if (!optionsPresent.includes(option)) {
+      diagnostics.push({
+        message: `Macro '${macro.name}' does not contain the required option '${option}'`,
+        lineNumber: macro.startLineNumbers[0],
+        startColumnNumber: 0,
+        endColumnNumber: 0,
+        severity
+      })
+    }
+  })
+}
+
+const test = (value: string, config?: LintConfig) => {
+  const diagnostics: Diagnostic[] = []
+
+  const macros = parseMacros(value, config)
+
+  macros.forEach((macro) => {
+    processOptions(macro, diagnostics, config)
+  })
+
+  return diagnostics
+}
+
+/**
+ * Lint rule that checks if a macro has the required options
+ */
+export const hasRequiredMacroOptions: FileLintRule = {
+  type: LintRuleType.File,
+  name,
+  description,
+  message,
+  test
+}

src/rules/file/index.ts

@@ -4,3 +4,4 @@ export { hasMacroParentheses } from './hasMacroParentheses'
 export { lineEndings } from './lineEndings'
 export { noNestedMacros } from './noNestedMacros'
 export { strictMacroDefinition } from './strictMacroDefinition'
+export { hasRequiredMacroOptions } from './hasRequiredMacroOptions'

src/types/LineEndings.ts

@@ -1,4 +1,5 @@
 export enum LineEndings {
   LF = 'lf',
-  CRLF = 'crlf'
+  CRLF = 'crlf',
+  OFF = 'off'
 }

src/types/LintConfig.spec.ts

@@ -1,3 +1,4 @@
+import { hasRequiredMacroOptions } from '../rules/file'
 import { LineEndings } from './LineEndings'
 import { LintConfig } from './LintConfig'
 import { LintRuleType } from './LintRuleType'
@@ -168,7 +169,9 @@ describe('LintConfig', () => {
       hasMacroNameInMend: true,
       noNestedMacros: true,
       hasMacroParentheses: true,
-      noGremlins: true
+      hasRequiredMacroOptions: true,
+      noGremlins: true,
+      lineEndings: 'lf'
     })
 
     expect(config).toBeTruthy()
@@ -186,7 +189,7 @@ describe('LintConfig', () => {
     expect(config.lineLintRules[5].name).toEqual('noGremlins')
     expect(config.lineLintRules[5].type).toEqual(LintRuleType.Line)
 
-    expect(config.fileLintRules.length).toEqual(6)
+    expect(config.fileLintRules.length).toEqual(7)
     expect(config.fileLintRules[0].name).toEqual('lineEndings')
     expect(config.fileLintRules[0].type).toEqual(LintRuleType.File)
     expect(config.fileLintRules[1].name).toEqual('hasDoxygenHeader')
@@ -199,6 +202,8 @@ describe('LintConfig', () => {
     expect(config.fileLintRules[4].type).toEqual(LintRuleType.File)
     expect(config.fileLintRules[5].name).toEqual('strictMacroDefinition')
     expect(config.fileLintRules[5].type).toEqual(LintRuleType.File)
+    expect(config.fileLintRules[6].name).toEqual('hasRequiredMacroOptions')
+    expect(config.fileLintRules[6].type).toEqual(LintRuleType.File)
 
     expect(config.pathLintRules.length).toEqual(2)
     expect(config.pathLintRules[0].name).toEqual('noSpacesInFileNames')
@@ -206,4 +211,25 @@ describe('LintConfig', () => {
     expect(config.pathLintRules[1].name).toEqual('lowerCaseFileNames')
     expect(config.pathLintRules[1].type).toEqual(LintRuleType.Path)
   })
+
+  it('should throw an error with an invalid value for requiredMacroOptions', () => {
+    expect(
+      () =>
+        new LintConfig({
+          hasRequiredMacroOptions: true,
+          requiredMacroOptions: 'test'
+        })
+    ).toThrowError(
+      `Property "requiredMacroOptions" can only be an array of strings.`
+    )
+    expect(
+      () =>
+        new LintConfig({
+          hasRequiredMacroOptions: true,
+          requiredMacroOptions: ['test', 2]
+        })
+    ).toThrowError(
+      `Property "requiredMacroOptions" has invalid type of values. It can only contain strings.`
+    )
+  })
 })

src/types/LintConfig.ts

@@ -4,7 +4,8 @@ import {
   noNestedMacros,
   hasMacroParentheses,
   lineEndings,
-  strictMacroDefinition
+  strictMacroDefinition,
+  hasRequiredMacroOptions
 } from '../rules/file'
 import {
   indentationMultiple,
@@ -40,6 +41,7 @@ export class LintConfig {
   readonly lineEndings: LineEndings = LineEndings.LF
   readonly defaultHeader: string = getDefaultHeader()
   readonly severityLevel: { [key: string]: Severity } = {}
+  readonly requiredMacroOptions: string[] = []
 
   constructor(json?: any) {
     if (json?.ignoreList) {
@@ -82,8 +84,7 @@ export class LintConfig {
       }
     }
 
-    this.fileLintRules.push(lineEndings)
+    if (json?.lineEndings && json.lineEndings !== LineEndings.OFF) {
-    if (json?.lineEndings) {
       if (
         json.lineEndings !== LineEndings.LF &&
         json.lineEndings !== LineEndings.CRLF
@@ -92,6 +93,7 @@ export class LintConfig {
           `Invalid value for lineEndings: can be ${LineEndings.LF} or ${LineEndings.CRLF}`
         )
       }
+      this.fileLintRules.push(lineEndings)
       this.lineEndings = json.lineEndings
     }
 
@@ -132,6 +134,31 @@ export class LintConfig {
       this.fileLintRules.push(strictMacroDefinition)
     }
 
+    if (json?.hasRequiredMacroOptions) {
+      this.fileLintRules.push(hasRequiredMacroOptions)
+
+      if (json?.requiredMacroOptions) {
+        if (
+          Array.isArray(json.requiredMacroOptions) &&
+          json.requiredMacroOptions.length > 0
+        ) {
+          json.requiredMacroOptions.forEach((item: any) => {
+            if (typeof item === 'string') {
+              this.requiredMacroOptions.push(item)
+            } else {
+              throw new Error(
+                `Property "requiredMacroOptions" has invalid type of values. It can only contain strings.`
+              )
+            }
+          })
+        } else {
+          throw new Error(
+            `Property "requiredMacroOptions" can only be an array of strings.`
+          )
+        }
+      }
+    }
+
     if (json?.noGremlins !== false) {
       this.lineLintRules.push(noGremlins)
 

src/utils/getLintConfig.spec.ts

@@ -2,7 +2,7 @@ import * as fileModule from '@sasjs/utils/file'
 import { LintConfig } from '../types/LintConfig'
 import { getLintConfig } from './getLintConfig'
 
-const expectedFileLintRulesCount = 6
+const expectedFileLintRulesCount = 5
 const expectedLineLintRulesCount = 6
 const expectedPathLintRulesCount = 2
 

src/utils/getLintConfig.ts

@@ -1,7 +1,9 @@
 import path from 'path'
+import os from 'os'
 import { LintConfig } from '../types/LintConfig'
 import { readFile } from '@sasjs/utils/file'
 import { getProjectRoot } from './getProjectRoot'
+import { LineEndings } from '../types/LineEndings'
 
 export const getDefaultHeader = () =>
   `/**{lineEnding}  @file{lineEnding}  @brief <Your brief here>{lineEnding}  <h4> SAS Macros </h4>{lineEnding}**/`
@@ -10,6 +12,7 @@ export const getDefaultHeader = () =>
  * Default configuration that is used when a .sasjslint file is not found
  */
 export const DefaultLintConfiguration = {
+  lineEndings: LineEndings.OFF,
   noTrailingSpaces: true,
   noEncodedPasswords: true,
   hasDoxygenHeader: true,
@@ -29,14 +32,15 @@ export const DefaultLintConfiguration = {
 }
 
 /**
- * Fetches the config from the .sasjslint file and creates a LintConfig object.
+ * Fetches the config from the .sasjslint file (at project root or home directory) and creates a LintConfig object.
  * Returns the default configuration when a .sasjslint file is unavailable.
  * @returns {Promise<LintConfig>} resolves with an object representing the current lint configuration.
  */
 export async function getLintConfig(): Promise<LintConfig> {
   const projectRoot = await getProjectRoot()
+  const lintFileLocation = projectRoot || os.homedir()
   const configuration = await readFile(
-    path.join(projectRoot, '.sasjslint')
+    path.join(lintFileLocation, '.sasjslint')
   ).catch((_) => {
     return JSON.stringify(DefaultLintConfiguration)
   })

src/utils/getProjectRoot.ts

@@ -1,4 +1,5 @@
 import path from 'path'
+import os from 'os'
 import { fileExists } from '@sasjs/utils/file'
 
 /**
@@ -11,10 +12,11 @@ export async function getProjectRoot(): Promise<string> {
   let rootFound = false
   let i = 1
   let currentLocation = process.cwd()
+  const homeDir = os.homedir()
 
   const maxLevels = currentLocation.split(path.sep).length
 
-  while (i <= maxLevels && !rootFound) {
+  while (i <= maxLevels && !rootFound && currentLocation !== homeDir) {
     const isRoot = await fileExists(path.join(currentLocation, '.sasjslint'))
 
     if (isRoot) {

tsconfig.json

@@ -5,7 +5,7 @@
           "DOM",
           "ES2019.String"
       ],
-      "target": "es5",
+      "target": "es6",
       "module": "commonjs",
       "downlevelIteration": true,
       "moduleResolution": "node",
@@ -23,4 +23,4 @@
       "**/*.spec.ts",
       "**/example.ts"
   ]
-}
+}