Merge pull request #224 from sasjs/rimraf-and-bump

fix: bump utils, fix ci rimraf

.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 }}

.github/workflows/build.yml

@@ -28,6 +28,8 @@ jobs:
         run: npm run lint
       - name: Run Unit Tests
         run: npm test
+      - name: Install rimraf
+        run: npm i -g rimraf
       - name: Build Package
         run: npm run package:lib
         env:

.github/workflows/publish.yml

@@ -18,6 +18,8 @@ jobs:
         run: npm ci
       - name: Check Code Style
         run: npm run lint
+      - name: Install rimraf
+        run: npm i -g rimraf
       - name: Build Project
         run: npm run build
       - name: Semantic Release

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,10 +21,11 @@ Configuration is via a `.sasjslint` file with the following structure (these are
 
 ```json
 {
-  "noEncodedPasswords": true,
   "hasDoxygenHeader": true,
   "hasMacroNameInMend": true,
   "hasMacroParentheses": true,
+  "hasRequiredMacroOptions": false,
+  "requiredMacroOptions": ["SECURE", "SRC"],
   "ignoreList": ["sasjsbuild/", "sasjsresults/"],
   "indentationMultiple": 2,
   "lineEndings": "off",
@@ -30,6 +33,7 @@ Configuration is via a `.sasjslint` file with the following structure (these are
   "maxDataLineLength": 80,
   "maxHeaderLineLength": 80,
   "maxLineLength": 80,
+  "noEncodedPasswords": true,
   "noNestedMacros": true,
   "noGremlins": true,
   "noSpacesInFileNames": true,
@@ -86,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.
@@ -114,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.
@@ -202,6 +214,13 @@ See also:
 - [maxDataLineLength](#maxdatalinelength)
 - [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.
@@ -252,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:
@@ -290,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?
@@ -299,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-8-orange.svg?style=flat-square)](#contributors-)
-
+[![All Contributors](https://img.shields.io/badge/all_contributors-9-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)):
@@ -310,18 +334,21 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 <!-- 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>
+  <tbody>
+    <tr>
+      <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" 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" 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" 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" 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" 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>
+      <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" 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

@@ -3,7 +3,7 @@
   "description": "Linting and formatting for SAS code",
   "scripts": {
     "test": "jest --coverage",
-    "build": "rimraf build && tsc",
+    "build": "npx rimraf build && tsc",
     "preinstall": "node checkNodeVersion",
     "prebuild": "node checkNodeVersion",
     "prepublishOnly": "cp -r ./build/* . && rm -rf ./build && rm -rf ./src && rm tsconfig.json",
@@ -41,14 +41,12 @@
   "devDependencies": {
     "@types/jest": "29.2.5",
     "@types/node": "18.11.18",
-    "all-contributors-cli": "6.24.0",
     "jest": "29.3.1",
-    "rimraf": "^3.0.2",
     "ts-jest": "29.0.3",
     "typescript": "^4.3.2"
   },
   "dependencies": {
-    "@sasjs/utils": "2.52.0",
+    "@sasjs/utils": "3.5.2",
     "ignore": "5.2.4"
   }
 }

sasjslint-schema.json

@@ -22,7 +22,9 @@
     "noTrailingSpaces": true,
     "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": {
@@ -204,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",
@@ -320,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/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/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/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,6 +169,7 @@ describe('LintConfig', () => {
       hasMacroNameInMend: true,
       noNestedMacros: true,
       hasMacroParentheses: true,
+      hasRequiredMacroOptions: true,
       noGremlins: true,
       lineEndings: 'lf'
     })
@@ -187,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')
@@ -200,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')
@@ -207,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) {
@@ -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)
 

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"
   ]
-}
+}