1
0
mirror of https://github.com/sasjs/lint.git synced 2025-12-10 17:34:36 +00:00

Compare commits

...

30 Commits

Author SHA1 Message Date
dependabot[bot]
0df30d698e chore(deps-dev): bump ts-jest from 29.0.3 to 29.3.2
Bumps [ts-jest](https://github.com/kulshekhar/ts-jest) from 29.0.3 to 29.3.2.
- [Release notes](https://github.com/kulshekhar/ts-jest/releases)
- [Changelog](https://github.com/kulshekhar/ts-jest/blob/main/CHANGELOG.md)
- [Commits](https://github.com/kulshekhar/ts-jest/compare/v29.0.3...v29.3.2)

---
updated-dependencies:
- dependency-name: ts-jest
  dependency-version: 29.3.2
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-05-01 08:17:05 +00:00
Allan Bowe
6172b3a641 Merge pull request #224 from sasjs/rimraf-and-bump
fix: bump utils, fix ci rimraf
2025-02-27 12:02:48 +00:00
47811e56b5 fix: bump utils, fix ci rimraf 2025-02-27 12:59:06 +01:00
Allan Bowe
490cd43373 Merge pull request #220 from sasjs/rev
Rev
2025-02-14 14:38:34 +00:00
bd8d2b9561 chore: package-lock.json 2025-02-14 14:46:13 +01:00
5b9269adf8 chore: package-lock.json 2025-02-14 14:43:39 +01:00
Allan Bowe
2f0551afc2 Merge pull request #218 from glM26/main
Fix: Update @sasjs/utils to newest version
2025-02-14 12:14:10 +00:00
Allan Bowe
86465c3cf1 chore: dependabot limit 2025-02-14 12:13:00 +00:00
Allan Bowe
faedb5add9 Merge pull request #219 from sasjs/rev
chore: removing reviewers from lottery
2025-02-14 09:26:10 +00:00
Allan Bowe
6d8f7549a2 chore: removing reviewers from lottery
## Issue

Link any related issue(s) in this section.

## Intent

What this PR intends to achieve.

## Implementation

What code changes have been made to achieve the intent.

## Checks

- [ ] Code is formatted correctly (`npm run lint:fix`).
- [ ] Any new functionality has been unit tested.
- [ ] All unit tests are passing (`npm test`).
- [ ] All CI checks are green.
- [ ] sasjslint-schema.json is updated with any new / changed functionality
- [ ] JSDoc comments have been added or updated.
- [ ] Reviewer is assigned.
2025-02-14 09:25:08 +00:00
Allan Bowe
1815f73110 chore: removing reviewers from lottery 2025-02-14 09:17:54 +00:00
glM26
2ec507f844 fix: update target in tsconfig.json to es6
Some features in newer versions of dependencies require at least es6
2025-02-14 08:10:51 +01:00
glM26
2de78a9c6d fix: update @sasjs/utils to version 3.5.0 2025-02-14 08:09:58 +01:00
Allan Bowe
fb135e602e Merge pull request #217 from sasjs/readme
fix: README update (to trigger release with new GH_TOKEN)
2025-01-29 16:56:00 +00:00
Allan Bowe
a167f55063 fix: README update (to trigger release with new GH_TOKEN) 2025-01-29 16:55:02 +00:00
Allan Bowe
fe88d4e24a chore(docs): updating readme to show new options in config json 2025-01-29 16:51:05 +00:00
Allan Bowe
05121b7ee4 Merge pull request #216 from sasjs/all-contributors/add-McGwire-Jones
add McGwire-Jones as a contributor for code
2025-01-29 16:45:29 +00:00
allcontributors[bot]
cbfcd8edde update .all-contributorsrc [skip ci] 2025-01-29 16:43:53 +00:00
allcontributors[bot]
23bd905cff update README.md [skip ci] 2025-01-29 16:43:52 +00:00
Allan Bowe
eb7f70e83a Merge pull request #215 from McGwire-Jones/add-required-macros-check
Add required macros check
2025-01-29 16:31:40 +00:00
mac.homelab
7f9ed5e61e fix: styling issue 2025-01-29 11:27:01 -05:00
mac.homelab
63255fa3c8 fix: made optionsPresent a const 2025-01-29 10:36:38 -05:00
mac.homelab
00af205a55 fix: updated content/config variable names in tests 2025-01-29 10:36:21 -05:00
mac.homelab
e74663ba54 Added example for hasRequiredMacroOptions to README 2025-01-28 10:56:26 -05:00
mac.homelab
a9cb4d8dac updated sasjslint-schema 2025-01-28 10:20:55 -05:00
McGwire-Jones
ed58b288b5 Update README.md 2025-01-28 09:57:07 -05:00
mac.homelab
be173d2e2b feat: added hasRequiredMacroOptions 2025-01-28 09:55:11 -05:00
Allan Bowe
3e4809c352 Merge pull request #214 from cjdinger/main
Add clarification about SASjs and SAS Institute
2025-01-22 21:25:57 +00:00
Chris Hemedinger
f0ab349bf7 Add clarification about SASjs and SAS Institute 2025-01-22 16:11:55 -05:00
Allan Bowe
0c5588023d Update README.md 2023-11-23 09:40:29 +00:00
16 changed files with 3148 additions and 2000 deletions

View File

@@ -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"
}

View File

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

View File

@@ -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

View File

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

View File

@@ -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:

View File

@@ -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

View File

@@ -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 -->

4776
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@@ -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",
"ts-jest": "29.3.2",
"typescript": "^4.3.2"
},
"dependencies": {
"@sasjs/utils": "2.52.0",
"@sasjs/utils": "3.5.2",
"ignore": "5.2.4"
}
}

View File

@@ -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"
}
}
}

View File

@@ -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
}
])
})
})

View File

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

View File

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

View File

@@ -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.`
)
})
})

View File

@@ -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)

View File

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