@sasjs/lint 2.4.0 → 2.4.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.all-contributorsrc +11 -1
- package/README.md +41 -37
- package/package.json +1 -1
package/.all-contributorsrc
CHANGED
|
@@ -101,6 +101,15 @@
|
|
|
101
101
|
"test",
|
|
102
102
|
"review"
|
|
103
103
|
]
|
|
104
|
+
},
|
|
105
|
+
{
|
|
106
|
+
"login": "McGwire-Jones",
|
|
107
|
+
"name": "McGwire-Jones",
|
|
108
|
+
"avatar_url": "https://avatars.githubusercontent.com/u/51411005?v=4",
|
|
109
|
+
"profile": "https://github.com/McGwire-Jones",
|
|
110
|
+
"contributions": [
|
|
111
|
+
"code"
|
|
112
|
+
]
|
|
104
113
|
}
|
|
105
114
|
],
|
|
106
115
|
"contributorsPerLine": 7,
|
|
@@ -109,5 +118,6 @@
|
|
|
109
118
|
"repoType": "github",
|
|
110
119
|
"repoHost": "https://github.com",
|
|
111
120
|
"skipCi": true,
|
|
112
|
-
"commitConvention": "none"
|
|
121
|
+
"commitConvention": "none",
|
|
122
|
+
"commitType": "docs"
|
|
113
123
|
}
|
package/README.md
CHANGED
|
@@ -21,10 +21,11 @@ Configuration is via a `.sasjslint` file with the following structure (these are
|
|
|
21
21
|
|
|
22
22
|
```json
|
|
23
23
|
{
|
|
24
|
-
"noEncodedPasswords": true,
|
|
25
24
|
"hasDoxygenHeader": true,
|
|
26
25
|
"hasMacroNameInMend": true,
|
|
27
26
|
"hasMacroParentheses": true,
|
|
27
|
+
"hasRequiredMacroOptions": false,
|
|
28
|
+
"requiredMacroOptions": ["SECURE", "SRC"],
|
|
28
29
|
"ignoreList": ["sasjsbuild/", "sasjsresults/"],
|
|
29
30
|
"indentationMultiple": 2,
|
|
30
31
|
"lineEndings": "off",
|
|
@@ -32,6 +33,7 @@ Configuration is via a `.sasjslint` file with the following structure (these are
|
|
|
32
33
|
"maxDataLineLength": 80,
|
|
33
34
|
"maxHeaderLineLength": 80,
|
|
34
35
|
"maxLineLength": 80,
|
|
36
|
+
"noEncodedPasswords": true,
|
|
35
37
|
"noNestedMacros": true,
|
|
36
38
|
"noGremlins": true,
|
|
37
39
|
"noSpacesInFileNames": true,
|
|
@@ -88,13 +90,6 @@ If creating a new value, use `{lineEnding}` instead of `\n`, eg as follows:
|
|
|
88
90
|
}
|
|
89
91
|
```
|
|
90
92
|
|
|
91
|
-
### noEncodedPasswords
|
|
92
|
-
|
|
93
|
-
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.
|
|
94
|
-
|
|
95
|
-
- Default: true
|
|
96
|
-
- Severity: ERROR
|
|
97
|
-
|
|
98
93
|
### hasDoxygenHeader
|
|
99
94
|
|
|
100
95
|
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.
|
|
@@ -116,6 +111,21 @@ As per the example [here](https://github.com/sasjs/lint/issues/20), macros defin
|
|
|
116
111
|
- Default: true
|
|
117
112
|
- Severity: WARNING
|
|
118
113
|
|
|
114
|
+
### hasRequiredMacroOptions
|
|
115
|
+
|
|
116
|
+
This will require macros to have the options listed as "requiredMacroOptions." This is helpful if you want to ensure all macros are SECURE.
|
|
117
|
+
|
|
118
|
+
- Default: false
|
|
119
|
+
- severity: WARNING
|
|
120
|
+
|
|
121
|
+
Example
|
|
122
|
+
```json
|
|
123
|
+
{
|
|
124
|
+
"hasRequiredMacroOptions": true,
|
|
125
|
+
"requiredMacroOptions": ["SECURE", "SRC"]
|
|
126
|
+
}
|
|
127
|
+
```
|
|
128
|
+
|
|
119
129
|
### ignoreList
|
|
120
130
|
|
|
121
131
|
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.
|
|
@@ -204,6 +214,13 @@ See also:
|
|
|
204
214
|
- [maxDataLineLength](#maxdatalinelength)
|
|
205
215
|
- [maxHeaderLineLength](#maxheaderlinelength)
|
|
206
216
|
|
|
217
|
+
### noEncodedPasswords
|
|
218
|
+
|
|
219
|
+
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.
|
|
220
|
+
|
|
221
|
+
- Default: true
|
|
222
|
+
- Severity: ERROR
|
|
223
|
+
|
|
207
224
|
### noGremlins
|
|
208
225
|
|
|
209
226
|
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.
|
|
@@ -254,20 +271,6 @@ This will highlight lines with trailing spaces. Trailing spaces serve no useful
|
|
|
254
271
|
- Default: true
|
|
255
272
|
- severity: WARNING
|
|
256
273
|
|
|
257
|
-
### hasRequiredMacroOptions
|
|
258
|
-
|
|
259
|
-
This will require macros to have the options listed as "requiredMacroOptions." This is helpful if you want to ensure all macros are SECURE.
|
|
260
|
-
|
|
261
|
-
- Default: false
|
|
262
|
-
- severity: WARNING
|
|
263
|
-
|
|
264
|
-
Example
|
|
265
|
-
```json
|
|
266
|
-
{
|
|
267
|
-
"hasRequiredMacroOptions": true,
|
|
268
|
-
"requiredMacroOptions": ["SECURE", "SRC"]
|
|
269
|
-
}
|
|
270
|
-
```
|
|
271
274
|
|
|
272
275
|
## severityLevel
|
|
273
276
|
|
|
@@ -322,9 +325,7 @@ Contact [Allan Bowe](https://www.linkedin.com/in/allanbowe/) for further details
|
|
|
322
325
|
# Contributors ✨
|
|
323
326
|
|
|
324
327
|
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
|
|
325
|
-
|
|
326
|
-
[](#contributors-)
|
|
327
|
-
|
|
328
|
+
[](#contributors-)
|
|
328
329
|
<!-- ALL-CONTRIBUTORS-BADGE:END -->
|
|
329
330
|
|
|
330
331
|
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
|
|
@@ -333,18 +334,21 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
|
|
|
333
334
|
<!-- prettier-ignore-start -->
|
|
334
335
|
<!-- markdownlint-disable -->
|
|
335
336
|
<table>
|
|
336
|
-
<
|
|
337
|
-
<
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
<
|
|
347
|
-
|
|
337
|
+
<tbody>
|
|
338
|
+
<tr>
|
|
339
|
+
<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>
|
|
340
|
+
<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>
|
|
341
|
+
<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>
|
|
342
|
+
<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>
|
|
343
|
+
<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>
|
|
344
|
+
<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>
|
|
345
|
+
<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>
|
|
346
|
+
</tr>
|
|
347
|
+
<tr>
|
|
348
|
+
<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>
|
|
349
|
+
<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>
|
|
350
|
+
</tr>
|
|
351
|
+
</tbody>
|
|
348
352
|
</table>
|
|
349
353
|
|
|
350
354
|
<!-- markdownlint-restore -->
|
package/package.json
CHANGED