mirror of
https://github.com/sasjs/lint.git
synced 2025-12-10 09:34:34 +00:00
Compare commits
88 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
f7f989fabd | ||
|
|
850cf85ef1 | ||
|
|
3dc304fffc | ||
|
|
e329529484 | ||
|
|
15190bfe88 | ||
|
|
bc011c4b47 | ||
|
|
a95c083b61 | ||
|
|
96fb384ec9 | ||
|
|
21fd4e8fcc | ||
|
|
ac595c65d0 | ||
|
|
e5763ce529 | ||
|
|
4729f04589 | ||
|
|
596d56c906 | ||
|
|
32956db8b2 | ||
|
|
7b58c455dc | ||
|
|
c86fd7dd1d | ||
|
|
34e9a7b139 | ||
|
|
5de3d33c1c | ||
|
|
3a6a5d30e3 | ||
|
|
0f629c4aca | ||
|
|
ae4c5e8347 | ||
|
|
3c700a97fc | ||
|
|
d113ef4ddd | ||
|
|
dce9453680 | ||
|
|
e76abc2db2 | ||
|
|
1e70b9debc | ||
|
|
984915fe47 | ||
|
|
2687a8fa46 | ||
|
|
3da3e1e134 | ||
|
|
abc2f75dc0 | ||
|
|
060b838f21 | ||
|
|
cd90b0850a | ||
|
|
db2dbb1c69 | ||
|
|
59f7e71919 | ||
|
|
6fd941aa2d | ||
|
|
93124bec5b | ||
|
|
bcb50b9968 | ||
|
|
d28d32d441 | ||
|
|
519a0164b5 | ||
|
|
99813f04c0 | ||
|
|
eb5a1bbbcb | ||
|
|
0c22ade942 | ||
|
|
33a57c3163 | ||
|
|
c2209cbe0e | ||
|
|
fe974050f7 | ||
|
|
1402802f0a | ||
|
|
36b3a7f319 | ||
|
|
c56887d6e6 | ||
|
|
031a323839 | ||
|
|
c9b6c3af95 | ||
|
|
cc33ebb6e6 | ||
|
|
5c130c7a0e | ||
|
|
bc3320adcb | ||
|
|
8c9d85a729 | ||
|
|
87a3ab3ac1 | ||
|
|
d317275eb3 | ||
|
|
99aec59dd1 | ||
|
|
59ccffeba7 | ||
|
|
b87fb4dca6 | ||
|
|
68226318a8 | ||
|
|
abec0ee583 | ||
|
|
35cefe877d | ||
|
|
205bd0c8bc | ||
|
|
2e85cbab2f | ||
|
|
64c413d618 | ||
|
|
904f825ac6 | ||
|
|
5516a3e0a5 | ||
|
|
e94bf3bcd1 | ||
|
|
a9a3a67f3d | ||
|
|
524439fba0 | ||
|
|
883b0f69f7 | ||
|
|
1808d9851a | ||
|
|
39b8c4b0c4 | ||
|
|
3530badf49 | ||
|
|
3b130a797e | ||
|
|
3970f05dc9 | ||
|
|
443bdc0a50 | ||
|
|
2f07bfa0a1 | ||
|
|
86554a074c | ||
|
|
5782886bdc | ||
|
|
a0e2c2d843 | ||
|
|
82bef9f26b | ||
|
|
986aa18197 | ||
|
|
68e0c85efd | ||
|
|
d7b90d33ab | ||
|
|
8dec4f7129 | ||
|
|
fb4cc2dd20 | ||
|
|
09e2d051c4 |
7
.github/dependabot.yml
vendored
Normal file
7
.github/dependabot.yml
vendored
Normal file
@@ -0,0 +1,7 @@
|
||||
version: 2
|
||||
updates:
|
||||
- package-ecosystem: npm
|
||||
directory: "/"
|
||||
schedule:
|
||||
interval: daily
|
||||
open-pull-requests-limit: 10
|
||||
@@ -6,5 +6,8 @@
|
||||
"maxLineLength": 80,
|
||||
"lowerCaseFileNames": true,
|
||||
"noTabIndentation": true,
|
||||
"indentationMultiple": 2
|
||||
"indentationMultiple": 2,
|
||||
"hasMacroNameInMend": true,
|
||||
"noNestedMacros": true,
|
||||
"hasMacroParentheses": true
|
||||
}
|
||||
@@ -16,5 +16,6 @@ What code changes have been made to achieve the intent.
|
||||
- [ ] 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.
|
||||
|
||||
144
README.md
144
README.md
@@ -1,2 +1,142 @@
|
||||
# lint
|
||||
Linting and formatting for SAS® code
|
||||
[](https://dependabot.com)
|
||||
|
||||
# SAS Code linting and formatting
|
||||
|
||||
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.
|
||||
|
||||
## Linting
|
||||
@sasjs/lint is used by the following products:
|
||||
|
||||
* [@sasjs/vscode-extension](https://github.com/sasjs/vscode-extension) - just download SASjs in the VSCode marketplace, and select view/problems in the menu bar.
|
||||
* [@sasjs/cli](https://cli.sasjs.io/lint) - run `sasjs lint` to get a list of all files with their problems, along with line and column indexes.
|
||||
|
||||
Configuration is via a `.sasjslint` file with the following structure (these are also the defaults if no .sasjslint file is found):
|
||||
|
||||
```json
|
||||
{
|
||||
"noEncodedPasswords": true,
|
||||
"hasDoxygenHeader": true,
|
||||
"hasMacroNameInMend": false,
|
||||
"hasMacroParentheses": true,
|
||||
"indentationMultiple": 2,
|
||||
"lowerCaseFileNames": true,
|
||||
"maxLineLength": 80,
|
||||
"noNestedMacros": true,
|
||||
"noSpacesInFileNames": true,
|
||||
"noTabIndentation": true,
|
||||
"noTrailingSpaces": true
|
||||
}
|
||||
```
|
||||
|
||||
### SAS Lint Settings
|
||||
|
||||
#### noEncodedPasswords
|
||||
|
||||
This 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.
|
||||
|
||||
* Default: true
|
||||
* Severity: WARNING
|
||||
|
||||
#### hasMacroNameInMend
|
||||
The addition of the macro name in the `%mend` statement is optional, but can approve readability in large programs. A discussion on this topic can be found [here](https://www.linkedin.com/posts/allanbowe_sas-sasapps-sasjs-activity-6783413360781266945-1-7m). The default setting will be the result of a popular vote by around 300 people.
|
||||
|
||||
* Default: false (for now)
|
||||
* Severity: WARNING
|
||||
|
||||
#### hasMacroParentheses
|
||||
As per the example [here](https://github.com/sasjs/lint/issues/20), macros defined without parentheses cause problems if that macro is ever extended (it's not possible to reliably extend that macro without potentially breaking some code that has used the macro). It's better to always define parentheses, even if they are not used. This check will also throw a warning if there are spaces between the macro name and the opening parenthesis.
|
||||
|
||||
* Default: true
|
||||
* Severity: WARNING
|
||||
|
||||
#### indentationMultiple
|
||||
This will check each line to ensure that the count of leading spaces can be divided cleanly by this multiple.
|
||||
|
||||
* Default: 2
|
||||
* Severity: WARNING
|
||||
|
||||
#### 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.
|
||||
|
||||
* Default: true
|
||||
* Severity: WARNING
|
||||
|
||||
#### maxLineLength
|
||||
Code becomes far more readable when line lengths are short. The most compelling reason for short line lengths is to avoid the need to scroll when performing a side-by-side 'compare' between two files (eg as part of a GIT feature branch review). A longer discussion on optimal code line length can be found [here](https://stackoverflow.com/questions/578059/studies-on-optimal-code-width)
|
||||
|
||||
In batch mode, long SAS code lines may also be truncated, causing hard-to-detect errors.
|
||||
|
||||
For this reason we strongly recommend a line length limit, and we set the bar at 80. To turn this feature off, set the value to 0.
|
||||
|
||||
* Default: 80
|
||||
* Severity: WARNING
|
||||
|
||||
#### noNestedMacros
|
||||
Where macros are defined inside other macros, they are recompiled every time the outer maro is invoked. Hence, it is widely considered inefficient, and bad practice, to nest macro definitions.
|
||||
|
||||
* Default: true
|
||||
* Severity: WARNING
|
||||
|
||||
#### noSpacesInFileNames
|
||||
The 'beef' we have with spaces in filenames is twofold:
|
||||
|
||||
* Loss of the in-built ability to 'click' a filepath and have the file open automatically
|
||||
* The need to quote such filepaths in order to use them in CLI commands
|
||||
|
||||
In addition, when such files are used in URLs, they are often padded with a messy "%20" type quotation. And of course, for macros (where the macro should match the filename) then spaces are simply not valid.
|
||||
|
||||
* Default: true
|
||||
* Severity: WARNING
|
||||
|
||||
#### noTabIndentation
|
||||
Whilst there are some arguments for using tabs to indent (such as the ability to set your own indentation width, and to save on characters) there are many, many, many developers who think otherwise. We're in that camp. Sorry (not sorry).
|
||||
|
||||
* Default: true
|
||||
* Severity: WARNING
|
||||
|
||||
#### noTrailingSpaces
|
||||
This will highlight lines with trailing spaces. Trailing spaces serve no useful purpose in a SAS program.
|
||||
|
||||
* Default: true
|
||||
* severity: WARNING
|
||||
|
||||
### Upcoming Linting Rules:
|
||||
|
||||
* `noTabs` -> does what it says on the tin
|
||||
* `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.
|
||||
|
||||
We're looking to implement the following rules:
|
||||
|
||||
* Remove trailing spaces
|
||||
* Change tabs to spaces
|
||||
* Add the macro name to the %mend statement
|
||||
* Add a doxygen header template if none exists
|
||||
|
||||
Later we will investigate some harder stuff, such as automatic indentation and code layout
|
||||
|
||||
## 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?
|
||||
|
||||
Contact [Allan Bowe](https://www.linkedin.com/in/allanbowe/) for further details.
|
||||
|
||||
## SAS 9 Health check
|
||||
|
||||
The SASjs Linter (and formatter) is a great way to de-risk and accelerate the delivery of SAS code into production environments. However, code is just one part of a SAS estate. If you are running SAS 9, you may be interested to know what 'gremlins' are lurking in your system. Maybe you are preparing for a migration. Maybe you are preparing to hand over the control of your environment. Either way, an assessment of your existing system would put minds at rest and pro-actively identify trouble spots.
|
||||
|
||||
The SAS 9 Health Check is a 'plug & play' product, that uses the [SAS 9 REST API](https://sas9api.io) to run hundreds of metadata and system checks to identify common problems. The checks are non-invasive, and becuase it is a client app, there is NOTHING TO INSTALL on your SAS server. We offer this assessment for a low fixed fee, and if you engage our (competitively priced) services to address the issues we highlight, then the assessment is free.
|
||||
|
||||
Contact [Allan Bowe](https://www.linkedin.com/in/allanbowe/) for further details.
|
||||
|
||||
|
||||
|
||||
@@ -9,5 +9,5 @@ module.exports = {
|
||||
statements: -10
|
||||
}
|
||||
},
|
||||
collectCoverageFrom: ['src/**/{!(index|example),}.ts']
|
||||
collectCoverageFrom: ['src/**/{!(index|formatExample|lintExample),}.ts']
|
||||
}
|
||||
|
||||
93
package-lock.json
generated
93
package-lock.json
generated
@@ -648,14 +648,35 @@
|
||||
}
|
||||
},
|
||||
"@sasjs/utils": {
|
||||
"version": "2.10.1",
|
||||
"resolved": "https://registry.npmjs.org/@sasjs/utils/-/utils-2.10.1.tgz",
|
||||
"integrity": "sha512-T54jx6NEMLu2+R/ux4qcb3dDJ7nFrKkPCkmPXEfZxPQBkbq4C0kmaZv6dC63RDH68wYhoXR2S5fION5fFh91iw==",
|
||||
"version": "2.12.0",
|
||||
"resolved": "https://registry.npmjs.org/@sasjs/utils/-/utils-2.12.0.tgz",
|
||||
"integrity": "sha512-OnC/7R+nGI8tlSPCcI7fPyD7T97B+McnkXT0IuAYDNGbfwRPuseWq0I1h+kbAWThGT67H4hnp61N0qr8LkpHZQ==",
|
||||
"requires": {
|
||||
"@types/prompts": "^2.0.9",
|
||||
"chalk": "^4.1.1",
|
||||
"cli-table": "^0.3.6",
|
||||
"consola": "^2.15.0",
|
||||
"prompts": "^2.4.0",
|
||||
"prompts": "^2.4.1",
|
||||
"valid-url": "^1.0.9"
|
||||
},
|
||||
"dependencies": {
|
||||
"chalk": {
|
||||
"version": "4.1.1",
|
||||
"resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.1.tgz",
|
||||
"integrity": "sha512-diHzdDKxcU+bAsUboHLPEDQiw0qEe0qd7SYUn3HgcFlWgbDcfLGswOHYeGrHKzG9z6UYf01d9VFMfZxPM1xZSg==",
|
||||
"requires": {
|
||||
"ansi-styles": "^4.1.0",
|
||||
"supports-color": "^7.1.0"
|
||||
}
|
||||
},
|
||||
"prompts": {
|
||||
"version": "2.4.1",
|
||||
"resolved": "https://registry.npmjs.org/prompts/-/prompts-2.4.1.tgz",
|
||||
"integrity": "sha512-EQyfIuO2hPDsX1L/blblV+H7I0knhgAd82cVneCwcdND9B8AuCDuRcBH6yIcG4dFzlOUqbazQqwGjx5xmsNLuQ==",
|
||||
"requires": {
|
||||
"kleur": "^3.0.3",
|
||||
"sisteransi": "^1.0.5"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"@sinonjs/commons": {
|
||||
@@ -751,9 +772,9 @@
|
||||
}
|
||||
},
|
||||
"@types/jest": {
|
||||
"version": "26.0.21",
|
||||
"resolved": "https://registry.npmjs.org/@types/jest/-/jest-26.0.21.tgz",
|
||||
"integrity": "sha512-ab9TyM/69yg7eew9eOwKMUmvIZAKEGZYlq/dhe5/0IMUd/QLJv5ldRMdddSn+u22N13FP3s5jYyktxuBwY0kDA==",
|
||||
"version": "26.0.23",
|
||||
"resolved": "https://registry.npmjs.org/@types/jest/-/jest-26.0.23.tgz",
|
||||
"integrity": "sha512-ZHLmWMJ9jJ9PTiT58juykZpL7KjwJywFN3Rr2pTSkyQfydf/rk22yS7W8p5DaVUMQ2BQC7oYiU3FjbTM/mYrOA==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"jest-diff": "^26.0.0",
|
||||
@@ -761,9 +782,10 @@
|
||||
}
|
||||
},
|
||||
"@types/node": {
|
||||
"version": "14.14.35",
|
||||
"resolved": "https://registry.npmjs.org/@types/node/-/node-14.14.35.tgz",
|
||||
"integrity": "sha512-Lt+wj8NVPx0zUmUwumiVXapmaLUcAk3yPuHCFVXras9k5VT9TdhJqKqGVUQCD60OTMCl0qxJ57OiTL0Mic3Iag=="
|
||||
"version": "15.0.2",
|
||||
"resolved": "https://registry.npmjs.org/@types/node/-/node-15.0.2.tgz",
|
||||
"integrity": "sha512-p68+a+KoxpoB47015IeYZYRrdqMUcpbK8re/zpFB8Ld46LHC1lPEbp3EXgkEhAYEcPvjJF6ZO+869SQ0aH1dcA==",
|
||||
"dev": true
|
||||
},
|
||||
"@types/normalize-package-data": {
|
||||
"version": "2.4.0",
|
||||
@@ -777,14 +799,6 @@
|
||||
"integrity": "sha512-PijRCG/K3s3w1We6ynUKdxEc5AcuuH3NBmMDP8uvKVp6X43UY7NQlTzczakXP3DJR0F4dfNQIGjU2cUeRYs2AA==",
|
||||
"dev": true
|
||||
},
|
||||
"@types/prompts": {
|
||||
"version": "2.0.10",
|
||||
"resolved": "https://registry.npmjs.org/@types/prompts/-/prompts-2.0.10.tgz",
|
||||
"integrity": "sha512-W3PEl3l4vmxdgfY6LUG7ysh+mLJOTOFYmSpiLe6MCo1OdEm8b5s6ZJfuTQgEpYNwcMiiaRzJespPS5Py2tqLlQ==",
|
||||
"requires": {
|
||||
"@types/node": "*"
|
||||
}
|
||||
},
|
||||
"@types/stack-utils": {
|
||||
"version": "2.0.0",
|
||||
"resolved": "https://registry.npmjs.org/@types/stack-utils/-/stack-utils-2.0.0.tgz",
|
||||
@@ -881,7 +895,6 @@
|
||||
"version": "4.3.0",
|
||||
"resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz",
|
||||
"integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"color-convert": "^2.0.1"
|
||||
}
|
||||
@@ -1278,6 +1291,14 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"cli-table": {
|
||||
"version": "0.3.6",
|
||||
"resolved": "https://registry.npmjs.org/cli-table/-/cli-table-0.3.6.tgz",
|
||||
"integrity": "sha512-ZkNZbnZjKERTY5NwC2SeMeLeifSPq/pubeRoTpdr3WchLlnZg6hEgvHkK5zL7KNFdd9PmHN8lxrENUwI3cE8vQ==",
|
||||
"requires": {
|
||||
"colors": "1.0.3"
|
||||
}
|
||||
},
|
||||
"cliui": {
|
||||
"version": "6.0.0",
|
||||
"resolved": "https://registry.npmjs.org/cliui/-/cliui-6.0.0.tgz",
|
||||
@@ -1315,7 +1336,6 @@
|
||||
"version": "2.0.1",
|
||||
"resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz",
|
||||
"integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"color-name": "~1.1.4"
|
||||
}
|
||||
@@ -1323,8 +1343,7 @@
|
||||
"color-name": {
|
||||
"version": "1.1.4",
|
||||
"resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz",
|
||||
"integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==",
|
||||
"dev": true
|
||||
"integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA=="
|
||||
},
|
||||
"colorette": {
|
||||
"version": "1.2.2",
|
||||
@@ -1332,6 +1351,11 @@
|
||||
"integrity": "sha512-MKGMzyfeuutC/ZJ1cba9NqcNpfeqMUcYmyF1ZFY6/Cn7CNSAKx6a+s48sqLqyAiZuaP2TcqMhoo+dlwFnVxT9w==",
|
||||
"dev": true
|
||||
},
|
||||
"colors": {
|
||||
"version": "1.0.3",
|
||||
"resolved": "https://registry.npmjs.org/colors/-/colors-1.0.3.tgz",
|
||||
"integrity": "sha1-BDP0TYCWgP3rYO0mDxsMJi6CpAs="
|
||||
},
|
||||
"combined-stream": {
|
||||
"version": "1.0.8",
|
||||
"resolved": "https://registry.npmjs.org/combined-stream/-/combined-stream-1.0.8.tgz",
|
||||
@@ -2036,8 +2060,7 @@
|
||||
"has-flag": {
|
||||
"version": "4.0.0",
|
||||
"resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz",
|
||||
"integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==",
|
||||
"dev": true
|
||||
"integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ=="
|
||||
},
|
||||
"has-value": {
|
||||
"version": "1.0.0",
|
||||
@@ -3587,6 +3610,7 @@
|
||||
"version": "2.4.0",
|
||||
"resolved": "https://registry.npmjs.org/prompts/-/prompts-2.4.0.tgz",
|
||||
"integrity": "sha512-awZAKrk3vN6CroQukBL+R9051a4R3zCZBlJm/HBfrSZ8iTpYix3VX1vU4mveiLpiwmOJT4wokTF9m6HUk4KqWQ==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"kleur": "^3.0.3",
|
||||
"sisteransi": "^1.0.5"
|
||||
@@ -4395,7 +4419,6 @@
|
||||
"version": "7.2.0",
|
||||
"resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz",
|
||||
"integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"has-flag": "^4.0.0"
|
||||
}
|
||||
@@ -4517,9 +4540,9 @@
|
||||
}
|
||||
},
|
||||
"ts-jest": {
|
||||
"version": "26.5.4",
|
||||
"resolved": "https://registry.npmjs.org/ts-jest/-/ts-jest-26.5.4.tgz",
|
||||
"integrity": "sha512-I5Qsddo+VTm94SukBJ4cPimOoFZsYTeElR2xy6H2TOVs+NsvgYglW8KuQgKoApOKuaU/Ix/vrF9ebFZlb5D2Pg==",
|
||||
"version": "26.5.5",
|
||||
"resolved": "https://registry.npmjs.org/ts-jest/-/ts-jest-26.5.5.tgz",
|
||||
"integrity": "sha512-7tP4m+silwt1NHqzNRAPjW1BswnAhopTdc2K3HEkRZjF0ZG2F/e/ypVH0xiZIMfItFtD3CX0XFbwPzp9fIEUVg==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"bs-logger": "0.x",
|
||||
@@ -4535,9 +4558,9 @@
|
||||
},
|
||||
"dependencies": {
|
||||
"semver": {
|
||||
"version": "7.3.4",
|
||||
"resolved": "https://registry.npmjs.org/semver/-/semver-7.3.4.tgz",
|
||||
"integrity": "sha512-tCfb2WLjqFAtXn4KEdxIhalnRtoKFN7nAwj0B3ZXCbQloV2tq5eDbcTmT68JJD3nRJq24/XgxtQKFIpQdtvmVw==",
|
||||
"version": "7.3.5",
|
||||
"resolved": "https://registry.npmjs.org/semver/-/semver-7.3.5.tgz",
|
||||
"integrity": "sha512-PoeGJYh8HK4BTO/a9Tf6ZG3veo/A7ZVsYrSA6J8ny9nb3B1VrpkuN+z9OE5wfE5p6H4LchYZsegiQgbJD94ZFQ==",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
"lru-cache": "^6.0.0"
|
||||
@@ -4597,9 +4620,9 @@
|
||||
}
|
||||
},
|
||||
"typescript": {
|
||||
"version": "4.2.3",
|
||||
"resolved": "https://registry.npmjs.org/typescript/-/typescript-4.2.3.tgz",
|
||||
"integrity": "sha512-qOcYwxaByStAWrBf4x0fibwZvMRG+r4cQoTjbPtUlrWjBHbmCAww1i448U0GJ+3cNNEtebDteo/cHOR3xJ4wEw==",
|
||||
"version": "4.2.4",
|
||||
"resolved": "https://registry.npmjs.org/typescript/-/typescript-4.2.4.tgz",
|
||||
"integrity": "sha512-V+evlYHZnQkaz8TRBuxTA92yZBPotr5H+WhQ7bD3hZUndx5tGOa1fuCgeSjxAzM1RiN5IzvadIXTVefuuwZCRg==",
|
||||
"dev": true
|
||||
},
|
||||
"union-value": {
|
||||
|
||||
10
package.json
10
package.json
@@ -36,14 +36,14 @@
|
||||
},
|
||||
"homepage": "https://github.com/sasjs/lint#readme",
|
||||
"devDependencies": {
|
||||
"@types/jest": "^26.0.21",
|
||||
"@types/node": "^14.14.35",
|
||||
"@types/jest": "^26.0.23",
|
||||
"@types/node": "^15.0.2",
|
||||
"jest": "^26.6.3",
|
||||
"rimraf": "^3.0.2",
|
||||
"ts-jest": "^26.5.4",
|
||||
"typescript": "^4.2.3"
|
||||
"ts-jest": "^26.5.5",
|
||||
"typescript": "^4.2.4"
|
||||
},
|
||||
"dependencies": {
|
||||
"@sasjs/utils": "^2.10.1"
|
||||
"@sasjs/utils": "^2.12.0"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -5,14 +5,18 @@
|
||||
"title": "SASjs Lint Config File",
|
||||
"description": "The SASjs Lint Config file provides the settings for customising SAS code style in your project.",
|
||||
"default": {
|
||||
"noTrailingSpaces": true,
|
||||
"noEncodedPasswords": true,
|
||||
"hasDoxygenHeader": true,
|
||||
"noSpacesInFileNames": true,
|
||||
"hasMacroNameInMend": false,
|
||||
"hasMacroParentheses": true,
|
||||
"indentationMultiple": 2,
|
||||
"lowerCaseFileNames": true,
|
||||
"maxLineLength": 80,
|
||||
"noNestedMacros": true,
|
||||
"noSpacesInFileNames": true,
|
||||
"noTabIndentation": true,
|
||||
"indentationMultiple": 2
|
||||
"noTrailingSpaces": true,
|
||||
"lineEndings": "lf"
|
||||
},
|
||||
"examples": [
|
||||
{
|
||||
@@ -23,18 +27,14 @@
|
||||
"lowerCaseFileNames": true,
|
||||
"maxLineLength": 80,
|
||||
"noTabIndentation": true,
|
||||
"indentationMultiple": 4
|
||||
"indentationMultiple": 4,
|
||||
"hasMacroNameInMend": true,
|
||||
"noNestedMacros": true,
|
||||
"hasMacroParentheses": true,
|
||||
"lineEndings": "crlf"
|
||||
}
|
||||
],
|
||||
"properties": {
|
||||
"noTrailingSpaces": {
|
||||
"$id": "#/properties/noTrailingSpaces",
|
||||
"type": "boolean",
|
||||
"title": "noTrailingSpaces",
|
||||
"description": "Enforces no trailing spaces in lines of SAS code. Shows a warning when they are present.",
|
||||
"default": true,
|
||||
"examples": [true, false]
|
||||
},
|
||||
"noEncodedPasswords": {
|
||||
"$id": "#/properties/noEncodedPasswords",
|
||||
"type": "boolean",
|
||||
@@ -51,14 +51,30 @@
|
||||
"default": true,
|
||||
"examples": [true, false]
|
||||
},
|
||||
"noSpacesInFileNames": {
|
||||
"$id": "#/properties/noSpacesInFileNames",
|
||||
"hasMacroNameInMend": {
|
||||
"$id": "#/properties/hasMacroNameInMend",
|
||||
"type": "boolean",
|
||||
"title": "noSpacesInFileNames",
|
||||
"description": "Enforces no spaces in file names. Shows a warning when they are present.",
|
||||
"title": "hasMacroNameInMend",
|
||||
"description": "Enforces the presence of macro names in %mend statements. Shows a warning for %mend statements with missing or mismatched macro names.",
|
||||
"default": false,
|
||||
"examples": [true, false]
|
||||
},
|
||||
"hasMacroParentheses": {
|
||||
"$id": "#/properties/hasMacroParentheses",
|
||||
"type": "boolean",
|
||||
"title": "hasMacroParentheses",
|
||||
"description": "Enforces the presence of parentheses in macro definitions. Shows a warning for each macro defined without parentheses, or with spaces between the macro name and the opening parenthesis.",
|
||||
"default": true,
|
||||
"examples": [true, false]
|
||||
},
|
||||
"indentationMultiple": {
|
||||
"$id": "#/properties/indentationMultiple",
|
||||
"type": "number",
|
||||
"title": "indentationMultiple",
|
||||
"description": "Enforces a configurable multiple for the number of spaces for indentation. Shows a warning for lines that are not indented by a multiple of this number.",
|
||||
"default": 2,
|
||||
"examples": [2, 3, 4]
|
||||
},
|
||||
"lowerCaseFileNames": {
|
||||
"$id": "#/properties/lowerCaseFileNames",
|
||||
"type": "boolean",
|
||||
@@ -75,6 +91,22 @@
|
||||
"default": 80,
|
||||
"examples": [60, 80, 120]
|
||||
},
|
||||
"noNestedMacros": {
|
||||
"$id": "#/properties/noNestedMacros",
|
||||
"type": "boolean",
|
||||
"title": "noNestedMacros",
|
||||
"description": "Enforces the absence of nested macro definitions. Shows a warning for each nested macro definition.",
|
||||
"default": true,
|
||||
"examples": [true, false]
|
||||
},
|
||||
"noSpacesInFileNames": {
|
||||
"$id": "#/properties/noSpacesInFileNames",
|
||||
"type": "boolean",
|
||||
"title": "noSpacesInFileNames",
|
||||
"description": "Enforces no spaces in file names. Shows a warning when they are present.",
|
||||
"default": true,
|
||||
"examples": [true, false]
|
||||
},
|
||||
"noTabIndentation": {
|
||||
"$id": "#/properties/noTabIndentation",
|
||||
"type": "boolean",
|
||||
@@ -83,13 +115,21 @@
|
||||
"default": true,
|
||||
"examples": [true, false]
|
||||
},
|
||||
"indentationMultiple": {
|
||||
"$id": "#/properties/indentationMultiple",
|
||||
"type": "number",
|
||||
"title": "indentationMultiple",
|
||||
"description": "Enforces a configurable multiple for the number of spaces for indentation. Shows a warning for lines that are not indented by a multiple of this number.",
|
||||
"default": 2,
|
||||
"examples": [2, 3, 4]
|
||||
"noTrailingSpaces": {
|
||||
"$id": "#/properties/noTrailingSpaces",
|
||||
"type": "boolean",
|
||||
"title": "noTrailingSpaces",
|
||||
"description": "Enforces no trailing spaces in lines of SAS code. Shows a warning when they are present.",
|
||||
"default": true,
|
||||
"examples": [true, false]
|
||||
},
|
||||
"lineEndings": {
|
||||
"$id": "#/properties/lineEndings",
|
||||
"type": "string",
|
||||
"title": "lineEndings",
|
||||
"description": "Enforces the configured terminating character for each line. Shows a warning when incorrect line endings are present.",
|
||||
"default": "lf",
|
||||
"examples": ["lf", "crlf"]
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1 +0,0 @@
|
||||
export const format = (text: string) => {}
|
||||
97
src/format/formatFile.spec.ts
Normal file
97
src/format/formatFile.spec.ts
Normal file
@@ -0,0 +1,97 @@
|
||||
import { formatFile } from './formatFile'
|
||||
import path from 'path'
|
||||
import { createFile, deleteFile, readFile } from '@sasjs/utils/file'
|
||||
import { LintConfig } from '../types'
|
||||
|
||||
describe('formatFile', () => {
|
||||
it('should fix linting issues in a given file', async () => {
|
||||
const content = `%macro somemacro(); \n%put 'hello';\n%mend;`
|
||||
const expectedContent = `/**\n @file\n @brief <Your brief here>\n <h4> SAS Macros </h4>\n**/\n%macro somemacro();\n%put 'hello';\n%mend somemacro;`
|
||||
await createFile(path.join(__dirname, 'format-file-test.sas'), content)
|
||||
const expectedResult = {
|
||||
updatedFilePaths: [path.join(__dirname, 'format-file-test.sas')],
|
||||
fixedDiagnosticsCount: 3,
|
||||
unfixedDiagnostics: []
|
||||
}
|
||||
|
||||
const result = await formatFile(
|
||||
path.join(__dirname, 'format-file-test.sas')
|
||||
)
|
||||
const formattedContent = await readFile(
|
||||
path.join(__dirname, 'format-file-test.sas')
|
||||
)
|
||||
|
||||
expect(result).toEqual(expectedResult)
|
||||
expect(formattedContent).toEqual(expectedContent)
|
||||
|
||||
await deleteFile(path.join(__dirname, 'format-file-test.sas'))
|
||||
})
|
||||
|
||||
it('should use the provided config if available', async () => {
|
||||
const content = `%macro somemacro(); \n%put 'hello';\n%mend;`
|
||||
const expectedContent = `/**\r\n @file\r\n @brief <Your brief here>\r\n <h4> SAS Macros </h4>\r\n**/\r\n%macro somemacro();\r\n%put 'hello';\r\n%mend;`
|
||||
const expectedResult = {
|
||||
updatedFilePaths: [path.join(__dirname, 'format-file-config.sas')],
|
||||
fixedDiagnosticsCount: 2,
|
||||
unfixedDiagnostics: [
|
||||
{
|
||||
endColumnNumber: 7,
|
||||
lineNumber: 8,
|
||||
message: '%mend statement is missing macro name - somemacro',
|
||||
severity: 1,
|
||||
startColumnNumber: 1
|
||||
}
|
||||
]
|
||||
}
|
||||
await createFile(path.join(__dirname, 'format-file-config.sas'), content)
|
||||
|
||||
const result = await formatFile(
|
||||
path.join(__dirname, 'format-file-config.sas'),
|
||||
new LintConfig({
|
||||
lineEndings: 'crlf',
|
||||
hasMacroNameInMend: false,
|
||||
hasDoxygenHeader: true,
|
||||
noTrailingSpaces: true
|
||||
})
|
||||
)
|
||||
const formattedContent = await readFile(
|
||||
path.join(__dirname, 'format-file-config.sas')
|
||||
)
|
||||
|
||||
expect(result).toEqual(expectedResult)
|
||||
expect(formattedContent).toEqual(expectedContent)
|
||||
|
||||
await deleteFile(path.join(__dirname, 'format-file-config.sas'))
|
||||
})
|
||||
|
||||
it('should not update any files if there are no formatting violations', async () => {
|
||||
const content = `/**\r\n @file\r\n @brief <Your brief here>\r\n <h4> SAS Macros </h4>\r\n**/\r\n%macro somemacro();\r\n%put 'hello';\r\n%mend somemacro;`
|
||||
const expectedResult = {
|
||||
updatedFilePaths: [],
|
||||
fixedDiagnosticsCount: 0,
|
||||
unfixedDiagnostics: []
|
||||
}
|
||||
await createFile(
|
||||
path.join(__dirname, 'format-file-no-violations.sas'),
|
||||
content
|
||||
)
|
||||
|
||||
const result = await formatFile(
|
||||
path.join(__dirname, 'format-file-no-violations.sas'),
|
||||
new LintConfig({
|
||||
lineEndings: 'crlf',
|
||||
hasMacroNameInMend: true,
|
||||
hasDoxygenHeader: true,
|
||||
noTrailingSpaces: true
|
||||
})
|
||||
)
|
||||
const formattedContent = await readFile(
|
||||
path.join(__dirname, 'format-file-no-violations.sas')
|
||||
)
|
||||
|
||||
expect(result).toEqual(expectedResult)
|
||||
expect(formattedContent).toEqual(content)
|
||||
|
||||
await deleteFile(path.join(__dirname, 'format-file-no-violations.sas'))
|
||||
})
|
||||
})
|
||||
45
src/format/formatFile.ts
Normal file
45
src/format/formatFile.ts
Normal file
@@ -0,0 +1,45 @@
|
||||
import { createFile, readFile } from '@sasjs/utils/file'
|
||||
import { lintFile } from '../lint'
|
||||
import { FormatResult } from '../types'
|
||||
import { LintConfig } from '../types/LintConfig'
|
||||
import { getLintConfig } from '../utils/getLintConfig'
|
||||
import { processText } from './shared'
|
||||
|
||||
/**
|
||||
* Applies automatic formatting to the file at the given path.
|
||||
* @param {string} filePath - the path to the file to be formatted.
|
||||
* @param {LintConfig} configuration - an optional configuration. When not passed in, this is read from the .sasjslint file.
|
||||
* @returns {Promise<FormatResult>} Resolves successfully when the file has been formatted.
|
||||
*/
|
||||
export const formatFile = async (
|
||||
filePath: string,
|
||||
configuration?: LintConfig
|
||||
): Promise<FormatResult> => {
|
||||
const config = configuration || (await getLintConfig())
|
||||
const diagnosticsBeforeFormat = await lintFile(filePath)
|
||||
const diagnosticsCountBeforeFormat = diagnosticsBeforeFormat.length
|
||||
|
||||
const text = await readFile(filePath)
|
||||
|
||||
const formattedText = processText(text, config)
|
||||
|
||||
await createFile(filePath, formattedText)
|
||||
|
||||
const diagnosticsAfterFormat = await lintFile(filePath)
|
||||
const diagnosticsCountAfterFormat = diagnosticsAfterFormat.length
|
||||
|
||||
const fixedDiagnosticsCount =
|
||||
diagnosticsCountBeforeFormat - diagnosticsCountAfterFormat
|
||||
|
||||
const updatedFilePaths: string[] = []
|
||||
|
||||
if (fixedDiagnosticsCount) {
|
||||
updatedFilePaths.push(filePath)
|
||||
}
|
||||
|
||||
return {
|
||||
updatedFilePaths,
|
||||
fixedDiagnosticsCount,
|
||||
unfixedDiagnostics: diagnosticsAfterFormat
|
||||
}
|
||||
}
|
||||
228
src/format/formatFolder.spec.ts
Normal file
228
src/format/formatFolder.spec.ts
Normal file
@@ -0,0 +1,228 @@
|
||||
import { formatFolder } from './formatFolder'
|
||||
import path from 'path'
|
||||
import {
|
||||
createFile,
|
||||
createFolder,
|
||||
deleteFolder,
|
||||
readFile
|
||||
} from '@sasjs/utils/file'
|
||||
import { Diagnostic, LintConfig } from '../types'
|
||||
|
||||
describe('formatFolder', () => {
|
||||
it('should fix linting issues in a given folder', async () => {
|
||||
const content = `%macro somemacro(); \n%put 'hello';\n%mend;`
|
||||
const expectedContent = `/**\n @file\n @brief <Your brief here>\n <h4> SAS Macros </h4>\n**/\n%macro somemacro();\n%put 'hello';\n%mend somemacro;`
|
||||
const expectedResult = {
|
||||
updatedFilePaths: [
|
||||
path.join(__dirname, 'format-folder-test', 'format-folder-test.sas')
|
||||
],
|
||||
fixedDiagnosticsCount: 3,
|
||||
unfixedDiagnostics: new Map<string, Diagnostic[]>([
|
||||
[
|
||||
path.join(__dirname, 'format-folder-test', 'format-folder-test.sas'),
|
||||
[]
|
||||
]
|
||||
])
|
||||
}
|
||||
await createFolder(path.join(__dirname, 'format-folder-test'))
|
||||
await createFile(
|
||||
path.join(__dirname, 'format-folder-test', 'format-folder-test.sas'),
|
||||
content
|
||||
)
|
||||
|
||||
const result = await formatFolder(
|
||||
path.join(__dirname, 'format-folder-test')
|
||||
)
|
||||
const formattedContent = await readFile(
|
||||
path.join(__dirname, 'format-folder-test', 'format-folder-test.sas')
|
||||
)
|
||||
|
||||
expect(formattedContent).toEqual(expectedContent)
|
||||
expect(result).toEqual(expectedResult)
|
||||
|
||||
await deleteFolder(path.join(__dirname, 'format-folder-test'))
|
||||
})
|
||||
|
||||
it('should fix linting issues in subfolders of a given folder', async () => {
|
||||
const content = `%macro somemacro(); \n%put 'hello';\n%mend;`
|
||||
const expectedContent = `/**\n @file\n @brief <Your brief here>\n <h4> SAS Macros </h4>\n**/\n%macro somemacro();\n%put 'hello';\n%mend somemacro;`
|
||||
const expectedResult = {
|
||||
updatedFilePaths: [
|
||||
path.join(
|
||||
__dirname,
|
||||
'format-folder-test',
|
||||
'subfolder',
|
||||
'format-folder-test.sas'
|
||||
)
|
||||
],
|
||||
fixedDiagnosticsCount: 3,
|
||||
unfixedDiagnostics: new Map<string, Diagnostic[]>([
|
||||
[
|
||||
path.join(
|
||||
__dirname,
|
||||
'format-folder-test',
|
||||
'subfolder',
|
||||
'format-folder-test.sas'
|
||||
),
|
||||
[]
|
||||
]
|
||||
])
|
||||
}
|
||||
|
||||
await createFolder(path.join(__dirname, 'format-folder-test'))
|
||||
await createFolder(path.join(__dirname, 'subfolder'))
|
||||
await createFile(
|
||||
path.join(
|
||||
__dirname,
|
||||
'format-folder-test',
|
||||
'subfolder',
|
||||
'format-folder-test.sas'
|
||||
),
|
||||
content
|
||||
)
|
||||
|
||||
const result = await formatFolder(
|
||||
path.join(__dirname, 'format-folder-test')
|
||||
)
|
||||
const formattedContent = await readFile(
|
||||
path.join(
|
||||
__dirname,
|
||||
'format-folder-test',
|
||||
'subfolder',
|
||||
'format-folder-test.sas'
|
||||
)
|
||||
)
|
||||
|
||||
expect(result).toEqual(expectedResult)
|
||||
expect(formattedContent).toEqual(expectedContent)
|
||||
|
||||
await deleteFolder(path.join(__dirname, 'format-folder-test'))
|
||||
})
|
||||
|
||||
it('should use a custom configuration when provided', async () => {
|
||||
const content = `%macro somemacro(); \n%put 'hello';\n%mend;`
|
||||
const expectedContent = `/**\n @file\n @brief <Your brief here>\n <h4> SAS Macros </h4>\n**/\n%macro somemacro();\n%put 'hello';\n%mend somemacro;`
|
||||
const expectedResult = {
|
||||
updatedFilePaths: [
|
||||
path.join(__dirname, 'format-folder-test', 'format-folder-test.sas')
|
||||
],
|
||||
fixedDiagnosticsCount: 3,
|
||||
unfixedDiagnostics: new Map<string, Diagnostic[]>([
|
||||
[
|
||||
path.join(__dirname, 'format-folder-test', 'format-folder-test.sas'),
|
||||
[]
|
||||
]
|
||||
])
|
||||
}
|
||||
await createFolder(path.join(__dirname, 'format-folder-test'))
|
||||
await createFile(
|
||||
path.join(__dirname, 'format-folder-test', 'format-folder-test.sas'),
|
||||
content
|
||||
)
|
||||
|
||||
const result = await formatFolder(
|
||||
path.join(__dirname, 'format-folder-test'),
|
||||
new LintConfig({
|
||||
lineEndings: 'crlf',
|
||||
hasMacroNameInMend: false,
|
||||
hasDoxygenHeader: true,
|
||||
noTrailingSpaces: true
|
||||
})
|
||||
)
|
||||
const formattedContent = await readFile(
|
||||
path.join(__dirname, 'format-folder-test', 'format-folder-test.sas')
|
||||
)
|
||||
|
||||
expect(formattedContent).toEqual(expectedContent)
|
||||
expect(result).toEqual(expectedResult)
|
||||
|
||||
await deleteFolder(path.join(__dirname, 'format-folder-test'))
|
||||
})
|
||||
|
||||
it('should fix linting issues in subfolders of a given folder', async () => {
|
||||
const content = `%macro somemacro(); \n%put 'hello';\n%mend;`
|
||||
const expectedContent = `/**\n @file\n @brief <Your brief here>\n <h4> SAS Macros </h4>\n**/\n%macro somemacro();\n%put 'hello';\n%mend somemacro;`
|
||||
const expectedResult = {
|
||||
updatedFilePaths: [
|
||||
path.join(
|
||||
__dirname,
|
||||
'format-folder-test',
|
||||
'subfolder',
|
||||
'format-folder-test.sas'
|
||||
)
|
||||
],
|
||||
fixedDiagnosticsCount: 3,
|
||||
unfixedDiagnostics: new Map<string, Diagnostic[]>([
|
||||
[
|
||||
path.join(
|
||||
__dirname,
|
||||
'format-folder-test',
|
||||
'subfolder',
|
||||
'format-folder-test.sas'
|
||||
),
|
||||
[]
|
||||
]
|
||||
])
|
||||
}
|
||||
|
||||
await createFolder(path.join(__dirname, 'format-folder-test'))
|
||||
await createFolder(path.join(__dirname, 'subfolder'))
|
||||
await createFile(
|
||||
path.join(
|
||||
__dirname,
|
||||
'format-folder-test',
|
||||
'subfolder',
|
||||
'format-folder-test.sas'
|
||||
),
|
||||
content
|
||||
)
|
||||
|
||||
const result = await formatFolder(
|
||||
path.join(__dirname, 'format-folder-test')
|
||||
)
|
||||
const formattedContent = await readFile(
|
||||
path.join(
|
||||
__dirname,
|
||||
'format-folder-test',
|
||||
'subfolder',
|
||||
'format-folder-test.sas'
|
||||
)
|
||||
)
|
||||
|
||||
expect(result).toEqual(expectedResult)
|
||||
expect(formattedContent).toEqual(expectedContent)
|
||||
|
||||
await deleteFolder(path.join(__dirname, 'format-folder-test'))
|
||||
})
|
||||
|
||||
it('should not update any files when there are no violations', async () => {
|
||||
const content = `/**\n @file\n @brief <Your brief here>\n <h4> SAS Macros </h4>\n**/\n%macro somemacro();\n%put 'hello';\n%mend somemacro;`
|
||||
const expectedResult = {
|
||||
updatedFilePaths: [],
|
||||
fixedDiagnosticsCount: 0,
|
||||
unfixedDiagnostics: new Map<string, Diagnostic[]>([
|
||||
[
|
||||
path.join(__dirname, 'format-folder-test', 'format-folder-test.sas'),
|
||||
[]
|
||||
]
|
||||
])
|
||||
}
|
||||
await createFolder(path.join(__dirname, 'format-folder-test'))
|
||||
await createFile(
|
||||
path.join(__dirname, 'format-folder-test', 'format-folder-test.sas'),
|
||||
content
|
||||
)
|
||||
|
||||
const result = await formatFolder(
|
||||
path.join(__dirname, 'format-folder-test')
|
||||
)
|
||||
const formattedContent = await readFile(
|
||||
path.join(__dirname, 'format-folder-test', 'format-folder-test.sas')
|
||||
)
|
||||
|
||||
expect(formattedContent).toEqual(content)
|
||||
expect(result).toEqual(expectedResult)
|
||||
|
||||
await deleteFolder(path.join(__dirname, 'format-folder-test'))
|
||||
})
|
||||
})
|
||||
74
src/format/formatFolder.ts
Normal file
74
src/format/formatFolder.ts
Normal file
@@ -0,0 +1,74 @@
|
||||
import { listSubFoldersInFolder } from '@sasjs/utils/file'
|
||||
import path from 'path'
|
||||
import { lintFolder } from '../lint'
|
||||
import { FormatResult } from '../types'
|
||||
import { LintConfig } from '../types/LintConfig'
|
||||
import { asyncForEach } from '../utils/asyncForEach'
|
||||
import { getLintConfig } from '../utils/getLintConfig'
|
||||
import { listSasFiles } from '../utils/listSasFiles'
|
||||
import { formatFile } from './formatFile'
|
||||
|
||||
const excludeFolders = [
|
||||
'.git',
|
||||
'.github',
|
||||
'.vscode',
|
||||
'node_modules',
|
||||
'sasjsbuild',
|
||||
'sasjsresults'
|
||||
]
|
||||
|
||||
/**
|
||||
* Automatically formats all SAS files in the folder at the given path.
|
||||
* @param {string} folderPath - the path to the folder to be formatted.
|
||||
* @param {LintConfig} configuration - an optional configuration. When not passed in, this is read from the .sasjslint file.
|
||||
* @returns {Promise<FormatResult>} Resolves successfully when all SAS files in the given folder have been formatted.
|
||||
*/
|
||||
export const formatFolder = async (
|
||||
folderPath: string,
|
||||
configuration?: LintConfig
|
||||
): Promise<FormatResult> => {
|
||||
const config = configuration || (await getLintConfig())
|
||||
const diagnosticsBeforeFormat = await lintFolder(folderPath)
|
||||
const diagnosticsCountBeforeFormat = Array.from(
|
||||
diagnosticsBeforeFormat.values()
|
||||
).reduce((a, b) => a + b.length, 0)
|
||||
|
||||
const fileNames = await listSasFiles(folderPath)
|
||||
await asyncForEach(fileNames, async (fileName) => {
|
||||
const filePath = path.join(folderPath, fileName)
|
||||
await formatFile(filePath)
|
||||
})
|
||||
|
||||
const subFolders = (await listSubFoldersInFolder(folderPath)).filter(
|
||||
(f: string) => !excludeFolders.includes(f)
|
||||
)
|
||||
|
||||
await asyncForEach(subFolders, async (subFolder) => {
|
||||
await formatFolder(path.join(folderPath, subFolder), config)
|
||||
})
|
||||
|
||||
const diagnosticsAfterFormat = await lintFolder(folderPath)
|
||||
const diagnosticsCountAfterFormat = Array.from(
|
||||
diagnosticsAfterFormat.values()
|
||||
).reduce((a, b) => a + b.length, 0)
|
||||
|
||||
const fixedDiagnosticsCount =
|
||||
diagnosticsCountBeforeFormat - diagnosticsCountAfterFormat
|
||||
|
||||
const updatedFilePaths: string[] = []
|
||||
|
||||
Array.from(diagnosticsBeforeFormat.keys()).forEach((filePath) => {
|
||||
const diagnosticsBefore = diagnosticsBeforeFormat.get(filePath) || []
|
||||
const diagnosticsAfter = diagnosticsAfterFormat.get(filePath) || []
|
||||
|
||||
if (diagnosticsBefore.length !== diagnosticsAfter.length) {
|
||||
updatedFilePaths.push(filePath)
|
||||
}
|
||||
})
|
||||
|
||||
return {
|
||||
updatedFilePaths,
|
||||
fixedDiagnosticsCount,
|
||||
unfixedDiagnostics: diagnosticsAfterFormat
|
||||
}
|
||||
}
|
||||
51
src/format/formatProject.spec.ts
Normal file
51
src/format/formatProject.spec.ts
Normal file
@@ -0,0 +1,51 @@
|
||||
import { formatProject } from './formatProject'
|
||||
import path from 'path'
|
||||
import {
|
||||
createFile,
|
||||
createFolder,
|
||||
deleteFolder,
|
||||
readFile
|
||||
} from '@sasjs/utils/file'
|
||||
import { DefaultLintConfiguration } from '../utils'
|
||||
import * as getProjectRootModule from '../utils/getProjectRoot'
|
||||
jest.mock('../utils/getProjectRoot')
|
||||
|
||||
describe('formatProject', () => {
|
||||
it('should format files in the current project', async () => {
|
||||
const content = `%macro somemacro(); \n%put 'hello';\n%mend;`
|
||||
const expectedContent = `/**\n @file\n @brief <Your brief here>\n <h4> SAS Macros </h4>\n**/\n%macro somemacro();\n%put 'hello';\n%mend somemacro;`
|
||||
await createFolder(path.join(__dirname, 'format-project-test'))
|
||||
await createFile(
|
||||
path.join(__dirname, 'format-project-test', 'format-project-test.sas'),
|
||||
content
|
||||
)
|
||||
await createFile(
|
||||
path.join(__dirname, 'format-project-test', '.sasjslint'),
|
||||
JSON.stringify(DefaultLintConfiguration)
|
||||
)
|
||||
jest
|
||||
.spyOn(getProjectRootModule, 'getProjectRoot')
|
||||
.mockImplementation(() =>
|
||||
Promise.resolve(path.join(__dirname, 'format-project-test'))
|
||||
)
|
||||
|
||||
await formatProject()
|
||||
const result = await readFile(
|
||||
path.join(__dirname, 'format-project-test', 'format-project-test.sas')
|
||||
)
|
||||
|
||||
expect(result).toEqual(expectedContent)
|
||||
|
||||
await deleteFolder(path.join(__dirname, 'format-project-test'))
|
||||
})
|
||||
|
||||
it('should throw an error when a project root is not found', async () => {
|
||||
jest
|
||||
.spyOn(getProjectRootModule, 'getProjectRoot')
|
||||
.mockImplementationOnce(() => Promise.resolve(''))
|
||||
|
||||
await expect(formatProject()).rejects.toThrowError(
|
||||
'SASjs Project Root was not found.'
|
||||
)
|
||||
})
|
||||
})
|
||||
18
src/format/formatProject.ts
Normal file
18
src/format/formatProject.ts
Normal file
@@ -0,0 +1,18 @@
|
||||
import { lintFolder } from '../lint/lintFolder'
|
||||
import { FormatResult } from '../types/FormatResult'
|
||||
import { getProjectRoot } from '../utils/getProjectRoot'
|
||||
import { formatFolder } from './formatFolder'
|
||||
|
||||
/**
|
||||
* Automatically formats all SAS files in the current project.
|
||||
* @returns {Promise<FormatResult>} Resolves successfully when all SAS files in the current project have been formatted.
|
||||
*/
|
||||
export const formatProject = async (): Promise<FormatResult> => {
|
||||
const projectRoot =
|
||||
(await getProjectRoot()) || process.projectDir || process.currentDir
|
||||
if (!projectRoot) {
|
||||
throw new Error('SASjs Project Root was not found.')
|
||||
}
|
||||
|
||||
return await formatFolder(projectRoot)
|
||||
}
|
||||
49
src/format/formatText.spec.ts
Normal file
49
src/format/formatText.spec.ts
Normal file
@@ -0,0 +1,49 @@
|
||||
import { formatText } from './formatText'
|
||||
import * as getLintConfigModule from '../utils/getLintConfig'
|
||||
import { LintConfig } from '../types'
|
||||
jest.mock('../utils/getLintConfig')
|
||||
|
||||
describe('formatText', () => {
|
||||
it('should format the given text based on configured rules', async () => {
|
||||
jest
|
||||
.spyOn(getLintConfigModule, 'getLintConfig')
|
||||
.mockImplementationOnce(() =>
|
||||
Promise.resolve(
|
||||
new LintConfig(getLintConfigModule.DefaultLintConfiguration)
|
||||
)
|
||||
)
|
||||
const text = `%macro test
|
||||
%put 'hello';\r\n%mend; `
|
||||
|
||||
const expectedOutput = `/**
|
||||
@file
|
||||
@brief <Your brief here>
|
||||
<h4> SAS Macros </h4>
|
||||
**/\n%macro test
|
||||
%put 'hello';\n%mend test;`
|
||||
|
||||
const output = await formatText(text)
|
||||
|
||||
expect(output).toEqual(expectedOutput)
|
||||
})
|
||||
|
||||
it('should use CRLF line endings when configured', async () => {
|
||||
jest
|
||||
.spyOn(getLintConfigModule, 'getLintConfig')
|
||||
.mockImplementationOnce(() =>
|
||||
Promise.resolve(
|
||||
new LintConfig({
|
||||
...getLintConfigModule.DefaultLintConfiguration,
|
||||
lineEndings: 'crlf'
|
||||
})
|
||||
)
|
||||
)
|
||||
const text = `%macro test\n %put 'hello';\r\n%mend; `
|
||||
|
||||
const expectedOutput = `/**\r\n @file\r\n @brief <Your brief here>\r\n <h4> SAS Macros </h4>\r\n**/\r\n%macro test\r\n %put 'hello';\r\n%mend test;`
|
||||
|
||||
const output = await formatText(text)
|
||||
|
||||
expect(output).toEqual(expectedOutput)
|
||||
})
|
||||
})
|
||||
7
src/format/formatText.ts
Normal file
7
src/format/formatText.ts
Normal file
@@ -0,0 +1,7 @@
|
||||
import { getLintConfig } from '../utils'
|
||||
import { processText } from './shared'
|
||||
|
||||
export const formatText = async (text: string) => {
|
||||
const config = await getLintConfig()
|
||||
return processText(text, config)
|
||||
}
|
||||
4
src/format/index.ts
Normal file
4
src/format/index.ts
Normal file
@@ -0,0 +1,4 @@
|
||||
export * from './formatText'
|
||||
export * from './formatFile'
|
||||
export * from './formatFolder'
|
||||
export * from './formatProject'
|
||||
37
src/format/shared.ts
Normal file
37
src/format/shared.ts
Normal file
@@ -0,0 +1,37 @@
|
||||
import { LintConfig } from '../types'
|
||||
import { LineEndings } from '../types/LineEndings'
|
||||
import { splitText } from '../utils/splitText'
|
||||
|
||||
export const processText = (text: string, config: LintConfig) => {
|
||||
const processedText = processContent(config, text)
|
||||
const lines = splitText(processedText, config)
|
||||
const formattedLines = lines.map((line) => {
|
||||
return processLine(config, line)
|
||||
})
|
||||
|
||||
const configuredLineEnding =
|
||||
config.lineEndings === LineEndings.LF ? '\n' : '\r\n'
|
||||
return formattedLines.join(configuredLineEnding)
|
||||
}
|
||||
|
||||
const processContent = (config: LintConfig, content: string): string => {
|
||||
let processedContent = content
|
||||
config.fileLintRules
|
||||
.filter((r) => !!r.fix)
|
||||
.forEach((rule) => {
|
||||
processedContent = rule.fix!(processedContent)
|
||||
})
|
||||
|
||||
return processedContent
|
||||
}
|
||||
|
||||
export const processLine = (config: LintConfig, line: string): string => {
|
||||
let processedLine = line
|
||||
config.lineLintRules
|
||||
.filter((r) => !!r.fix)
|
||||
.forEach((rule) => {
|
||||
processedLine = rule.fix!(line)
|
||||
})
|
||||
|
||||
return processedLine
|
||||
}
|
||||
21
src/formatExample.ts
Normal file
21
src/formatExample.ts
Normal file
@@ -0,0 +1,21 @@
|
||||
import { formatText } from './format/formatText'
|
||||
import { lintText } from './lint'
|
||||
|
||||
const content = `%put 'Hello';
|
||||
%put 'World';
|
||||
%macro somemacro()
|
||||
%put 'test';
|
||||
%mend;\r\n`
|
||||
|
||||
console.log(content)
|
||||
lintText(content).then((diagnostics) => {
|
||||
console.log('Before Formatting:')
|
||||
console.table(diagnostics)
|
||||
formatText(content).then((formattedText) => {
|
||||
lintText(formattedText).then((newDiagnostics) => {
|
||||
console.log('After Formatting:')
|
||||
console.log(formattedText)
|
||||
console.table(newDiagnostics)
|
||||
})
|
||||
})
|
||||
})
|
||||
@@ -1,3 +1,4 @@
|
||||
export * from './format'
|
||||
export * from './lint'
|
||||
export * from './types'
|
||||
export * from './utils'
|
||||
|
||||
@@ -2,68 +2,87 @@ import { lintFile } from './lintFile'
|
||||
import { Severity } from '../types/Severity'
|
||||
import path from 'path'
|
||||
|
||||
const expectedDiagnostics = [
|
||||
{
|
||||
message: 'Line contains trailing spaces',
|
||||
lineNumber: 1,
|
||||
startColumnNumber: 1,
|
||||
endColumnNumber: 2,
|
||||
severity: Severity.Warning
|
||||
},
|
||||
{
|
||||
message: 'Line contains trailing spaces',
|
||||
lineNumber: 2,
|
||||
startColumnNumber: 1,
|
||||
endColumnNumber: 2,
|
||||
severity: Severity.Warning
|
||||
},
|
||||
{
|
||||
message: 'File name contains spaces',
|
||||
lineNumber: 1,
|
||||
startColumnNumber: 1,
|
||||
endColumnNumber: 1,
|
||||
severity: Severity.Warning
|
||||
},
|
||||
{
|
||||
message: 'File name contains uppercase characters',
|
||||
lineNumber: 1,
|
||||
startColumnNumber: 1,
|
||||
endColumnNumber: 1,
|
||||
severity: Severity.Warning
|
||||
},
|
||||
{
|
||||
message: 'File missing Doxygen header',
|
||||
lineNumber: 1,
|
||||
startColumnNumber: 1,
|
||||
endColumnNumber: 1,
|
||||
severity: Severity.Warning
|
||||
},
|
||||
{
|
||||
message: 'Line contains encoded password',
|
||||
lineNumber: 5,
|
||||
startColumnNumber: 10,
|
||||
endColumnNumber: 18,
|
||||
severity: Severity.Error
|
||||
},
|
||||
{
|
||||
message: 'Line is indented with a tab',
|
||||
lineNumber: 7,
|
||||
startColumnNumber: 1,
|
||||
endColumnNumber: 1,
|
||||
severity: Severity.Warning
|
||||
},
|
||||
{
|
||||
message: 'Line has incorrect indentation - 3 spaces',
|
||||
lineNumber: 6,
|
||||
startColumnNumber: 1,
|
||||
endColumnNumber: 1,
|
||||
severity: Severity.Warning
|
||||
},
|
||||
{
|
||||
message: '%mend statement is missing macro name - mf_getuniquelibref',
|
||||
lineNumber: 17,
|
||||
startColumnNumber: 3,
|
||||
endColumnNumber: 9,
|
||||
severity: Severity.Warning
|
||||
}
|
||||
]
|
||||
|
||||
describe('lintFile', () => {
|
||||
it('should identify lint issues in a given file', async () => {
|
||||
const results = await lintFile(
|
||||
path.join(__dirname, '..', 'Example File.sas')
|
||||
)
|
||||
|
||||
expect(results.length).toEqual(8)
|
||||
expect(results).toContainEqual({
|
||||
message: 'Line contains trailing spaces',
|
||||
lineNumber: 1,
|
||||
startColumnNumber: 1,
|
||||
endColumnNumber: 2,
|
||||
severity: Severity.Warning
|
||||
})
|
||||
expect(results).toContainEqual({
|
||||
message: 'Line contains trailing spaces',
|
||||
lineNumber: 2,
|
||||
startColumnNumber: 1,
|
||||
endColumnNumber: 2,
|
||||
severity: Severity.Warning
|
||||
})
|
||||
expect(results).toContainEqual({
|
||||
message: 'File name contains spaces',
|
||||
lineNumber: 1,
|
||||
startColumnNumber: 1,
|
||||
endColumnNumber: 1,
|
||||
severity: Severity.Warning
|
||||
})
|
||||
expect(results).toContainEqual({
|
||||
message: 'File name contains uppercase characters',
|
||||
lineNumber: 1,
|
||||
startColumnNumber: 1,
|
||||
endColumnNumber: 1,
|
||||
severity: Severity.Warning
|
||||
})
|
||||
expect(results).toContainEqual({
|
||||
message: 'File missing Doxygen header',
|
||||
lineNumber: 1,
|
||||
startColumnNumber: 1,
|
||||
endColumnNumber: 1,
|
||||
severity: Severity.Warning
|
||||
})
|
||||
expect(results).toContainEqual({
|
||||
message: 'Line contains encoded password',
|
||||
lineNumber: 5,
|
||||
startColumnNumber: 10,
|
||||
endColumnNumber: 18,
|
||||
severity: Severity.Error
|
||||
})
|
||||
expect(results).toContainEqual({
|
||||
message: 'Line is indented with a tab',
|
||||
lineNumber: 7,
|
||||
startColumnNumber: 1,
|
||||
endColumnNumber: 1,
|
||||
severity: Severity.Warning
|
||||
})
|
||||
expect(results).toContainEqual({
|
||||
message: 'Line has incorrect indentation - 3 spaces',
|
||||
lineNumber: 6,
|
||||
startColumnNumber: 1,
|
||||
endColumnNumber: 1,
|
||||
severity: Severity.Warning
|
||||
})
|
||||
expect(results.length).toEqual(expectedDiagnostics.length)
|
||||
expect(results).toContainEqual(expectedDiagnostics[0])
|
||||
expect(results).toContainEqual(expectedDiagnostics[1])
|
||||
expect(results).toContainEqual(expectedDiagnostics[2])
|
||||
expect(results).toContainEqual(expectedDiagnostics[3])
|
||||
expect(results).toContainEqual(expectedDiagnostics[4])
|
||||
expect(results).toContainEqual(expectedDiagnostics[5])
|
||||
expect(results).toContainEqual(expectedDiagnostics[6])
|
||||
expect(results).toContainEqual(expectedDiagnostics[7])
|
||||
expect(results).toContainEqual(expectedDiagnostics[8])
|
||||
})
|
||||
})
|
||||
|
||||
@@ -1,67 +1,135 @@
|
||||
import { lintFolder } from './lintFolder'
|
||||
import { Severity } from '../types/Severity'
|
||||
import path from 'path'
|
||||
import {
|
||||
createFile,
|
||||
createFolder,
|
||||
deleteFolder,
|
||||
readFile
|
||||
} from '@sasjs/utils/file'
|
||||
|
||||
const expectedFilesCount = 1
|
||||
const expectedDiagnostics = [
|
||||
{
|
||||
message: 'Line contains trailing spaces',
|
||||
lineNumber: 1,
|
||||
startColumnNumber: 1,
|
||||
endColumnNumber: 2,
|
||||
severity: Severity.Warning
|
||||
},
|
||||
{
|
||||
message: 'Line contains trailing spaces',
|
||||
lineNumber: 2,
|
||||
startColumnNumber: 1,
|
||||
endColumnNumber: 2,
|
||||
severity: Severity.Warning
|
||||
},
|
||||
{
|
||||
message: 'File name contains spaces',
|
||||
lineNumber: 1,
|
||||
startColumnNumber: 1,
|
||||
endColumnNumber: 1,
|
||||
severity: Severity.Warning
|
||||
},
|
||||
{
|
||||
message: 'File name contains uppercase characters',
|
||||
lineNumber: 1,
|
||||
startColumnNumber: 1,
|
||||
endColumnNumber: 1,
|
||||
severity: Severity.Warning
|
||||
},
|
||||
{
|
||||
message: 'File missing Doxygen header',
|
||||
lineNumber: 1,
|
||||
startColumnNumber: 1,
|
||||
endColumnNumber: 1,
|
||||
severity: Severity.Warning
|
||||
},
|
||||
{
|
||||
message: 'Line contains encoded password',
|
||||
lineNumber: 5,
|
||||
startColumnNumber: 10,
|
||||
endColumnNumber: 18,
|
||||
severity: Severity.Error
|
||||
},
|
||||
{
|
||||
message: 'Line is indented with a tab',
|
||||
lineNumber: 7,
|
||||
startColumnNumber: 1,
|
||||
endColumnNumber: 1,
|
||||
severity: Severity.Warning
|
||||
},
|
||||
{
|
||||
message: 'Line has incorrect indentation - 3 spaces',
|
||||
lineNumber: 6,
|
||||
startColumnNumber: 1,
|
||||
endColumnNumber: 1,
|
||||
severity: Severity.Warning
|
||||
},
|
||||
{
|
||||
message: '%mend statement is missing macro name - mf_getuniquelibref',
|
||||
lineNumber: 17,
|
||||
startColumnNumber: 3,
|
||||
endColumnNumber: 9,
|
||||
severity: Severity.Warning
|
||||
}
|
||||
]
|
||||
|
||||
describe('lintFolder', () => {
|
||||
it('should identify lint issues in a given folder', async () => {
|
||||
const results = await lintFolder(path.join(__dirname, '..'))
|
||||
await createFolder(path.join(__dirname, 'lint-folder-test'))
|
||||
const content = await readFile(
|
||||
path.join(__dirname, '..', 'Example File.sas')
|
||||
)
|
||||
await createFile(
|
||||
path.join(__dirname, 'lint-folder-test', 'Example File.sas'),
|
||||
content
|
||||
)
|
||||
const results = await lintFolder(path.join(__dirname, 'lint-folder-test'))
|
||||
expect(results.size).toEqual(expectedFilesCount)
|
||||
const diagnostics = results.get(
|
||||
path.join(__dirname, 'lint-folder-test', 'Example File.sas')
|
||||
)!
|
||||
expect(diagnostics.length).toEqual(expectedDiagnostics.length)
|
||||
expect(diagnostics).toContainEqual(expectedDiagnostics[0])
|
||||
expect(diagnostics).toContainEqual(expectedDiagnostics[1])
|
||||
expect(diagnostics).toContainEqual(expectedDiagnostics[2])
|
||||
expect(diagnostics).toContainEqual(expectedDiagnostics[3])
|
||||
expect(diagnostics).toContainEqual(expectedDiagnostics[4])
|
||||
expect(diagnostics).toContainEqual(expectedDiagnostics[5])
|
||||
expect(diagnostics).toContainEqual(expectedDiagnostics[6])
|
||||
expect(diagnostics).toContainEqual(expectedDiagnostics[7])
|
||||
expect(diagnostics).toContainEqual(expectedDiagnostics[8])
|
||||
|
||||
expect(results.length).toEqual(8)
|
||||
expect(results).toContainEqual({
|
||||
message: 'Line contains trailing spaces',
|
||||
lineNumber: 1,
|
||||
startColumnNumber: 1,
|
||||
endColumnNumber: 2,
|
||||
severity: Severity.Warning
|
||||
})
|
||||
expect(results).toContainEqual({
|
||||
message: 'Line contains trailing spaces',
|
||||
lineNumber: 2,
|
||||
startColumnNumber: 1,
|
||||
endColumnNumber: 2,
|
||||
severity: Severity.Warning
|
||||
})
|
||||
expect(results).toContainEqual({
|
||||
message: 'File name contains spaces',
|
||||
lineNumber: 1,
|
||||
startColumnNumber: 1,
|
||||
endColumnNumber: 1,
|
||||
severity: Severity.Warning
|
||||
})
|
||||
expect(results).toContainEqual({
|
||||
message: 'File name contains uppercase characters',
|
||||
lineNumber: 1,
|
||||
startColumnNumber: 1,
|
||||
endColumnNumber: 1,
|
||||
severity: Severity.Warning
|
||||
})
|
||||
expect(results).toContainEqual({
|
||||
message: 'File missing Doxygen header',
|
||||
lineNumber: 1,
|
||||
startColumnNumber: 1,
|
||||
endColumnNumber: 1,
|
||||
severity: Severity.Warning
|
||||
})
|
||||
expect(results).toContainEqual({
|
||||
message: 'Line contains encoded password',
|
||||
lineNumber: 5,
|
||||
startColumnNumber: 10,
|
||||
endColumnNumber: 18,
|
||||
severity: Severity.Error
|
||||
})
|
||||
expect(results).toContainEqual({
|
||||
message: 'Line is indented with a tab',
|
||||
lineNumber: 7,
|
||||
startColumnNumber: 1,
|
||||
endColumnNumber: 1,
|
||||
severity: Severity.Warning
|
||||
})
|
||||
expect(results).toContainEqual({
|
||||
message: 'Line has incorrect indentation - 3 spaces',
|
||||
lineNumber: 6,
|
||||
startColumnNumber: 1,
|
||||
endColumnNumber: 1,
|
||||
severity: Severity.Warning
|
||||
})
|
||||
await deleteFolder(path.join(__dirname, 'lint-folder-test'))
|
||||
})
|
||||
|
||||
it('should identify lint issues in subfolders of a given folder', async () => {
|
||||
await createFolder(path.join(__dirname, 'lint-folder-test'))
|
||||
await createFolder(path.join(__dirname, 'lint-folder-test', 'subfolder'))
|
||||
const content = await readFile(
|
||||
path.join(__dirname, '..', 'Example File.sas')
|
||||
)
|
||||
await createFile(
|
||||
path.join(__dirname, 'lint-folder-test', 'subfolder', 'Example File.sas'),
|
||||
content
|
||||
)
|
||||
const results = await lintFolder(path.join(__dirname, 'lint-folder-test'))
|
||||
expect(results.size).toEqual(expectedFilesCount)
|
||||
const diagnostics = results.get(
|
||||
path.join(__dirname, 'lint-folder-test', 'subfolder', 'Example File.sas')
|
||||
)!
|
||||
expect(diagnostics.length).toEqual(expectedDiagnostics.length)
|
||||
expect(diagnostics).toContainEqual(expectedDiagnostics[0])
|
||||
expect(diagnostics).toContainEqual(expectedDiagnostics[1])
|
||||
expect(diagnostics).toContainEqual(expectedDiagnostics[2])
|
||||
expect(diagnostics).toContainEqual(expectedDiagnostics[3])
|
||||
expect(diagnostics).toContainEqual(expectedDiagnostics[4])
|
||||
expect(diagnostics).toContainEqual(expectedDiagnostics[5])
|
||||
expect(diagnostics).toContainEqual(expectedDiagnostics[6])
|
||||
expect(diagnostics).toContainEqual(expectedDiagnostics[7])
|
||||
expect(diagnostics).toContainEqual(expectedDiagnostics[8])
|
||||
|
||||
await deleteFolder(path.join(__dirname, 'lint-folder-test'))
|
||||
})
|
||||
})
|
||||
|
||||
@@ -20,19 +20,18 @@ const excludeFolders = [
|
||||
* Analyses and produces a set of diagnostics for the folder at the given path.
|
||||
* @param {string} folderPath - the path to the folder to be linted.
|
||||
* @param {LintConfig} configuration - an optional configuration. When not passed in, this is read from the .sasjslint file.
|
||||
* @returns {Diagnostic[]} array of diagnostic objects, each containing a warning, line number and column number.
|
||||
* @returns {Promise<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 lintFolder = async (
|
||||
folderPath: string,
|
||||
configuration?: LintConfig
|
||||
) => {
|
||||
const config = configuration || (await getLintConfig())
|
||||
const diagnostics: Diagnostic[] = []
|
||||
let diagnostics: Map<string, Diagnostic[]> = new Map<string, Diagnostic[]>()
|
||||
const fileNames = await listSasFiles(folderPath)
|
||||
await asyncForEach(fileNames, async (fileName) => {
|
||||
diagnostics.push(
|
||||
...(await lintFile(path.join(folderPath, fileName), config))
|
||||
)
|
||||
const filePath = path.join(folderPath, fileName)
|
||||
diagnostics.set(filePath, await lintFile(filePath, config))
|
||||
})
|
||||
|
||||
const subFolders = (await listSubFoldersInFolder(folderPath)).filter(
|
||||
@@ -40,9 +39,11 @@ export const lintFolder = async (
|
||||
)
|
||||
|
||||
await asyncForEach(subFolders, async (subFolder) => {
|
||||
diagnostics.push(
|
||||
...(await lintFolder(path.join(folderPath, subFolder), config))
|
||||
const subFolderDiagnostics = await lintFolder(
|
||||
path.join(folderPath, subFolder),
|
||||
config
|
||||
)
|
||||
diagnostics = new Map([...diagnostics, ...subFolderDiagnostics])
|
||||
})
|
||||
|
||||
return diagnostics
|
||||
|
||||
@@ -1,67 +1,125 @@
|
||||
import { lintProject } from './lintProject'
|
||||
import { Severity } from '../types/Severity'
|
||||
import * as getProjectRootModule from '../utils/getProjectRoot'
|
||||
import path from 'path'
|
||||
import { createFolder, createFile, readFile, deleteFolder } from '@sasjs/utils'
|
||||
import { DefaultLintConfiguration } from '../utils'
|
||||
jest.mock('../utils/getProjectRoot')
|
||||
|
||||
const expectedFilesCount = 1
|
||||
const expectedDiagnostics = [
|
||||
{
|
||||
message: 'Line contains trailing spaces',
|
||||
lineNumber: 1,
|
||||
startColumnNumber: 1,
|
||||
endColumnNumber: 2,
|
||||
severity: Severity.Warning
|
||||
},
|
||||
{
|
||||
message: 'Line contains trailing spaces',
|
||||
lineNumber: 2,
|
||||
startColumnNumber: 1,
|
||||
endColumnNumber: 2,
|
||||
severity: Severity.Warning
|
||||
},
|
||||
{
|
||||
message: 'File name contains spaces',
|
||||
lineNumber: 1,
|
||||
startColumnNumber: 1,
|
||||
endColumnNumber: 1,
|
||||
severity: Severity.Warning
|
||||
},
|
||||
{
|
||||
message: 'File name contains uppercase characters',
|
||||
lineNumber: 1,
|
||||
startColumnNumber: 1,
|
||||
endColumnNumber: 1,
|
||||
severity: Severity.Warning
|
||||
},
|
||||
{
|
||||
message: 'File missing Doxygen header',
|
||||
lineNumber: 1,
|
||||
startColumnNumber: 1,
|
||||
endColumnNumber: 1,
|
||||
severity: Severity.Warning
|
||||
},
|
||||
{
|
||||
message: 'Line contains encoded password',
|
||||
lineNumber: 5,
|
||||
startColumnNumber: 10,
|
||||
endColumnNumber: 18,
|
||||
severity: Severity.Error
|
||||
},
|
||||
{
|
||||
message: 'Line is indented with a tab',
|
||||
lineNumber: 7,
|
||||
startColumnNumber: 1,
|
||||
endColumnNumber: 1,
|
||||
severity: Severity.Warning
|
||||
},
|
||||
{
|
||||
message: 'Line has incorrect indentation - 3 spaces',
|
||||
lineNumber: 6,
|
||||
startColumnNumber: 1,
|
||||
endColumnNumber: 1,
|
||||
severity: Severity.Warning
|
||||
},
|
||||
{
|
||||
message: '%mend statement is missing macro name - mf_getuniquelibref',
|
||||
lineNumber: 17,
|
||||
startColumnNumber: 3,
|
||||
endColumnNumber: 9,
|
||||
severity: Severity.Warning
|
||||
}
|
||||
]
|
||||
|
||||
describe('lintProject', () => {
|
||||
it('should identify lint issues in a given project', async () => {
|
||||
await createFolder(path.join(__dirname, 'lint-project-test'))
|
||||
const content = await readFile(
|
||||
path.join(__dirname, '..', 'Example File.sas')
|
||||
)
|
||||
await createFile(
|
||||
path.join(__dirname, 'lint-project-test', 'Example File.sas'),
|
||||
content
|
||||
)
|
||||
await createFile(
|
||||
path.join(__dirname, 'lint-project-test', '.sasjslint'),
|
||||
JSON.stringify(DefaultLintConfiguration)
|
||||
)
|
||||
|
||||
jest
|
||||
.spyOn(getProjectRootModule, 'getProjectRoot')
|
||||
.mockImplementation(() =>
|
||||
Promise.resolve(path.join(__dirname, 'lint-project-test'))
|
||||
)
|
||||
const results = await lintProject()
|
||||
|
||||
expect(results.length).toEqual(8)
|
||||
expect(results).toContainEqual({
|
||||
message: 'Line contains trailing spaces',
|
||||
lineNumber: 1,
|
||||
startColumnNumber: 1,
|
||||
endColumnNumber: 2,
|
||||
severity: Severity.Warning
|
||||
})
|
||||
expect(results).toContainEqual({
|
||||
message: 'Line contains trailing spaces',
|
||||
lineNumber: 2,
|
||||
startColumnNumber: 1,
|
||||
endColumnNumber: 2,
|
||||
severity: Severity.Warning
|
||||
})
|
||||
expect(results).toContainEqual({
|
||||
message: 'File name contains spaces',
|
||||
lineNumber: 1,
|
||||
startColumnNumber: 1,
|
||||
endColumnNumber: 1,
|
||||
severity: Severity.Warning
|
||||
})
|
||||
expect(results).toContainEqual({
|
||||
message: 'File name contains uppercase characters',
|
||||
lineNumber: 1,
|
||||
startColumnNumber: 1,
|
||||
endColumnNumber: 1,
|
||||
severity: Severity.Warning
|
||||
})
|
||||
expect(results).toContainEqual({
|
||||
message: 'File missing Doxygen header',
|
||||
lineNumber: 1,
|
||||
startColumnNumber: 1,
|
||||
endColumnNumber: 1,
|
||||
severity: Severity.Warning
|
||||
})
|
||||
expect(results).toContainEqual({
|
||||
message: 'Line contains encoded password',
|
||||
lineNumber: 5,
|
||||
startColumnNumber: 10,
|
||||
endColumnNumber: 18,
|
||||
severity: Severity.Error
|
||||
})
|
||||
expect(results).toContainEqual({
|
||||
message: 'Line is indented with a tab',
|
||||
lineNumber: 7,
|
||||
startColumnNumber: 1,
|
||||
endColumnNumber: 1,
|
||||
severity: Severity.Warning
|
||||
})
|
||||
expect(results).toContainEqual({
|
||||
message: 'Line has incorrect indentation - 3 spaces',
|
||||
lineNumber: 6,
|
||||
startColumnNumber: 1,
|
||||
endColumnNumber: 1,
|
||||
severity: Severity.Warning
|
||||
})
|
||||
expect(results.size).toEqual(expectedFilesCount)
|
||||
const diagnostics = results.get(
|
||||
path.join(__dirname, 'lint-project-test', 'Example File.sas')
|
||||
)!
|
||||
expect(diagnostics.length).toEqual(expectedDiagnostics.length)
|
||||
expect(diagnostics).toContainEqual(expectedDiagnostics[0])
|
||||
expect(diagnostics).toContainEqual(expectedDiagnostics[1])
|
||||
expect(diagnostics).toContainEqual(expectedDiagnostics[2])
|
||||
expect(diagnostics).toContainEqual(expectedDiagnostics[3])
|
||||
expect(diagnostics).toContainEqual(expectedDiagnostics[4])
|
||||
expect(diagnostics).toContainEqual(expectedDiagnostics[5])
|
||||
expect(diagnostics).toContainEqual(expectedDiagnostics[6])
|
||||
expect(diagnostics).toContainEqual(expectedDiagnostics[7])
|
||||
expect(diagnostics).toContainEqual(expectedDiagnostics[8])
|
||||
|
||||
await deleteFolder(path.join(__dirname, 'lint-project-test'))
|
||||
})
|
||||
|
||||
it('should throw an error when a project root is not found', async () => {
|
||||
jest
|
||||
.spyOn(getProjectRootModule, 'getProjectRoot')
|
||||
.mockImplementationOnce(() => Promise.resolve(''))
|
||||
|
||||
await expect(lintProject()).rejects.toThrowError(
|
||||
'SASjs Project Root was not found.'
|
||||
)
|
||||
})
|
||||
})
|
||||
|
||||
@@ -1,14 +1,13 @@
|
||||
import { getProjectRoot } from '../utils'
|
||||
import { getProjectRoot } from '../utils/getProjectRoot'
|
||||
import { lintFolder } from './lintFolder'
|
||||
|
||||
/**
|
||||
* Analyses and produces a set of diagnostics for the current project.
|
||||
* @returns {Diagnostic[]} array of diagnostic objects, each containing a warning, line number and column number.
|
||||
* @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 =
|
||||
(await getProjectRoot()) || process.projectDir || process.currentDir
|
||||
|
||||
if (!projectRoot) {
|
||||
throw new Error('SASjs Project Root was not found.')
|
||||
}
|
||||
|
||||
@@ -1,25 +0,0 @@
|
||||
import { splitText } from './shared'
|
||||
|
||||
describe('splitText', () => {
|
||||
it('should return an empty array when text is falsy', () => {
|
||||
const lines = splitText('')
|
||||
|
||||
expect(lines.length).toEqual(0)
|
||||
})
|
||||
|
||||
it('should return an array of lines from text', () => {
|
||||
const lines = splitText(`line 1\nline 2`)
|
||||
|
||||
expect(lines.length).toEqual(2)
|
||||
expect(lines[0]).toEqual('line 1')
|
||||
expect(lines[1]).toEqual('line 2')
|
||||
})
|
||||
|
||||
it('should work with CRLF line endings', () => {
|
||||
const lines = splitText(`line 1\r\nline 2`)
|
||||
|
||||
expect(lines.length).toEqual(2)
|
||||
expect(lines[0]).toEqual('line 1')
|
||||
expect(lines[1]).toEqual('line 2')
|
||||
})
|
||||
})
|
||||
@@ -1,17 +1,8 @@
|
||||
import { LintConfig, Diagnostic } from '../types'
|
||||
|
||||
/**
|
||||
* Splits the given content into a list of lines, regardless of CRLF or LF line endings.
|
||||
* @param {string} text - the text content to be split into lines.
|
||||
* @returns {string[]} an array of lines from the given text
|
||||
*/
|
||||
export const splitText = (text: string): string[] => {
|
||||
if (!text) return []
|
||||
return text.replace(/\r\n/g, '\n').split('\n')
|
||||
}
|
||||
import { splitText } from '../utils'
|
||||
|
||||
export const processText = (text: string, config: LintConfig) => {
|
||||
const lines = splitText(text)
|
||||
const lines = splitText(text, config)
|
||||
const diagnostics: Diagnostic[] = []
|
||||
diagnostics.push(...processContent(config, text))
|
||||
lines.forEach((line, index) => {
|
||||
|
||||
@@ -1,7 +1,8 @@
|
||||
import { Severity } from '../types/Severity'
|
||||
import { LintConfig } from '../../types'
|
||||
import { Severity } from '../../types/Severity'
|
||||
import { hasDoxygenHeader } from './hasDoxygenHeader'
|
||||
|
||||
describe('hasDoxygenHeader', () => {
|
||||
describe('hasDoxygenHeader - test', () => {
|
||||
it('should return an empty array when the file starts with a doxygen header', () => {
|
||||
const content = `/**
|
||||
@file
|
||||
@@ -69,3 +70,47 @@ describe('hasDoxygenHeader', () => {
|
||||
])
|
||||
})
|
||||
})
|
||||
|
||||
describe('hasDoxygenHeader - fix', () => {
|
||||
it('should not alter the text if a doxygen header is already present', () => {
|
||||
const content = `/**
|
||||
@file
|
||||
@brief Returns an unused libref
|
||||
**/
|
||||
|
||||
%macro mf_getuniquelibref(prefix=mclib,maxtries=1000);
|
||||
%local x libref;
|
||||
%let x={SAS002};
|
||||
%do x=0 %to &maxtries;`
|
||||
|
||||
expect(hasDoxygenHeader.fix!(content)).toEqual(content)
|
||||
})
|
||||
|
||||
it('should should add a doxygen header if not present', () => {
|
||||
const content = `%macro mf_getuniquelibref(prefix=mclib,maxtries=1000);
|
||||
%local x libref;
|
||||
%let x={SAS002};
|
||||
%do x=0 %to &maxtries;`
|
||||
|
||||
expect(hasDoxygenHeader.fix!(content)).toEqual(
|
||||
`/**
|
||||
@file
|
||||
@brief <Your brief here>
|
||||
<h4> SAS Macros </h4>
|
||||
**/` +
|
||||
'\n' +
|
||||
content
|
||||
)
|
||||
})
|
||||
|
||||
it('should use CRLF line endings when configured', () => {
|
||||
const content = `%macro mf_getuniquelibref(prefix=mclib,maxtries=1000);\n%local x libref;\n%let x={SAS002};\n%do x=0 %to &maxtries;`
|
||||
const config = new LintConfig({ lineEndings: 'crlf' })
|
||||
|
||||
expect(hasDoxygenHeader.fix!(content, config)).toEqual(
|
||||
`/**\r\n @file\r\n @brief <Your brief here>\r\n <h4> SAS Macros </h4>\r\n**/` +
|
||||
'\r\n' +
|
||||
content
|
||||
)
|
||||
})
|
||||
})
|
||||
@@ -1,6 +1,10 @@
|
||||
import { FileLintRule } from '../types/LintRule'
|
||||
import { LintRuleType } from '../types/LintRuleType'
|
||||
import { Severity } from '../types/Severity'
|
||||
import { LintConfig } from '../../types'
|
||||
import { LineEndings } from '../../types/LineEndings'
|
||||
import { FileLintRule } from '../../types/LintRule'
|
||||
import { LintRuleType } from '../../types/LintRuleType'
|
||||
import { Severity } from '../../types/Severity'
|
||||
|
||||
const DoxygenHeader = `/**{lineEnding} @file{lineEnding} @brief <Your brief here>{lineEnding} <h4> SAS Macros </h4>{lineEnding}**/`
|
||||
|
||||
const name = 'hasDoxygenHeader'
|
||||
const description =
|
||||
@@ -32,6 +36,19 @@ const test = (value: string) => {
|
||||
}
|
||||
}
|
||||
|
||||
const fix = (value: string, config?: LintConfig): string => {
|
||||
if (test(value).length === 0) {
|
||||
return value
|
||||
}
|
||||
const lineEndingConfig = config?.lineEndings || LineEndings.LF
|
||||
const lineEnding = lineEndingConfig === LineEndings.LF ? '\n' : '\r\n'
|
||||
|
||||
return `${DoxygenHeader.replace(
|
||||
/{lineEnding}/g,
|
||||
lineEnding
|
||||
)}${lineEnding}${value}`
|
||||
}
|
||||
|
||||
/**
|
||||
* Lint rule that checks for the presence of a Doxygen header in a given file.
|
||||
*/
|
||||
@@ -40,5 +57,6 @@ export const hasDoxygenHeader: FileLintRule = {
|
||||
name,
|
||||
description,
|
||||
message,
|
||||
test
|
||||
test,
|
||||
fix
|
||||
}
|
||||
465
src/rules/file/hasMacroNameInMend.spec.ts
Normal file
465
src/rules/file/hasMacroNameInMend.spec.ts
Normal file
@@ -0,0 +1,465 @@
|
||||
import { LintConfig } from '../../types'
|
||||
import { Severity } from '../../types/Severity'
|
||||
import { hasMacroNameInMend } from './hasMacroNameInMend'
|
||||
|
||||
describe('hasMacroNameInMend - test', () => {
|
||||
it('should return an empty array when %mend has correct macro name', () => {
|
||||
const content = `
|
||||
%macro somemacro();
|
||||
%put &sysmacroname;
|
||||
%mend somemacro;`
|
||||
|
||||
expect(hasMacroNameInMend.test(content)).toEqual([])
|
||||
})
|
||||
|
||||
it('should return an empty array when %mend has correct macro name without parentheses', () => {
|
||||
const content = `
|
||||
%macro somemacro;
|
||||
%put &sysmacroname;
|
||||
%mend somemacro;`
|
||||
|
||||
expect(hasMacroNameInMend.test(content)).toEqual([])
|
||||
})
|
||||
|
||||
it('should return an array with a single diagnostic when %mend has no macro name', () => {
|
||||
const content = `
|
||||
%macro somemacro;
|
||||
%put &sysmacroname;
|
||||
%mend;`
|
||||
|
||||
expect(hasMacroNameInMend.test(content)).toEqual([
|
||||
{
|
||||
message: '%mend statement is missing macro name - somemacro',
|
||||
lineNumber: 4,
|
||||
startColumnNumber: 3,
|
||||
endColumnNumber: 9,
|
||||
severity: Severity.Warning
|
||||
}
|
||||
])
|
||||
})
|
||||
|
||||
it('should return an array with a single diagnostic when a macro is missing an %mend statement', () => {
|
||||
const content = `%macro somemacro;
|
||||
%put &sysmacroname;`
|
||||
|
||||
expect(hasMacroNameInMend.test(content)).toEqual([
|
||||
{
|
||||
message: 'Missing %mend statement for macro - somemacro',
|
||||
lineNumber: 1,
|
||||
startColumnNumber: 1,
|
||||
endColumnNumber: 1,
|
||||
severity: Severity.Warning
|
||||
}
|
||||
])
|
||||
})
|
||||
|
||||
it('should return an array with a diagnostic for each macro missing an %mend statement', () => {
|
||||
const content = `%macro somemacro;
|
||||
%put &sysmacroname;
|
||||
%macro othermacro`
|
||||
|
||||
expect(hasMacroNameInMend.test(content)).toEqual([
|
||||
{
|
||||
message: 'Missing %mend statement for macro - somemacro',
|
||||
lineNumber: 1,
|
||||
startColumnNumber: 1,
|
||||
endColumnNumber: 1,
|
||||
severity: Severity.Warning
|
||||
},
|
||||
{
|
||||
message: 'Missing %mend statement for macro - othermacro',
|
||||
lineNumber: 3,
|
||||
startColumnNumber: 1,
|
||||
endColumnNumber: 1,
|
||||
severity: Severity.Warning
|
||||
}
|
||||
])
|
||||
})
|
||||
|
||||
it('should return an array with a single diagnostic when %mend has incorrect macro name', () => {
|
||||
const content = `
|
||||
%macro somemacro;
|
||||
%put &sysmacroname;
|
||||
%mend someanothermacro;`
|
||||
|
||||
expect(hasMacroNameInMend.test(content)).toEqual([
|
||||
{
|
||||
message: `%mend statement has mismatched macro name, it should be 'somemacro'`,
|
||||
lineNumber: 4,
|
||||
startColumnNumber: 9,
|
||||
endColumnNumber: 24,
|
||||
severity: Severity.Warning
|
||||
}
|
||||
])
|
||||
})
|
||||
|
||||
it('should return an array with a single diagnostic when extra %mend statement is present', () => {
|
||||
const content = `
|
||||
%macro somemacro;
|
||||
%put &sysmacroname;
|
||||
%mend somemacro;
|
||||
%mend something;`
|
||||
|
||||
expect(hasMacroNameInMend.test(content)).toEqual([
|
||||
{
|
||||
message: '%mend statement is redundant',
|
||||
lineNumber: 5,
|
||||
startColumnNumber: 3,
|
||||
endColumnNumber: 18,
|
||||
severity: Severity.Warning
|
||||
}
|
||||
])
|
||||
})
|
||||
|
||||
it('should return an empty array when the file is undefined', () => {
|
||||
const content = undefined
|
||||
|
||||
expect(hasMacroNameInMend.test((content as unknown) as string)).toEqual([])
|
||||
})
|
||||
|
||||
describe('nestedMacros', () => {
|
||||
it('should return an empty array when %mend has correct macro name', () => {
|
||||
const content = `
|
||||
%macro outer();
|
||||
|
||||
%macro inner();
|
||||
%put inner;
|
||||
%mend inner;
|
||||
%inner()
|
||||
%put outer;
|
||||
%mend outer;`
|
||||
|
||||
expect(hasMacroNameInMend.test(content)).toEqual([])
|
||||
})
|
||||
|
||||
it('should return an array with a single diagnostic when %mend has no macro name(inner)', () => {
|
||||
const content = `
|
||||
%macro outer();
|
||||
|
||||
%macro inner();
|
||||
%put inner;
|
||||
%mend;
|
||||
%inner()
|
||||
%put outer;
|
||||
%mend outer;`
|
||||
|
||||
expect(hasMacroNameInMend.test(content)).toEqual([
|
||||
{
|
||||
message: '%mend statement is missing macro name - inner',
|
||||
lineNumber: 6,
|
||||
startColumnNumber: 5,
|
||||
endColumnNumber: 11,
|
||||
severity: Severity.Warning
|
||||
}
|
||||
])
|
||||
})
|
||||
|
||||
it('should return an array with a single diagnostic when %mend has no macro name(outer)', () => {
|
||||
const content = `
|
||||
%macro outer();
|
||||
|
||||
%macro inner();
|
||||
%put inner;
|
||||
%mend inner;
|
||||
%inner()
|
||||
%put outer;
|
||||
%mend;`
|
||||
|
||||
expect(hasMacroNameInMend.test(content)).toEqual([
|
||||
{
|
||||
message: '%mend statement is missing macro name - outer',
|
||||
lineNumber: 9,
|
||||
startColumnNumber: 3,
|
||||
endColumnNumber: 9,
|
||||
severity: Severity.Warning
|
||||
}
|
||||
])
|
||||
})
|
||||
|
||||
it('should return an array with two diagnostics when %mend has no macro name(none)', () => {
|
||||
const content = `
|
||||
%macro outer();
|
||||
|
||||
%macro inner();
|
||||
%put inner;
|
||||
%mend;
|
||||
%inner()
|
||||
%put outer;
|
||||
%mend;`
|
||||
|
||||
expect(hasMacroNameInMend.test(content)).toEqual([
|
||||
{
|
||||
message: '%mend statement is missing macro name - inner',
|
||||
lineNumber: 6,
|
||||
startColumnNumber: 5,
|
||||
endColumnNumber: 11,
|
||||
severity: Severity.Warning
|
||||
},
|
||||
{
|
||||
message: '%mend statement is missing macro name - outer',
|
||||
lineNumber: 9,
|
||||
startColumnNumber: 3,
|
||||
endColumnNumber: 9,
|
||||
severity: Severity.Warning
|
||||
}
|
||||
])
|
||||
})
|
||||
})
|
||||
|
||||
describe('with extra spaces and comments', () => {
|
||||
it('should return an empty array when %mend has correct macro name', () => {
|
||||
const content = `
|
||||
/* 1st comment */
|
||||
%macro somemacro ;
|
||||
|
||||
%put &sysmacroname;
|
||||
|
||||
/* 2nd
|
||||
comment */
|
||||
/* 3rd comment */ %mend somemacro ;`
|
||||
|
||||
expect(hasMacroNameInMend.test(content)).toEqual([])
|
||||
})
|
||||
|
||||
it('should return an array with a single diagnostic when %mend has correct macro name having code in comments', () => {
|
||||
const content = `/**
|
||||
@file examplemacro.sas
|
||||
@brief an example of a macro to be used in a service
|
||||
@details This macro is great. Yadda yadda yadda. Usage:
|
||||
|
||||
* code formatting applies when indented by 4 spaces; code formatting applies when indented by 4 spaces; code formatting applies when indented by 4 spaces; code formatting applies when indented by 4 spaces; code formatting applies when indented by 4 spaces;
|
||||
|
||||
some code
|
||||
%macro examplemacro123();
|
||||
|
||||
%examplemacro()
|
||||
|
||||
<h4> SAS Macros </h4>
|
||||
@li doesnothing.sas
|
||||
|
||||
@author Allan Bowe
|
||||
**/
|
||||
|
||||
%macro examplemacro();
|
||||
|
||||
proc sql;
|
||||
create table areas
|
||||
as select area
|
||||
|
||||
from sashelp.springs;
|
||||
|
||||
%doesnothing();
|
||||
|
||||
%mend;`
|
||||
|
||||
expect(hasMacroNameInMend.test(content)).toEqual([
|
||||
{
|
||||
message: '%mend statement is missing macro name - examplemacro',
|
||||
lineNumber: 29,
|
||||
startColumnNumber: 5,
|
||||
endColumnNumber: 11,
|
||||
severity: Severity.Warning
|
||||
}
|
||||
])
|
||||
})
|
||||
|
||||
it('should return an array with a single diagnostic when %mend has incorrect macro name', () => {
|
||||
const content = `
|
||||
%macro somemacro;
|
||||
/* some comments */
|
||||
%put &sysmacroname;
|
||||
/* some comments */
|
||||
%mend someanothermacro ;`
|
||||
|
||||
expect(hasMacroNameInMend.test(content)).toEqual([
|
||||
{
|
||||
message: `%mend statement has mismatched macro name, it should be 'somemacro'`,
|
||||
lineNumber: 6,
|
||||
startColumnNumber: 14,
|
||||
endColumnNumber: 29,
|
||||
severity: Severity.Warning
|
||||
}
|
||||
])
|
||||
})
|
||||
|
||||
it('should return an array with a single diagnostic when %mend has no macro name', () => {
|
||||
const content = `
|
||||
%macro somemacro ;
|
||||
/* some comments */%put &sysmacroname;
|
||||
%mend ;`
|
||||
|
||||
expect(hasMacroNameInMend.test(content)).toEqual([
|
||||
{
|
||||
message: '%mend statement is missing macro name - somemacro',
|
||||
lineNumber: 4,
|
||||
startColumnNumber: 5,
|
||||
endColumnNumber: 11,
|
||||
severity: Severity.Warning
|
||||
}
|
||||
])
|
||||
})
|
||||
|
||||
describe('nestedMacros', () => {
|
||||
it('should return an empty array when %mend has correct macro name', () => {
|
||||
const content = `
|
||||
%macro outer( ) ;
|
||||
|
||||
|
||||
%macro inner();
|
||||
|
||||
%put inner;
|
||||
|
||||
%mend inner;
|
||||
|
||||
%inner()
|
||||
|
||||
%put outer;
|
||||
%mend outer;`
|
||||
|
||||
expect(hasMacroNameInMend.test(content)).toEqual([])
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
it('should use the configured line ending while testing content', () => {
|
||||
const content = `%macro somemacro();\r\n%put &sysmacroname;\r\n%mend;`
|
||||
|
||||
const diagnostics = hasMacroNameInMend.test(
|
||||
content,
|
||||
new LintConfig({ lineEndings: 'crlf' })
|
||||
)
|
||||
|
||||
expect(diagnostics).toEqual([
|
||||
{
|
||||
message: '%mend statement is missing macro name - somemacro',
|
||||
lineNumber: 3,
|
||||
startColumnNumber: 1,
|
||||
endColumnNumber: 7,
|
||||
severity: Severity.Warning
|
||||
}
|
||||
])
|
||||
})
|
||||
})
|
||||
|
||||
describe('hasMacroNameInMend - fix', () => {
|
||||
it('should add macro name to the mend statement if not present', () => {
|
||||
const content = ` %macro somemacro;\n %put &sysmacroname;\n %mend;`
|
||||
const expectedContent = ` %macro somemacro;\n %put &sysmacroname;\n %mend somemacro;`
|
||||
|
||||
const formattedContent = hasMacroNameInMend.fix!(content, new LintConfig())
|
||||
|
||||
expect(formattedContent).toEqual(expectedContent)
|
||||
})
|
||||
|
||||
it('should add macro name to the mend statement if not present ( code in single line )', () => {
|
||||
const content = `%macro somemacro; %put &sysmacroname; %mend; some code;`
|
||||
const expectedContent = `%macro somemacro; %put &sysmacroname; %mend somemacro; some code;`
|
||||
|
||||
const formattedContent = hasMacroNameInMend.fix!(content, new LintConfig())
|
||||
|
||||
expect(formattedContent).toEqual(expectedContent)
|
||||
})
|
||||
|
||||
it('should add macro name to the mend statement if not present ( with multiple macros )', () => {
|
||||
const content = `
|
||||
%macro somemacro;
|
||||
%put &sysmacroname;
|
||||
%mend somemacro;
|
||||
|
||||
%macro somemacro2;
|
||||
%put &sysmacroname2;
|
||||
%mend;`
|
||||
const expectedContent = `
|
||||
%macro somemacro;
|
||||
%put &sysmacroname;
|
||||
%mend somemacro;
|
||||
|
||||
%macro somemacro2;
|
||||
%put &sysmacroname2;
|
||||
%mend somemacro2;`
|
||||
|
||||
const formattedContent = hasMacroNameInMend.fix!(content, new LintConfig())
|
||||
|
||||
expect(formattedContent).toEqual(expectedContent)
|
||||
})
|
||||
|
||||
it('should remove redundant %mend statement', () => {
|
||||
const content = `
|
||||
%macro somemacro;
|
||||
%put &sysmacroname;
|
||||
%mend somemacro;
|
||||
%mend something;`
|
||||
const expectedContent = `
|
||||
%macro somemacro;
|
||||
%put &sysmacroname;
|
||||
%mend somemacro;
|
||||
`
|
||||
|
||||
const formattedContent = hasMacroNameInMend.fix!(content, new LintConfig())
|
||||
expect(formattedContent).toEqual(expectedContent)
|
||||
})
|
||||
|
||||
it('should remove redundant %mend statement with comments', () => {
|
||||
const content = `
|
||||
%macro somemacro;
|
||||
%put &sysmacroname;
|
||||
%mend somemacro;
|
||||
/* some comment */
|
||||
/* some comment */ %mend something; some code;
|
||||
/* some comment */`
|
||||
const expectedContent = `
|
||||
%macro somemacro;
|
||||
%put &sysmacroname;
|
||||
%mend somemacro;
|
||||
/* some comment */
|
||||
/* some comment */ some code;
|
||||
/* some comment */`
|
||||
|
||||
const formattedContent = hasMacroNameInMend.fix!(content, new LintConfig())
|
||||
expect(formattedContent).toEqual(expectedContent)
|
||||
})
|
||||
|
||||
it('should correct mismatched macro name', () => {
|
||||
const content = `
|
||||
%macro somemacro;
|
||||
%put &sysmacroname;
|
||||
%mend someanothermacro;`
|
||||
const expectedContent = `
|
||||
%macro somemacro;
|
||||
%put &sysmacroname;
|
||||
%mend somemacro;`
|
||||
|
||||
const formattedContent = hasMacroNameInMend.fix!(content, new LintConfig())
|
||||
expect(formattedContent).toEqual(expectedContent)
|
||||
})
|
||||
|
||||
it('should correct mismatched macro name with comments', () => {
|
||||
const content = `
|
||||
%macro somemacro;
|
||||
/* some comments */
|
||||
%put &sysmacroname;
|
||||
/* some comments */
|
||||
%mend someanothermacro ;`
|
||||
const expectedContent = `
|
||||
%macro somemacro;
|
||||
/* some comments */
|
||||
%put &sysmacroname;
|
||||
/* some comments */
|
||||
%mend somemacro ;`
|
||||
|
||||
const formattedContent = hasMacroNameInMend.fix!(content, new LintConfig())
|
||||
expect(formattedContent).toEqual(expectedContent)
|
||||
})
|
||||
|
||||
it('should use the configured line ending while applying the fix', () => {
|
||||
const content = `%macro somemacro();\r\n%put &sysmacroname;\r\n%mend ;`
|
||||
const expectedContent = `%macro somemacro();\r\n%put &sysmacroname;\r\n%mend somemacro ;`
|
||||
|
||||
const formattedContent = hasMacroNameInMend.fix!(
|
||||
content,
|
||||
new LintConfig({ lineEndings: 'crlf' })
|
||||
)
|
||||
|
||||
expect(formattedContent).toEqual(expectedContent)
|
||||
})
|
||||
})
|
||||
132
src/rules/file/hasMacroNameInMend.ts
Normal file
132
src/rules/file/hasMacroNameInMend.ts
Normal file
@@ -0,0 +1,132 @@
|
||||
import { Diagnostic } from '../../types/Diagnostic'
|
||||
import { FileLintRule } from '../../types/LintRule'
|
||||
import { LintRuleType } from '../../types/LintRuleType'
|
||||
import { Severity } from '../../types/Severity'
|
||||
import { getColumnNumber } from '../../utils/getColumnNumber'
|
||||
import { LintConfig } from '../../types'
|
||||
import { LineEndings } from '../../types/LineEndings'
|
||||
import { parseMacros } from '../../utils/parseMacros'
|
||||
|
||||
const name = 'hasMacroNameInMend'
|
||||
const description =
|
||||
'Enforces the presence of the macro name in each %mend statement.'
|
||||
const message = '%mend statement has missing or incorrect macro name'
|
||||
const test = (value: string, config?: LintConfig) => {
|
||||
const lineEnding = config?.lineEndings === LineEndings.CRLF ? '\r\n' : '\n'
|
||||
const lines: string[] = value ? value.split(lineEnding) : []
|
||||
const macros = parseMacros(value, config)
|
||||
const diagnostics: Diagnostic[] = []
|
||||
macros.forEach((macro) => {
|
||||
if (macro.startLineNumber === null && macro.endLineNumber !== null) {
|
||||
const endLine = lines[macro.endLineNumber - 1]
|
||||
diagnostics.push({
|
||||
message: `%mend statement is redundant`,
|
||||
lineNumber: macro.endLineNumber,
|
||||
startColumnNumber: getColumnNumber(endLine, '%mend'),
|
||||
endColumnNumber:
|
||||
getColumnNumber(endLine, '%mend') + macro.termination.length,
|
||||
severity: Severity.Warning
|
||||
})
|
||||
} else if (macro.endLineNumber === null && macro.startLineNumber !== null) {
|
||||
diagnostics.push({
|
||||
message: `Missing %mend statement for macro - ${macro.name}`,
|
||||
lineNumber: macro.startLineNumber,
|
||||
startColumnNumber: 1,
|
||||
endColumnNumber: 1,
|
||||
severity: Severity.Warning
|
||||
})
|
||||
} else if (macro.mismatchedMendMacroName) {
|
||||
const endLine = lines[(macro.endLineNumber as number) - 1]
|
||||
diagnostics.push({
|
||||
message: `%mend statement has mismatched macro name, it should be '${
|
||||
macro!.name
|
||||
}'`,
|
||||
lineNumber: macro.endLineNumber as number,
|
||||
startColumnNumber: getColumnNumber(
|
||||
endLine,
|
||||
macro.mismatchedMendMacroName
|
||||
),
|
||||
endColumnNumber:
|
||||
getColumnNumber(endLine, macro.mismatchedMendMacroName) +
|
||||
macro.mismatchedMendMacroName.length -
|
||||
1,
|
||||
severity: Severity.Warning
|
||||
})
|
||||
} else if (!macro.hasMacroNameInMend) {
|
||||
const endLine = lines[(macro.endLineNumber as number) - 1]
|
||||
diagnostics.push({
|
||||
message: `%mend statement is missing macro name - ${macro.name}`,
|
||||
lineNumber: macro.endLineNumber as number,
|
||||
startColumnNumber: getColumnNumber(endLine, '%mend'),
|
||||
endColumnNumber: getColumnNumber(endLine, '%mend') + 6,
|
||||
severity: Severity.Warning
|
||||
})
|
||||
}
|
||||
})
|
||||
|
||||
return diagnostics
|
||||
}
|
||||
|
||||
const fix = (value: string, config?: LintConfig): string => {
|
||||
const lineEnding = config?.lineEndings === LineEndings.CRLF ? '\r\n' : '\n'
|
||||
const lines: string[] = value ? value.split(lineEnding) : []
|
||||
const macros = parseMacros(value, config)
|
||||
|
||||
macros.forEach((macro) => {
|
||||
if (macro.startLineNumber === null && macro.endLineNumber !== null) {
|
||||
// %mend statement is redundant
|
||||
const endLine = lines[macro.endLineNumber - 1]
|
||||
const startColumnNumber = getColumnNumber(endLine, '%mend')
|
||||
const endColumnNumber =
|
||||
getColumnNumber(endLine, '%mend') + macro.termination.length
|
||||
|
||||
const beforeStatement = endLine.slice(0, startColumnNumber - 1)
|
||||
const afterStatement = endLine.slice(endColumnNumber)
|
||||
lines[macro.endLineNumber - 1] = beforeStatement + afterStatement
|
||||
} else if (macro.endLineNumber === null && macro.startLineNumber !== null) {
|
||||
// missing %mend statement
|
||||
} else if (macro.mismatchedMendMacroName) {
|
||||
// mismatched macro name
|
||||
const endLine = lines[(macro.endLineNumber as number) - 1]
|
||||
const startColumnNumber = getColumnNumber(
|
||||
endLine,
|
||||
macro.mismatchedMendMacroName
|
||||
)
|
||||
const endColumnNumber =
|
||||
getColumnNumber(endLine, macro.mismatchedMendMacroName) +
|
||||
macro.mismatchedMendMacroName.length -
|
||||
1
|
||||
|
||||
const beforeMacroName = endLine.slice(0, startColumnNumber - 1)
|
||||
const afterMacroName = endLine.slice(endColumnNumber)
|
||||
|
||||
lines[(macro.endLineNumber as number) - 1] =
|
||||
beforeMacroName + macro.name + afterMacroName
|
||||
} else if (!macro.hasMacroNameInMend) {
|
||||
// %mend statement is missing macro name
|
||||
const endLine = lines[(macro.endLineNumber as number) - 1]
|
||||
const startColumnNumber = getColumnNumber(endLine, '%mend')
|
||||
const endColumnNumber = getColumnNumber(endLine, '%mend') + 4
|
||||
|
||||
const beforeStatement = endLine.slice(0, startColumnNumber - 1)
|
||||
const afterStatement = endLine.slice(endColumnNumber)
|
||||
lines[(macro.endLineNumber as number) - 1] =
|
||||
beforeStatement + `%mend ${macro.name}` + afterStatement
|
||||
}
|
||||
})
|
||||
const formattedText = lines.join(lineEnding)
|
||||
|
||||
return formattedText
|
||||
}
|
||||
|
||||
/**
|
||||
* Lint rule that checks for the presence of macro name in %mend statement.
|
||||
*/
|
||||
export const hasMacroNameInMend: FileLintRule = {
|
||||
type: LintRuleType.File,
|
||||
name,
|
||||
description,
|
||||
message,
|
||||
test,
|
||||
fix
|
||||
}
|
||||
156
src/rules/file/hasMacroParentheses.spec.ts
Normal file
156
src/rules/file/hasMacroParentheses.spec.ts
Normal file
@@ -0,0 +1,156 @@
|
||||
import { Severity } from '../../types/Severity'
|
||||
import { hasMacroParentheses } from './hasMacroParentheses'
|
||||
|
||||
describe('hasMacroParentheses', () => {
|
||||
it('should return an empty array when macro defined correctly', () => {
|
||||
const content = `
|
||||
%macro somemacro();
|
||||
%put &sysmacroname;
|
||||
%mend somemacro;`
|
||||
|
||||
expect(hasMacroParentheses.test(content)).toEqual([])
|
||||
})
|
||||
|
||||
it('should return an array with a single diagnostics when macro defined without parentheses', () => {
|
||||
const content = `
|
||||
%macro somemacro;
|
||||
%put &sysmacroname;
|
||||
%mend somemacro;`
|
||||
expect(hasMacroParentheses.test(content)).toEqual([
|
||||
{
|
||||
message: 'Macro definition missing parentheses',
|
||||
lineNumber: 2,
|
||||
startColumnNumber: 10,
|
||||
endColumnNumber: 18,
|
||||
severity: Severity.Warning
|
||||
}
|
||||
])
|
||||
})
|
||||
|
||||
it('should return an array with a single diagnostic when macro defined without name', () => {
|
||||
const content = `
|
||||
%macro ();
|
||||
%put &sysmacroname;
|
||||
%mend;`
|
||||
|
||||
expect(hasMacroParentheses.test(content)).toEqual([
|
||||
{
|
||||
message: 'Macro definition missing name',
|
||||
lineNumber: 2,
|
||||
startColumnNumber: 3,
|
||||
endColumnNumber: 12,
|
||||
severity: Severity.Warning
|
||||
}
|
||||
])
|
||||
})
|
||||
|
||||
it('should return an array with a single diagnostic when macro defined without name ( single line code )', () => {
|
||||
const content = `
|
||||
%macro (); %put &sysmacroname; %mend;`
|
||||
|
||||
expect(hasMacroParentheses.test(content)).toEqual([
|
||||
{
|
||||
message: 'Macro definition missing name',
|
||||
lineNumber: 2,
|
||||
startColumnNumber: 3,
|
||||
endColumnNumber: 12,
|
||||
severity: Severity.Warning
|
||||
}
|
||||
])
|
||||
})
|
||||
|
||||
it('should return an array with a single diagnostic when macro defined without name and parentheses', () => {
|
||||
const content = `
|
||||
%macro ;
|
||||
%put &sysmacroname;
|
||||
%mend;`
|
||||
|
||||
expect(hasMacroParentheses.test(content)).toEqual([
|
||||
{
|
||||
message: 'Macro definition missing name',
|
||||
lineNumber: 2,
|
||||
startColumnNumber: 3,
|
||||
endColumnNumber: 9,
|
||||
severity: Severity.Warning
|
||||
}
|
||||
])
|
||||
})
|
||||
|
||||
it('should return an empty array when the file is undefined', () => {
|
||||
const content = undefined
|
||||
|
||||
expect(hasMacroParentheses.test((content as unknown) as string)).toEqual([])
|
||||
})
|
||||
|
||||
describe('with extra spaces and comments', () => {
|
||||
it('should return an empty array when %mend has correct macro name', () => {
|
||||
const content = `
|
||||
/* 1st comment */
|
||||
%macro somemacro();
|
||||
|
||||
%put &sysmacroname;
|
||||
|
||||
/* 2nd
|
||||
comment */
|
||||
/* 3rd comment */ %mend somemacro ;`
|
||||
|
||||
expect(hasMacroParentheses.test(content)).toEqual([])
|
||||
})
|
||||
|
||||
it('should return an array with a single diagnostic when macro defined without parentheses having code in comments', () => {
|
||||
const content = `/**
|
||||
@file examplemacro.sas
|
||||
@brief an example of a macro to be used in a service
|
||||
@details This macro is great. Yadda yadda yadda. Usage:
|
||||
|
||||
* code formatting applies when indented by 4 spaces; code formatting applies when indented by 4 spaces; code formatting applies when indented by 4 spaces; code formatting applies when indented by 4 spaces; code formatting applies when indented by 4 spaces;
|
||||
|
||||
some code
|
||||
%macro examplemacro123();
|
||||
|
||||
%examplemacro()
|
||||
|
||||
<h4> SAS Macros </h4>
|
||||
@li doesnothing.sas
|
||||
|
||||
@author Allan Bowe
|
||||
**/
|
||||
|
||||
%macro examplemacro;
|
||||
|
||||
proc sql;
|
||||
create table areas
|
||||
as select area
|
||||
|
||||
from sashelp.springs;
|
||||
|
||||
%doesnothing();
|
||||
|
||||
%mend;`
|
||||
|
||||
expect(hasMacroParentheses.test(content)).toEqual([
|
||||
{
|
||||
message: 'Macro definition missing parentheses',
|
||||
lineNumber: 19,
|
||||
startColumnNumber: 12,
|
||||
endColumnNumber: 23,
|
||||
severity: Severity.Warning
|
||||
}
|
||||
])
|
||||
})
|
||||
})
|
||||
|
||||
it('should return an array with a single diagnostic when a macro definition contains a space', () => {
|
||||
const content = `%macro test ()`
|
||||
|
||||
expect(hasMacroParentheses.test(content)).toEqual([
|
||||
{
|
||||
message: 'Macro definition contains space(s)',
|
||||
lineNumber: 1,
|
||||
startColumnNumber: 8,
|
||||
endColumnNumber: 14,
|
||||
severity: Severity.Warning
|
||||
}
|
||||
])
|
||||
})
|
||||
})
|
||||
64
src/rules/file/hasMacroParentheses.ts
Normal file
64
src/rules/file/hasMacroParentheses.ts
Normal file
@@ -0,0 +1,64 @@
|
||||
import { Diagnostic } from '../../types/Diagnostic'
|
||||
import { FileLintRule } from '../../types/LintRule'
|
||||
import { LintRuleType } from '../../types/LintRuleType'
|
||||
import { Severity } from '../../types/Severity'
|
||||
import { getColumnNumber } from '../../utils/getColumnNumber'
|
||||
import { parseMacros } from '../../utils/parseMacros'
|
||||
import { LintConfig } from '../../types'
|
||||
|
||||
const name = 'hasMacroParentheses'
|
||||
const description = 'Enforces the presence of parentheses in macro definitions.'
|
||||
const message = 'Macro definition missing parentheses'
|
||||
const test = (value: string, config?: LintConfig) => {
|
||||
const diagnostics: Diagnostic[] = []
|
||||
const macros = parseMacros(value, config)
|
||||
macros.forEach((macro) => {
|
||||
if (!macro.name) {
|
||||
diagnostics.push({
|
||||
message: 'Macro definition missing name',
|
||||
lineNumber: macro.startLineNumber!,
|
||||
startColumnNumber: getColumnNumber(macro.declarationLine, '%macro'),
|
||||
endColumnNumber:
|
||||
getColumnNumber(macro.declarationLine, '%macro') +
|
||||
macro.declaration.length,
|
||||
severity: Severity.Warning
|
||||
})
|
||||
} else if (!macro.declarationLine.includes('(')) {
|
||||
diagnostics.push({
|
||||
message,
|
||||
lineNumber: macro.startLineNumber!,
|
||||
startColumnNumber: getColumnNumber(macro.declarationLine, macro.name),
|
||||
endColumnNumber:
|
||||
getColumnNumber(macro.declarationLine, macro.name) +
|
||||
macro.name.length -
|
||||
1,
|
||||
severity: Severity.Warning
|
||||
})
|
||||
} else if (macro.name !== macro.name.trim()) {
|
||||
diagnostics.push({
|
||||
message: 'Macro definition contains space(s)',
|
||||
lineNumber: macro.startLineNumber!,
|
||||
startColumnNumber: getColumnNumber(macro.declarationLine, macro.name),
|
||||
endColumnNumber:
|
||||
getColumnNumber(macro.declarationLine, macro.name) +
|
||||
macro.name.length -
|
||||
1 +
|
||||
`()`.length,
|
||||
severity: Severity.Warning
|
||||
})
|
||||
}
|
||||
})
|
||||
|
||||
return diagnostics
|
||||
}
|
||||
|
||||
/**
|
||||
* Lint rule that enforces the presence of parentheses in macro definitions..
|
||||
*/
|
||||
export const hasMacroParentheses: FileLintRule = {
|
||||
type: LintRuleType.File,
|
||||
name,
|
||||
description,
|
||||
message,
|
||||
test
|
||||
}
|
||||
5
src/rules/file/index.ts
Normal file
5
src/rules/file/index.ts
Normal file
@@ -0,0 +1,5 @@
|
||||
export { hasDoxygenHeader } from './hasDoxygenHeader'
|
||||
export { hasMacroNameInMend } from './hasMacroNameInMend'
|
||||
export { hasMacroParentheses } from './hasMacroParentheses'
|
||||
export { lineEndings } from './lineEndings'
|
||||
export { noNestedMacros } from './noNestedMacros'
|
||||
141
src/rules/file/lineEndings.spec.ts
Normal file
141
src/rules/file/lineEndings.spec.ts
Normal file
@@ -0,0 +1,141 @@
|
||||
import { LintConfig, Severity } from '../../types'
|
||||
import { LineEndings } from '../../types/LineEndings'
|
||||
import { lineEndings } from './lineEndings'
|
||||
|
||||
describe('lineEndings - test', () => {
|
||||
it('should return an empty array when the text contains the configured line endings', () => {
|
||||
const text = "%put 'hello';\n%put 'world';\n"
|
||||
const config = new LintConfig({ lineEndings: LineEndings.LF })
|
||||
expect(lineEndings.test(text, config)).toEqual([])
|
||||
})
|
||||
|
||||
it('should return an array with a single diagnostic when a line is terminated with a CRLF ending', () => {
|
||||
const text = "%put 'hello';\n%put 'world';\r\n"
|
||||
const config = new LintConfig({ lineEndings: LineEndings.LF })
|
||||
expect(lineEndings.test(text, config)).toEqual([
|
||||
{
|
||||
message: 'Incorrect line ending - CRLF instead of LF',
|
||||
lineNumber: 2,
|
||||
startColumnNumber: 13,
|
||||
endColumnNumber: 14,
|
||||
severity: Severity.Warning
|
||||
}
|
||||
])
|
||||
})
|
||||
|
||||
it('should return an array with a single diagnostic when a line is terminated with an LF ending', () => {
|
||||
const text = "%put 'hello';\n%put 'world';\r\n"
|
||||
const config = new LintConfig({ lineEndings: LineEndings.CRLF })
|
||||
expect(lineEndings.test(text, config)).toEqual([
|
||||
{
|
||||
message: 'Incorrect line ending - LF instead of CRLF',
|
||||
lineNumber: 1,
|
||||
startColumnNumber: 13,
|
||||
endColumnNumber: 14,
|
||||
severity: Severity.Warning
|
||||
}
|
||||
])
|
||||
})
|
||||
|
||||
it('should return an array with a diagnostic for each line terminated with an LF ending', () => {
|
||||
const text = "%put 'hello';\n%put 'test';\r\n%put 'world';\n"
|
||||
const config = new LintConfig({ lineEndings: LineEndings.CRLF })
|
||||
expect(lineEndings.test(text, config)).toContainEqual({
|
||||
message: 'Incorrect line ending - LF instead of CRLF',
|
||||
lineNumber: 1,
|
||||
startColumnNumber: 13,
|
||||
endColumnNumber: 14,
|
||||
severity: Severity.Warning
|
||||
})
|
||||
expect(lineEndings.test(text, config)).toContainEqual({
|
||||
message: 'Incorrect line ending - LF instead of CRLF',
|
||||
lineNumber: 3,
|
||||
startColumnNumber: 13,
|
||||
endColumnNumber: 14,
|
||||
severity: Severity.Warning
|
||||
})
|
||||
})
|
||||
|
||||
it('should return an array with a diagnostic for each line terminated with a CRLF ending', () => {
|
||||
const text = "%put 'hello';\r\n%put 'test';\n%put 'world';\r\n"
|
||||
const config = new LintConfig({ lineEndings: LineEndings.LF })
|
||||
expect(lineEndings.test(text, config)).toContainEqual({
|
||||
message: 'Incorrect line ending - CRLF instead of LF',
|
||||
lineNumber: 1,
|
||||
startColumnNumber: 13,
|
||||
endColumnNumber: 14,
|
||||
severity: Severity.Warning
|
||||
})
|
||||
expect(lineEndings.test(text, config)).toContainEqual({
|
||||
message: 'Incorrect line ending - CRLF instead of LF',
|
||||
lineNumber: 3,
|
||||
startColumnNumber: 13,
|
||||
endColumnNumber: 14,
|
||||
severity: Severity.Warning
|
||||
})
|
||||
})
|
||||
|
||||
it('should return an array with a diagnostic for lines terminated with a CRLF ending', () => {
|
||||
const text =
|
||||
"%put 'hello';\r\n%put 'test';\r\n%put 'world';\n%put 'test2';\n%put 'world2';\r\n"
|
||||
const config = new LintConfig({ lineEndings: LineEndings.LF })
|
||||
expect(lineEndings.test(text, config)).toContainEqual({
|
||||
message: 'Incorrect line ending - CRLF instead of LF',
|
||||
lineNumber: 1,
|
||||
startColumnNumber: 13,
|
||||
endColumnNumber: 14,
|
||||
severity: Severity.Warning
|
||||
})
|
||||
expect(lineEndings.test(text, config)).toContainEqual({
|
||||
message: 'Incorrect line ending - CRLF instead of LF',
|
||||
lineNumber: 2,
|
||||
startColumnNumber: 12,
|
||||
endColumnNumber: 13,
|
||||
severity: Severity.Warning
|
||||
})
|
||||
expect(lineEndings.test(text, config)).toContainEqual({
|
||||
message: 'Incorrect line ending - CRLF instead of LF',
|
||||
lineNumber: 5,
|
||||
startColumnNumber: 14,
|
||||
endColumnNumber: 15,
|
||||
severity: Severity.Warning
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
describe('lineEndings - fix', () => {
|
||||
it('should transform line endings to LF', () => {
|
||||
const text =
|
||||
"%put 'hello';\r\n%put 'test';\r\n%put 'world';\n%put 'test2';\n%put 'world2';\r\n"
|
||||
const config = new LintConfig({ lineEndings: LineEndings.LF })
|
||||
|
||||
const formattedText = lineEndings.fix!(text, config)
|
||||
|
||||
expect(formattedText).toEqual(
|
||||
"%put 'hello';\n%put 'test';\n%put 'world';\n%put 'test2';\n%put 'world2';\n"
|
||||
)
|
||||
})
|
||||
|
||||
it('should transform line endings to CRLF', () => {
|
||||
const text =
|
||||
"%put 'hello';\r\n%put 'test';\r\n%put 'world';\n%put 'test2';\n%put 'world2';\r\n"
|
||||
const config = new LintConfig({ lineEndings: LineEndings.CRLF })
|
||||
|
||||
const formattedText = lineEndings.fix!(text, config)
|
||||
|
||||
expect(formattedText).toEqual(
|
||||
"%put 'hello';\r\n%put 'test';\r\n%put 'world';\r\n%put 'test2';\r\n%put 'world2';\r\n"
|
||||
)
|
||||
})
|
||||
|
||||
it('should use LF line endings by default', () => {
|
||||
const text =
|
||||
"%put 'hello';\r\n%put 'test';\r\n%put 'world';\n%put 'test2';\n%put 'world2';\r\n"
|
||||
|
||||
const formattedText = lineEndings.fix!(text)
|
||||
|
||||
expect(formattedText).toEqual(
|
||||
"%put 'hello';\n%put 'test';\n%put 'world';\n%put 'test2';\n%put 'world2';\n"
|
||||
)
|
||||
})
|
||||
})
|
||||
83
src/rules/file/lineEndings.ts
Normal file
83
src/rules/file/lineEndings.ts
Normal file
@@ -0,0 +1,83 @@
|
||||
import { Diagnostic, LintConfig } from '../../types'
|
||||
import { LineEndings } from '../../types/LineEndings'
|
||||
import { FileLintRule } from '../../types/LintRule'
|
||||
import { LintRuleType } from '../../types/LintRuleType'
|
||||
import { Severity } from '../../types/Severity'
|
||||
|
||||
const name = 'lineEndings'
|
||||
const description = 'Ensures line endings conform to the configured type.'
|
||||
const message = 'Incorrect line ending - {actual} instead of {expected}'
|
||||
const test = (value: string, config?: LintConfig) => {
|
||||
const lineEndingConfig = config?.lineEndings || LineEndings.LF
|
||||
const expectedLineEnding =
|
||||
lineEndingConfig === LineEndings.LF ? '{lf}' : '{crlf}'
|
||||
const incorrectLineEnding = expectedLineEnding === '{lf}' ? '{crlf}' : '{lf}'
|
||||
|
||||
const lines = value
|
||||
.replace(/\r\n/g, '{crlf}')
|
||||
.replace(/\n/g, '{lf}')
|
||||
.split(new RegExp(`(?<=${expectedLineEnding})`))
|
||||
const diagnostics: Diagnostic[] = []
|
||||
|
||||
let indexOffset = 0
|
||||
lines.forEach((line, index) => {
|
||||
if (line.endsWith(incorrectLineEnding)) {
|
||||
diagnostics.push({
|
||||
message: message
|
||||
.replace('{expected}', expectedLineEnding === '{lf}' ? 'LF' : 'CRLF')
|
||||
.replace('{actual}', incorrectLineEnding === '{lf}' ? 'LF' : 'CRLF'),
|
||||
lineNumber: index + 1 + indexOffset,
|
||||
startColumnNumber: line.indexOf(incorrectLineEnding),
|
||||
endColumnNumber: line.indexOf(incorrectLineEnding) + 1,
|
||||
severity: Severity.Warning
|
||||
})
|
||||
} else {
|
||||
const splitLine = line.split(new RegExp(`(?<=${incorrectLineEnding})`))
|
||||
if (splitLine.length > 1) {
|
||||
indexOffset += splitLine.length - 1
|
||||
}
|
||||
splitLine.forEach((l, i) => {
|
||||
if (l.endsWith(incorrectLineEnding)) {
|
||||
diagnostics.push({
|
||||
message: message
|
||||
.replace(
|
||||
'{expected}',
|
||||
expectedLineEnding === '{lf}' ? 'LF' : 'CRLF'
|
||||
)
|
||||
.replace(
|
||||
'{actual}',
|
||||
incorrectLineEnding === '{lf}' ? 'LF' : 'CRLF'
|
||||
),
|
||||
lineNumber: index + i + 1,
|
||||
startColumnNumber: l.indexOf(incorrectLineEnding),
|
||||
endColumnNumber: l.indexOf(incorrectLineEnding) + 1,
|
||||
severity: Severity.Warning
|
||||
})
|
||||
}
|
||||
})
|
||||
}
|
||||
})
|
||||
return diagnostics
|
||||
}
|
||||
|
||||
const fix = (value: string, config?: LintConfig): string => {
|
||||
const lineEndingConfig = config?.lineEndings || LineEndings.LF
|
||||
|
||||
return value
|
||||
.replace(/\r\n/g, '{crlf}')
|
||||
.replace(/\n/g, '{lf}')
|
||||
.replace(/{crlf}/g, lineEndingConfig === LineEndings.LF ? '\n' : '\r\n')
|
||||
.replace(/{lf}/g, lineEndingConfig === LineEndings.LF ? '\n' : '\r\n')
|
||||
}
|
||||
|
||||
/**
|
||||
* Lint rule that checks if line endings in a file match the configured type.
|
||||
*/
|
||||
export const lineEndings: FileLintRule = {
|
||||
type: LintRuleType.File,
|
||||
name,
|
||||
description,
|
||||
message,
|
||||
test,
|
||||
fix
|
||||
}
|
||||
96
src/rules/file/noNestedMacros.spec.ts
Normal file
96
src/rules/file/noNestedMacros.spec.ts
Normal file
@@ -0,0 +1,96 @@
|
||||
import { LintConfig } from '../../types'
|
||||
import { Severity } from '../../types/Severity'
|
||||
import { noNestedMacros } from './noNestedMacros'
|
||||
|
||||
describe('noNestedMacros', () => {
|
||||
it('should return an empty array when no nested macro', () => {
|
||||
const content = `
|
||||
%macro somemacro();
|
||||
%put &sysmacroname;
|
||||
%mend somemacro;`
|
||||
|
||||
expect(noNestedMacros.test(content)).toEqual([])
|
||||
})
|
||||
|
||||
it('should return an array with a single diagnostic when a macro contains a nested macro definition', () => {
|
||||
const content = `
|
||||
%macro outer();
|
||||
/* any amount of arbitrary code */
|
||||
%macro inner();
|
||||
%put inner;
|
||||
%mend;
|
||||
%inner()
|
||||
%put outer;
|
||||
%mend;
|
||||
|
||||
%outer()`
|
||||
|
||||
expect(noNestedMacros.test(content)).toEqual([
|
||||
{
|
||||
message: "Macro definition for 'inner' present in macro 'outer'",
|
||||
lineNumber: 4,
|
||||
startColumnNumber: 7,
|
||||
endColumnNumber: 21,
|
||||
severity: Severity.Warning
|
||||
}
|
||||
])
|
||||
})
|
||||
|
||||
it('should return an array with two diagnostics when nested macros are defined at 2 levels', () => {
|
||||
const content = `
|
||||
%macro outer();
|
||||
/* any amount of arbitrary code */
|
||||
%macro inner();
|
||||
%put inner;
|
||||
|
||||
%macro inner2();
|
||||
%put inner2;
|
||||
%mend;
|
||||
%mend;
|
||||
%inner()
|
||||
%put outer;
|
||||
%mend;
|
||||
|
||||
%outer()`
|
||||
|
||||
expect(noNestedMacros.test(content)).toContainEqual({
|
||||
message: "Macro definition for 'inner' present in macro 'outer'",
|
||||
lineNumber: 4,
|
||||
startColumnNumber: 7,
|
||||
endColumnNumber: 21,
|
||||
severity: Severity.Warning
|
||||
})
|
||||
expect(noNestedMacros.test(content)).toContainEqual({
|
||||
message: "Macro definition for 'inner2' present in macro 'inner'",
|
||||
lineNumber: 7,
|
||||
startColumnNumber: 17,
|
||||
endColumnNumber: 32,
|
||||
severity: Severity.Warning
|
||||
})
|
||||
})
|
||||
|
||||
it('should return an empty array when the file is undefined', () => {
|
||||
const content = undefined
|
||||
|
||||
expect(noNestedMacros.test((content as unknown) as string)).toEqual([])
|
||||
})
|
||||
|
||||
it('should use the configured line ending while testing content', () => {
|
||||
const content = `%macro outer();\r\n%macro inner;\r\n%mend inner;\r\n%mend outer;`
|
||||
|
||||
const diagnostics = noNestedMacros.test(
|
||||
content,
|
||||
new LintConfig({ lineEndings: 'crlf' })
|
||||
)
|
||||
|
||||
expect(diagnostics).toEqual([
|
||||
{
|
||||
message: "Macro definition for 'inner' present in macro 'outer'",
|
||||
lineNumber: 2,
|
||||
startColumnNumber: 1,
|
||||
endColumnNumber: 13,
|
||||
severity: Severity.Warning
|
||||
}
|
||||
])
|
||||
})
|
||||
})
|
||||
52
src/rules/file/noNestedMacros.ts
Normal file
52
src/rules/file/noNestedMacros.ts
Normal file
@@ -0,0 +1,52 @@
|
||||
import { Diagnostic } from '../../types/Diagnostic'
|
||||
import { FileLintRule } from '../../types/LintRule'
|
||||
import { LintRuleType } from '../../types/LintRuleType'
|
||||
import { Severity } from '../../types/Severity'
|
||||
import { getColumnNumber } from '../../utils/getColumnNumber'
|
||||
import { parseMacros } from '../../utils/parseMacros'
|
||||
import { LintConfig } from '../../types'
|
||||
import { LineEndings } from '../../types/LineEndings'
|
||||
|
||||
const name = 'noNestedMacros'
|
||||
const description = 'Enfoces the absence of nested macro definitions.'
|
||||
const message = `Macro definition for '{macro}' present in macro '{parent}'`
|
||||
const test = (value: string, config?: LintConfig) => {
|
||||
const lineEnding = config?.lineEndings === LineEndings.CRLF ? '\r\n' : '\n'
|
||||
const lines: string[] = value ? value.split(lineEnding) : []
|
||||
const diagnostics: Diagnostic[] = []
|
||||
const macros = parseMacros(value, config)
|
||||
macros
|
||||
.filter((m) => !!m.parentMacro)
|
||||
.forEach((macro) => {
|
||||
diagnostics.push({
|
||||
message: message
|
||||
.replace('{macro}', macro.name)
|
||||
.replace('{parent}', macro.parentMacro),
|
||||
lineNumber: macro.startLineNumber as number,
|
||||
startColumnNumber: getColumnNumber(
|
||||
lines[(macro.startLineNumber as number) - 1],
|
||||
'%macro'
|
||||
),
|
||||
endColumnNumber:
|
||||
getColumnNumber(
|
||||
lines[(macro.startLineNumber as number) - 1],
|
||||
'%macro'
|
||||
) +
|
||||
lines[(macro.startLineNumber as number) - 1].trim().length -
|
||||
1,
|
||||
severity: Severity.Warning
|
||||
})
|
||||
})
|
||||
return diagnostics
|
||||
}
|
||||
|
||||
/**
|
||||
* Lint rule that checks for the absence of nested macro definitions.
|
||||
*/
|
||||
export const noNestedMacros: FileLintRule = {
|
||||
type: LintRuleType.File,
|
||||
name,
|
||||
description,
|
||||
message,
|
||||
test
|
||||
}
|
||||
@@ -1,4 +1,4 @@
|
||||
import { LintConfig, Severity } from '../types'
|
||||
import { LintConfig, Severity } from '../../types'
|
||||
import { indentationMultiple } from './indentationMultiple'
|
||||
|
||||
describe('indentationMultiple', () => {
|
||||
@@ -1,7 +1,7 @@
|
||||
import { LintConfig } from '../types'
|
||||
import { LineLintRule } from '../types/LintRule'
|
||||
import { LintRuleType } from '../types/LintRuleType'
|
||||
import { Severity } from '../types/Severity'
|
||||
import { LintConfig } from '../../types'
|
||||
import { LineLintRule } from '../../types/LintRule'
|
||||
import { LintRuleType } from '../../types/LintRuleType'
|
||||
import { Severity } from '../../types/Severity'
|
||||
|
||||
const name = 'indentationMultiple'
|
||||
const description = 'Ensure indentation by a multiple of the configured number.'
|
||||
5
src/rules/line/index.ts
Normal file
5
src/rules/line/index.ts
Normal file
@@ -0,0 +1,5 @@
|
||||
export { indentationMultiple } from './indentationMultiple'
|
||||
export { maxLineLength } from './maxLineLength'
|
||||
export { noEncodedPasswords } from './noEncodedPasswords'
|
||||
export { noTabIndentation } from './noTabIndentation'
|
||||
export { noTrailingSpaces } from './noTrailingSpaces'
|
||||
@@ -1,4 +1,4 @@
|
||||
import { LintConfig, Severity } from '../types'
|
||||
import { LintConfig, Severity } from '../../types'
|
||||
import { maxLineLength } from './maxLineLength'
|
||||
|
||||
describe('maxLineLength', () => {
|
||||
@@ -1,7 +1,7 @@
|
||||
import { LintConfig } from '../types'
|
||||
import { LineLintRule } from '../types/LintRule'
|
||||
import { LintRuleType } from '../types/LintRuleType'
|
||||
import { Severity } from '../types/Severity'
|
||||
import { LintConfig } from '../../types'
|
||||
import { LineLintRule } from '../../types/LintRule'
|
||||
import { LintRuleType } from '../../types/LintRuleType'
|
||||
import { Severity } from '../../types/Severity'
|
||||
|
||||
const name = 'maxLineLength'
|
||||
const description = 'Restrict lines to the specified length.'
|
||||
@@ -1,4 +1,4 @@
|
||||
import { Severity } from '../types/Severity'
|
||||
import { Severity } from '../../types/Severity'
|
||||
import { noEncodedPasswords } from './noEncodedPasswords'
|
||||
|
||||
describe('noEncodedPasswords', () => {
|
||||
@@ -1,6 +1,6 @@
|
||||
import { LineLintRule } from '../types/LintRule'
|
||||
import { LintRuleType } from '../types/LintRuleType'
|
||||
import { Severity } from '../types/Severity'
|
||||
import { LineLintRule } from '../../types/LintRule'
|
||||
import { LintRuleType } from '../../types/LintRuleType'
|
||||
import { Severity } from '../../types/Severity'
|
||||
|
||||
const name = 'noEncodedPasswords'
|
||||
const description = 'Disallow encoded passwords in SAS code.'
|
||||
@@ -1,4 +1,4 @@
|
||||
import { Severity } from '../types/Severity'
|
||||
import { Severity } from '../../types/Severity'
|
||||
import { noTabIndentation } from './noTabIndentation'
|
||||
|
||||
describe('noTabs', () => {
|
||||
@@ -1,6 +1,6 @@
|
||||
import { LineLintRule } from '../types/LintRule'
|
||||
import { LintRuleType } from '../types/LintRuleType'
|
||||
import { Severity } from '../types/Severity'
|
||||
import { LineLintRule } from '../../types/LintRule'
|
||||
import { LintRuleType } from '../../types/LintRuleType'
|
||||
import { Severity } from '../../types/Severity'
|
||||
|
||||
const name = 'noTabs'
|
||||
const description = 'Disallow indenting with tabs.'
|
||||
@@ -1,4 +1,4 @@
|
||||
import { Severity } from '../types/Severity'
|
||||
import { Severity } from '../../types/Severity'
|
||||
import { noTrailingSpaces } from './noTrailingSpaces'
|
||||
|
||||
describe('noTrailingSpaces', () => {
|
||||
@@ -1,6 +1,6 @@
|
||||
import { LineLintRule } from '../types/LintRule'
|
||||
import { LintRuleType } from '../types/LintRuleType'
|
||||
import { Severity } from '../types/Severity'
|
||||
import { LineLintRule } from '../../types/LintRule'
|
||||
import { LintRuleType } from '../../types/LintRuleType'
|
||||
import { Severity } from '../../types/Severity'
|
||||
|
||||
const name = 'noTrailingSpaces'
|
||||
const description = 'Disallow trailing spaces on lines.'
|
||||
@@ -17,6 +17,7 @@ const test = (value: string, lineNumber: number) =>
|
||||
severity: Severity.Warning
|
||||
}
|
||||
]
|
||||
const fix = (value: string) => value.trimEnd()
|
||||
|
||||
/**
|
||||
* Lint rule that checks for the presence of trailing space(s) in a given line of text.
|
||||
@@ -26,5 +27,6 @@ export const noTrailingSpaces: LineLintRule = {
|
||||
name,
|
||||
description,
|
||||
message,
|
||||
test
|
||||
test,
|
||||
fix
|
||||
}
|
||||
2
src/rules/path/index.ts
Normal file
2
src/rules/path/index.ts
Normal file
@@ -0,0 +1,2 @@
|
||||
export { lowerCaseFileNames } from './lowerCaseFileNames'
|
||||
export { noSpacesInFileNames } from './noSpacesInFileNames'
|
||||
@@ -1,4 +1,4 @@
|
||||
import { Severity } from '../types/Severity'
|
||||
import { Severity } from '../../types/Severity'
|
||||
import { lowerCaseFileNames } from './lowerCaseFileNames'
|
||||
|
||||
describe('lowerCaseFileNames', () => {
|
||||
@@ -1,6 +1,6 @@
|
||||
import { PathLintRule } from '../types/LintRule'
|
||||
import { LintRuleType } from '../types/LintRuleType'
|
||||
import { Severity } from '../types/Severity'
|
||||
import { PathLintRule } from '../../types/LintRule'
|
||||
import { LintRuleType } from '../../types/LintRuleType'
|
||||
import { Severity } from '../../types/Severity'
|
||||
import path from 'path'
|
||||
|
||||
const name = 'lowerCaseFileNames'
|
||||
@@ -1,4 +1,4 @@
|
||||
import { Severity } from '../types/Severity'
|
||||
import { Severity } from '../../types/Severity'
|
||||
import { noSpacesInFileNames } from './noSpacesInFileNames'
|
||||
|
||||
describe('noSpacesInFileNames', () => {
|
||||
@@ -1,6 +1,6 @@
|
||||
import { PathLintRule } from '../types/LintRule'
|
||||
import { LintRuleType } from '../types/LintRuleType'
|
||||
import { Severity } from '../types/Severity'
|
||||
import { PathLintRule } from '../../types/LintRule'
|
||||
import { LintRuleType } from '../../types/LintRuleType'
|
||||
import { Severity } from '../../types/Severity'
|
||||
import path from 'path'
|
||||
|
||||
const name = 'noSpacesInFileNames'
|
||||
10
src/types/FormatResult.ts
Normal file
10
src/types/FormatResult.ts
Normal file
@@ -0,0 +1,10 @@
|
||||
import { Diagnostic } from './Diagnostic'
|
||||
|
||||
/**
|
||||
* Represents the result of a format operation on a file, folder or project.
|
||||
*/
|
||||
export interface FormatResult {
|
||||
updatedFilePaths: string[]
|
||||
fixedDiagnosticsCount: number
|
||||
unfixedDiagnostics: Map<string, Diagnostic[]> | Diagnostic[]
|
||||
}
|
||||
4
src/types/LineEndings.ts
Normal file
4
src/types/LineEndings.ts
Normal file
@@ -0,0 +1,4 @@
|
||||
export enum LineEndings {
|
||||
LF = 'lf',
|
||||
CRLF = 'crlf'
|
||||
}
|
||||
@@ -1,3 +1,4 @@
|
||||
import { LineEndings } from './LineEndings'
|
||||
import { LintConfig } from './LintConfig'
|
||||
import { LintRuleType } from './LintRuleType'
|
||||
|
||||
@@ -40,6 +41,60 @@ describe('LintConfig', () => {
|
||||
expect(config.fileLintRules[0].type).toEqual(LintRuleType.File)
|
||||
})
|
||||
|
||||
it('should create an instance with the hasMacroNameInMend flag set', () => {
|
||||
const config = new LintConfig({ hasMacroNameInMend: true })
|
||||
|
||||
expect(config).toBeTruthy()
|
||||
expect(config.lineLintRules.length).toEqual(0)
|
||||
expect(config.fileLintRules.length).toEqual(1)
|
||||
expect(config.fileLintRules[0].name).toEqual('hasMacroNameInMend')
|
||||
expect(config.fileLintRules[0].type).toEqual(LintRuleType.File)
|
||||
})
|
||||
|
||||
it('should create an instance with the hasMacroNameInMend flag off', () => {
|
||||
const config = new LintConfig({ hasMacroNameInMend: false })
|
||||
|
||||
expect(config).toBeTruthy()
|
||||
expect(config.lineLintRules.length).toEqual(0)
|
||||
expect(config.fileLintRules.length).toEqual(0)
|
||||
})
|
||||
|
||||
it('should create an instance with the noNestedMacros flag set', () => {
|
||||
const config = new LintConfig({ noNestedMacros: true })
|
||||
|
||||
expect(config).toBeTruthy()
|
||||
expect(config.lineLintRules.length).toEqual(0)
|
||||
expect(config.fileLintRules.length).toEqual(1)
|
||||
expect(config.fileLintRules[0].name).toEqual('noNestedMacros')
|
||||
expect(config.fileLintRules[0].type).toEqual(LintRuleType.File)
|
||||
})
|
||||
|
||||
it('should create an instance with the noNestedMacros flag off', () => {
|
||||
const config = new LintConfig({ noNestedMacros: false })
|
||||
|
||||
expect(config).toBeTruthy()
|
||||
expect(config.lineLintRules.length).toEqual(0)
|
||||
expect(config.fileLintRules.length).toEqual(0)
|
||||
})
|
||||
|
||||
it('should create an instance with the hasMacroParentheses flag set', () => {
|
||||
const config = new LintConfig({ hasMacroParentheses: true })
|
||||
|
||||
expect(config).toBeTruthy()
|
||||
expect(config.lineLintRules.length).toEqual(0)
|
||||
expect(config.fileLintRules.length).toEqual(1)
|
||||
expect(config.fileLintRules[0].name).toEqual('hasMacroParentheses')
|
||||
expect(config.fileLintRules[0].type).toEqual(LintRuleType.File)
|
||||
})
|
||||
|
||||
it('should create an instance with the hasMacroParentheses flag off', () => {
|
||||
const config = new LintConfig({ hasMacroParentheses: false })
|
||||
|
||||
expect(config).toBeTruthy()
|
||||
expect(config.lineLintRules.length).toEqual(0)
|
||||
expect(config.fileLintRules.length).toEqual(0)
|
||||
})
|
||||
|
||||
it('should create an instance with the indentation multiple set', () => {
|
||||
const config = new LintConfig({ indentationMultiple: 5 })
|
||||
|
||||
@@ -54,22 +109,75 @@ describe('LintConfig', () => {
|
||||
expect(config.indentationMultiple).toEqual(0)
|
||||
})
|
||||
|
||||
it('should create an instance with the line endings set to LF', () => {
|
||||
const config = new LintConfig({ lineEndings: 'lf' })
|
||||
|
||||
expect(config).toBeTruthy()
|
||||
expect(config.lineEndings).toEqual(LineEndings.LF)
|
||||
})
|
||||
|
||||
it('should create an instance with the line endings set to CRLF', () => {
|
||||
const config = new LintConfig({ lineEndings: 'crlf' })
|
||||
|
||||
expect(config).toBeTruthy()
|
||||
expect(config.lineEndings).toEqual(LineEndings.CRLF)
|
||||
})
|
||||
|
||||
it('should create an instance with the line endings set to LF by default', () => {
|
||||
const config = new LintConfig({})
|
||||
|
||||
expect(config).toBeTruthy()
|
||||
expect(config.lineEndings).toEqual(LineEndings.LF)
|
||||
})
|
||||
|
||||
it('should throw an error with an invalid value for line endings', () => {
|
||||
expect(() => new LintConfig({ lineEndings: 'test' })).toThrowError(
|
||||
`Invalid value for lineEndings: can be ${LineEndings.LF} or ${LineEndings.CRLF}`
|
||||
)
|
||||
})
|
||||
|
||||
it('should create an instance with all flags set', () => {
|
||||
const config = new LintConfig({
|
||||
noTrailingSpaces: true,
|
||||
noEncodedPasswords: true,
|
||||
hasDoxygenHeader: true
|
||||
hasDoxygenHeader: true,
|
||||
noSpacesInFileNames: true,
|
||||
lowerCaseFileNames: true,
|
||||
maxLineLength: 80,
|
||||
noTabIndentation: true,
|
||||
indentationMultiple: 2,
|
||||
hasMacroNameInMend: true,
|
||||
noNestedMacros: true,
|
||||
hasMacroParentheses: true
|
||||
})
|
||||
|
||||
expect(config).toBeTruthy()
|
||||
expect(config.lineLintRules.length).toEqual(2)
|
||||
expect(config.lineLintRules.length).toEqual(5)
|
||||
expect(config.lineLintRules[0].name).toEqual('noTrailingSpaces')
|
||||
expect(config.lineLintRules[0].type).toEqual(LintRuleType.Line)
|
||||
expect(config.lineLintRules[1].name).toEqual('noEncodedPasswords')
|
||||
expect(config.lineLintRules[1].type).toEqual(LintRuleType.Line)
|
||||
expect(config.lineLintRules[2].name).toEqual('noTabs')
|
||||
expect(config.lineLintRules[2].type).toEqual(LintRuleType.Line)
|
||||
expect(config.lineLintRules[3].name).toEqual('maxLineLength')
|
||||
expect(config.lineLintRules[3].type).toEqual(LintRuleType.Line)
|
||||
expect(config.lineLintRules[4].name).toEqual('indentationMultiple')
|
||||
expect(config.lineLintRules[4].type).toEqual(LintRuleType.Line)
|
||||
|
||||
expect(config.fileLintRules.length).toEqual(1)
|
||||
expect(config.fileLintRules.length).toEqual(4)
|
||||
expect(config.fileLintRules[0].name).toEqual('hasDoxygenHeader')
|
||||
expect(config.fileLintRules[0].type).toEqual(LintRuleType.File)
|
||||
expect(config.fileLintRules[1].name).toEqual('hasMacroNameInMend')
|
||||
expect(config.fileLintRules[1].type).toEqual(LintRuleType.File)
|
||||
expect(config.fileLintRules[2].name).toEqual('noNestedMacros')
|
||||
expect(config.fileLintRules[2].type).toEqual(LintRuleType.File)
|
||||
expect(config.fileLintRules[3].name).toEqual('hasMacroParentheses')
|
||||
expect(config.fileLintRules[3].type).toEqual(LintRuleType.File)
|
||||
|
||||
expect(config.pathLintRules.length).toEqual(2)
|
||||
expect(config.pathLintRules[0].name).toEqual('noSpacesInFileNames')
|
||||
expect(config.pathLintRules[0].type).toEqual(LintRuleType.Path)
|
||||
expect(config.pathLintRules[1].name).toEqual('lowerCaseFileNames')
|
||||
expect(config.pathLintRules[1].type).toEqual(LintRuleType.Path)
|
||||
})
|
||||
})
|
||||
|
||||
@@ -1,11 +1,19 @@
|
||||
import { hasDoxygenHeader } from '../rules/hasDoxygenHeader'
|
||||
import { indentationMultiple } from '../rules/indentationMultiple'
|
||||
import { lowerCaseFileNames } from '../rules/lowerCaseFileNames'
|
||||
import { maxLineLength } from '../rules/maxLineLength'
|
||||
import { noEncodedPasswords } from '../rules/noEncodedPasswords'
|
||||
import { noSpacesInFileNames } from '../rules/noSpacesInFileNames'
|
||||
import { noTabIndentation } from '../rules/noTabIndentation'
|
||||
import { noTrailingSpaces } from '../rules/noTrailingSpaces'
|
||||
import {
|
||||
hasDoxygenHeader,
|
||||
hasMacroNameInMend,
|
||||
noNestedMacros,
|
||||
hasMacroParentheses,
|
||||
lineEndings
|
||||
} from '../rules/file'
|
||||
import {
|
||||
indentationMultiple,
|
||||
maxLineLength,
|
||||
noEncodedPasswords,
|
||||
noTabIndentation,
|
||||
noTrailingSpaces
|
||||
} from '../rules/line'
|
||||
import { lowerCaseFileNames, noSpacesInFileNames } from '../rules/path'
|
||||
import { LineEndings } from './LineEndings'
|
||||
import { FileLintRule, LineLintRule, PathLintRule } from './LintRule'
|
||||
|
||||
/**
|
||||
@@ -21,6 +29,7 @@ export class LintConfig {
|
||||
readonly pathLintRules: PathLintRule[] = []
|
||||
readonly maxLineLength: number = 80
|
||||
readonly indentationMultiple: number = 2
|
||||
readonly lineEndings: LineEndings = LineEndings.LF
|
||||
|
||||
constructor(json?: any) {
|
||||
if (json?.noTrailingSpaces) {
|
||||
@@ -40,6 +49,19 @@ export class LintConfig {
|
||||
this.lineLintRules.push(maxLineLength)
|
||||
}
|
||||
|
||||
if (json?.lineEndings) {
|
||||
if (
|
||||
json.lineEndings !== LineEndings.LF &&
|
||||
json.lineEndings !== LineEndings.CRLF
|
||||
) {
|
||||
throw new Error(
|
||||
`Invalid value for lineEndings: can be ${LineEndings.LF} or ${LineEndings.CRLF}`
|
||||
)
|
||||
}
|
||||
this.lineEndings = json.lineEndings
|
||||
this.fileLintRules.push(lineEndings)
|
||||
}
|
||||
|
||||
if (!isNaN(json?.indentationMultiple)) {
|
||||
this.indentationMultiple = json.indentationMultiple as number
|
||||
this.lineLintRules.push(indentationMultiple)
|
||||
@@ -56,5 +78,17 @@ export class LintConfig {
|
||||
if (json?.lowerCaseFileNames) {
|
||||
this.pathLintRules.push(lowerCaseFileNames)
|
||||
}
|
||||
|
||||
if (json?.hasMacroNameInMend) {
|
||||
this.fileLintRules.push(hasMacroNameInMend)
|
||||
}
|
||||
|
||||
if (json?.noNestedMacros) {
|
||||
this.fileLintRules.push(noNestedMacros)
|
||||
}
|
||||
|
||||
if (json?.hasMacroParentheses) {
|
||||
this.fileLintRules.push(hasMacroParentheses)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -19,6 +19,7 @@ export interface LintRule {
|
||||
export interface LineLintRule extends LintRule {
|
||||
type: LintRuleType.Line
|
||||
test: (value: string, lineNumber: number, config?: LintConfig) => Diagnostic[]
|
||||
fix?: (value: string, config?: LintConfig) => string
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -26,7 +27,8 @@ export interface LineLintRule extends LintRule {
|
||||
*/
|
||||
export interface FileLintRule extends LintRule {
|
||||
type: LintRuleType.File
|
||||
test: (value: string) => Diagnostic[]
|
||||
test: (value: string, config?: LintConfig) => Diagnostic[]
|
||||
fix?: (value: string, config?: LintConfig) => string
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
export * from './Diagnostic'
|
||||
export * from './FormatResult'
|
||||
export * from './LintConfig'
|
||||
export * from './LintRule'
|
||||
export * from './LintRuleType'
|
||||
|
||||
@@ -1,3 +1,6 @@
|
||||
/**
|
||||
* Executes an async callback for each item in the given array.
|
||||
*/
|
||||
export async function asyncForEach(
|
||||
array: any[],
|
||||
callback: (item: any, index: number, originalArray: any[]) => any
|
||||
|
||||
13
src/utils/getColumnNumber.spec.ts
Normal file
13
src/utils/getColumnNumber.spec.ts
Normal file
@@ -0,0 +1,13 @@
|
||||
import { getColumnNumber } from './getColumnNumber'
|
||||
|
||||
describe('getColumnNumber', () => {
|
||||
it('should return the column number of the specified string within a line of text', () => {
|
||||
expect(getColumnNumber('foo bar', 'bar')).toEqual(5)
|
||||
})
|
||||
|
||||
it('should throw an error when the specified string is not found within the text', () => {
|
||||
expect(() => getColumnNumber('foo bar', 'baz')).toThrowError(
|
||||
"String 'baz' was not found in line 'foo bar'"
|
||||
)
|
||||
})
|
||||
})
|
||||
7
src/utils/getColumnNumber.ts
Normal file
7
src/utils/getColumnNumber.ts
Normal file
@@ -0,0 +1,7 @@
|
||||
export const getColumnNumber = (line: string, text: string): number => {
|
||||
const index = (line.split('\n').pop() as string).indexOf(text)
|
||||
if (index < 0) {
|
||||
throw new Error(`String '${text}' was not found in line '${line}'`)
|
||||
}
|
||||
return (line.split('\n').pop() as string).indexOf(text) + 1
|
||||
}
|
||||
@@ -2,6 +2,10 @@ import * as fileModule from '@sasjs/utils/file'
|
||||
import { LintConfig } from '../types/LintConfig'
|
||||
import { getLintConfig } from './getLintConfig'
|
||||
|
||||
const expectedFileLintRulesCount = 4
|
||||
const expectedLineLintRulesCount = 5
|
||||
const expectedPathLintRulesCount = 2
|
||||
|
||||
describe('getLintConfig', () => {
|
||||
it('should get the lint config', async () => {
|
||||
const config = await getLintConfig()
|
||||
@@ -17,8 +21,8 @@ describe('getLintConfig', () => {
|
||||
const config = await getLintConfig()
|
||||
|
||||
expect(config).toBeInstanceOf(LintConfig)
|
||||
expect(config.fileLintRules.length).toEqual(1)
|
||||
expect(config.lineLintRules.length).toEqual(5)
|
||||
expect(config.pathLintRules.length).toEqual(2)
|
||||
expect(config.fileLintRules.length).toEqual(expectedFileLintRulesCount)
|
||||
expect(config.lineLintRules.length).toEqual(expectedLineLintRulesCount)
|
||||
expect(config.pathLintRules.length).toEqual(expectedPathLintRulesCount)
|
||||
})
|
||||
})
|
||||
|
||||
@@ -14,7 +14,10 @@ export const DefaultLintConfiguration = {
|
||||
lowerCaseFileNames: true,
|
||||
maxLineLength: 80,
|
||||
noTabIndentation: true,
|
||||
indentationMultiple: 2
|
||||
indentationMultiple: 2,
|
||||
hasMacroNameInMend: true,
|
||||
noNestedMacros: true,
|
||||
hasMacroParentheses: true
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -27,7 +30,6 @@ export async function getLintConfig(): Promise<LintConfig> {
|
||||
const configuration = await readFile(
|
||||
path.join(projectRoot, '.sasjslint')
|
||||
).catch((_) => {
|
||||
console.warn('Unable to load .sasjslint file. Using default configuration.')
|
||||
return JSON.stringify(DefaultLintConfiguration)
|
||||
})
|
||||
return new LintConfig(JSON.parse(configuration))
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
export * from './getLintConfig'
|
||||
export * from './getProjectRoot'
|
||||
export * from './listSasFiles'
|
||||
export * from './splitText'
|
||||
|
||||
@@ -1,5 +1,9 @@
|
||||
import { listFilesInFolder } from '@sasjs/utils/file'
|
||||
|
||||
/**
|
||||
* Fetches a list of .sas files in the given path.
|
||||
* @returns {Promise<string[]>} resolves with an array of file names.
|
||||
*/
|
||||
export const listSasFiles = async (folderPath: string): Promise<string[]> => {
|
||||
const files = await listFilesInFolder(folderPath)
|
||||
return files.filter((f) => f.endsWith('.sas'))
|
||||
|
||||
105
src/utils/parseMacros.spec.ts
Normal file
105
src/utils/parseMacros.spec.ts
Normal file
@@ -0,0 +1,105 @@
|
||||
import { LintConfig } from '../types'
|
||||
import { parseMacros } from './parseMacros'
|
||||
|
||||
describe('parseMacros', () => {
|
||||
it('should return an array with a single macro', () => {
|
||||
const text = `%macro test;
|
||||
%put 'hello';
|
||||
%mend`
|
||||
|
||||
const macros = parseMacros(text, new LintConfig())
|
||||
|
||||
expect(macros.length).toEqual(1)
|
||||
expect(macros).toContainEqual({
|
||||
name: 'test',
|
||||
declarationLine: '%macro test;',
|
||||
terminationLine: '%mend',
|
||||
declaration: '%macro test',
|
||||
termination: '%mend',
|
||||
startLineNumber: 1,
|
||||
endLineNumber: 3,
|
||||
parentMacro: '',
|
||||
hasMacroNameInMend: false,
|
||||
hasParentheses: false,
|
||||
mismatchedMendMacroName: ''
|
||||
})
|
||||
})
|
||||
|
||||
it('should return an array with multiple macros', () => {
|
||||
const text = `%macro foo;
|
||||
%put 'foo';
|
||||
%mend;
|
||||
%macro bar();
|
||||
%put 'bar';
|
||||
%mend bar;`
|
||||
|
||||
const macros = parseMacros(text, new LintConfig())
|
||||
|
||||
expect(macros.length).toEqual(2)
|
||||
expect(macros).toContainEqual({
|
||||
name: 'foo',
|
||||
declarationLine: '%macro foo;',
|
||||
terminationLine: '%mend;',
|
||||
declaration: '%macro foo',
|
||||
termination: '%mend',
|
||||
startLineNumber: 1,
|
||||
endLineNumber: 3,
|
||||
parentMacro: '',
|
||||
hasMacroNameInMend: false,
|
||||
hasParentheses: false,
|
||||
mismatchedMendMacroName: ''
|
||||
})
|
||||
expect(macros).toContainEqual({
|
||||
name: 'bar',
|
||||
declarationLine: '%macro bar();',
|
||||
terminationLine: '%mend bar;',
|
||||
declaration: '%macro bar()',
|
||||
termination: '%mend bar',
|
||||
startLineNumber: 4,
|
||||
endLineNumber: 6,
|
||||
parentMacro: '',
|
||||
hasMacroNameInMend: true,
|
||||
hasParentheses: true,
|
||||
mismatchedMendMacroName: ''
|
||||
})
|
||||
})
|
||||
|
||||
it('should detect nested macro definitions', () => {
|
||||
const text = `%macro test()
|
||||
%put 'hello';
|
||||
%macro test2
|
||||
%put 'world;
|
||||
%mend
|
||||
%mend test`
|
||||
|
||||
const macros = parseMacros(text, new LintConfig())
|
||||
|
||||
expect(macros.length).toEqual(2)
|
||||
expect(macros).toContainEqual({
|
||||
name: 'test',
|
||||
declarationLine: '%macro test()',
|
||||
terminationLine: '%mend test',
|
||||
declaration: '%macro test()',
|
||||
termination: '%mend test',
|
||||
startLineNumber: 1,
|
||||
endLineNumber: 6,
|
||||
parentMacro: '',
|
||||
hasMacroNameInMend: true,
|
||||
hasParentheses: true,
|
||||
mismatchedMendMacroName: ''
|
||||
})
|
||||
expect(macros).toContainEqual({
|
||||
name: 'test2',
|
||||
declarationLine: ' %macro test2',
|
||||
terminationLine: ' %mend',
|
||||
declaration: '%macro test2',
|
||||
termination: '%mend',
|
||||
startLineNumber: 3,
|
||||
endLineNumber: 5,
|
||||
parentMacro: 'test',
|
||||
hasMacroNameInMend: false,
|
||||
hasParentheses: false,
|
||||
mismatchedMendMacroName: ''
|
||||
})
|
||||
})
|
||||
})
|
||||
97
src/utils/parseMacros.ts
Normal file
97
src/utils/parseMacros.ts
Normal file
@@ -0,0 +1,97 @@
|
||||
import { LintConfig } from '../types/LintConfig'
|
||||
import { LineEndings } from '../types/LineEndings'
|
||||
import { trimComments } from './trimComments'
|
||||
|
||||
interface Macro {
|
||||
name: string
|
||||
startLineNumber: number | null
|
||||
endLineNumber: number | null
|
||||
declarationLine: string
|
||||
terminationLine: string
|
||||
declaration: string
|
||||
termination: string
|
||||
parentMacro: string
|
||||
hasMacroNameInMend: boolean
|
||||
hasParentheses: boolean
|
||||
mismatchedMendMacroName: string
|
||||
}
|
||||
|
||||
export const parseMacros = (text: string, config?: LintConfig): Macro[] => {
|
||||
const lineEnding = config?.lineEndings === LineEndings.CRLF ? '\r\n' : '\n'
|
||||
const lines: string[] = text ? text.split(lineEnding) : []
|
||||
const macros: Macro[] = []
|
||||
|
||||
let isCommentStarted = false
|
||||
let macroStack: Macro[] = []
|
||||
lines.forEach((line, index) => {
|
||||
const { statement: trimmedLine, commentStarted } = trimComments(
|
||||
line,
|
||||
isCommentStarted
|
||||
)
|
||||
isCommentStarted = commentStarted
|
||||
const statements: string[] = trimmedLine ? trimmedLine.split(';') : []
|
||||
|
||||
statements.forEach((statement) => {
|
||||
const { statement: trimmedStatement, commentStarted } = trimComments(
|
||||
statement,
|
||||
isCommentStarted
|
||||
)
|
||||
isCommentStarted = commentStarted
|
||||
|
||||
if (trimmedStatement.startsWith('%macro')) {
|
||||
const startLineNumber = index + 1
|
||||
const name = trimmedStatement
|
||||
.slice(7, trimmedStatement.length)
|
||||
.trim()
|
||||
.split('(')[0]
|
||||
macroStack.push({
|
||||
name,
|
||||
startLineNumber,
|
||||
endLineNumber: null,
|
||||
parentMacro: macroStack.length
|
||||
? macroStack[macroStack.length - 1].name
|
||||
: '',
|
||||
hasParentheses: trimmedStatement.endsWith('()'),
|
||||
hasMacroNameInMend: false,
|
||||
mismatchedMendMacroName: '',
|
||||
declarationLine: line,
|
||||
terminationLine: '',
|
||||
declaration: trimmedStatement,
|
||||
termination: ''
|
||||
})
|
||||
} else if (trimmedStatement.startsWith('%mend')) {
|
||||
if (macroStack.length) {
|
||||
const macro = macroStack.pop() as Macro
|
||||
const mendMacroName =
|
||||
trimmedStatement.split(' ').filter((s: string) => !!s)[1] || ''
|
||||
macro.endLineNumber = index + 1
|
||||
macro.hasMacroNameInMend = mendMacroName === macro.name
|
||||
macro.mismatchedMendMacroName = macro.hasMacroNameInMend
|
||||
? ''
|
||||
: mendMacroName
|
||||
macro.terminationLine = line
|
||||
macro.termination = trimmedStatement
|
||||
macros.push(macro)
|
||||
} else {
|
||||
macros.push({
|
||||
name: '',
|
||||
startLineNumber: null,
|
||||
endLineNumber: index + 1,
|
||||
parentMacro: '',
|
||||
hasParentheses: false,
|
||||
hasMacroNameInMend: false,
|
||||
mismatchedMendMacroName: '',
|
||||
declarationLine: '',
|
||||
terminationLine: line,
|
||||
declaration: '',
|
||||
termination: trimmedStatement
|
||||
})
|
||||
}
|
||||
}
|
||||
})
|
||||
})
|
||||
|
||||
macros.push(...macroStack)
|
||||
|
||||
return macros
|
||||
}
|
||||
41
src/utils/splitText.spec.ts
Normal file
41
src/utils/splitText.spec.ts
Normal file
@@ -0,0 +1,41 @@
|
||||
import { LintConfig } from '../types'
|
||||
import { splitText } from './splitText'
|
||||
|
||||
describe('splitText', () => {
|
||||
const config = new LintConfig({
|
||||
noTrailingSpaces: true,
|
||||
noEncodedPasswords: true,
|
||||
hasDoxygenHeader: true,
|
||||
noSpacesInFileNames: true,
|
||||
maxLineLength: 80,
|
||||
lowerCaseFileNames: true,
|
||||
noTabIndentation: true,
|
||||
indentationMultiple: 2,
|
||||
hasMacroNameInMend: true,
|
||||
noNestedMacros: true,
|
||||
hasMacroParentheses: true,
|
||||
lineEndings: 'lf'
|
||||
})
|
||||
|
||||
it('should return an empty array when text is falsy', () => {
|
||||
const lines = splitText('', config)
|
||||
|
||||
expect(lines.length).toEqual(0)
|
||||
})
|
||||
|
||||
it('should return an array of lines from text', () => {
|
||||
const lines = splitText(`line 1\nline 2`, config)
|
||||
|
||||
expect(lines.length).toEqual(2)
|
||||
expect(lines[0]).toEqual('line 1')
|
||||
expect(lines[1]).toEqual('line 2')
|
||||
})
|
||||
|
||||
it('should work with CRLF line endings', () => {
|
||||
const lines = splitText(`line 1\r\nline 2`, config)
|
||||
|
||||
expect(lines.length).toEqual(2)
|
||||
expect(lines[0]).toEqual('line 1')
|
||||
expect(lines[1]).toEqual('line 2')
|
||||
})
|
||||
})
|
||||
17
src/utils/splitText.ts
Normal file
17
src/utils/splitText.ts
Normal file
@@ -0,0 +1,17 @@
|
||||
import { LintConfig } from '../types/LintConfig'
|
||||
import { LineEndings } from '../types/LineEndings'
|
||||
|
||||
/**
|
||||
* Splits the given content into a list of lines, regardless of CRLF or LF line endings.
|
||||
* @param {string} text - the text content to be split into lines.
|
||||
* @returns {string[]} an array of lines from the given text
|
||||
*/
|
||||
export const splitText = (text: string, config: LintConfig): string[] => {
|
||||
if (!text) return []
|
||||
const expectedLineEndings =
|
||||
config.lineEndings === LineEndings.LF ? '\n' : '\r\n'
|
||||
const incorrectLineEndings = expectedLineEndings === '\n' ? '\r\n' : '\n'
|
||||
return text
|
||||
.replace(new RegExp(incorrectLineEndings, 'g'), expectedLineEndings)
|
||||
.split(expectedLineEndings)
|
||||
}
|
||||
74
src/utils/trimComments.spec.ts
Normal file
74
src/utils/trimComments.spec.ts
Normal file
@@ -0,0 +1,74 @@
|
||||
import { trimComments } from './trimComments'
|
||||
|
||||
describe('trimComments', () => {
|
||||
it('should return statment', () => {
|
||||
expect(
|
||||
trimComments(`
|
||||
/* some comment */ some code;
|
||||
`)
|
||||
).toEqual({ statement: 'some code;', commentStarted: false })
|
||||
})
|
||||
|
||||
it('should return statment, having multi-line comment', () => {
|
||||
expect(
|
||||
trimComments(`
|
||||
/* some
|
||||
comment */
|
||||
some code;
|
||||
`)
|
||||
).toEqual({ statement: 'some code;', commentStarted: false })
|
||||
})
|
||||
|
||||
it('should return statment, having multi-line comment and some code present in comment', () => {
|
||||
expect(
|
||||
trimComments(`
|
||||
/* some
|
||||
some code;
|
||||
comment */
|
||||
some other code;
|
||||
`)
|
||||
).toEqual({ statement: 'some other code;', commentStarted: false })
|
||||
})
|
||||
|
||||
it('should return empty statment, having only comment', () => {
|
||||
expect(
|
||||
trimComments(`
|
||||
/* some
|
||||
some code;
|
||||
comment */
|
||||
`)
|
||||
).toEqual({ statement: '', commentStarted: false })
|
||||
})
|
||||
|
||||
it('should return empty statment, having continuity in comment', () => {
|
||||
expect(
|
||||
trimComments(`
|
||||
/* some
|
||||
some code;
|
||||
`)
|
||||
).toEqual({ statement: '', commentStarted: true })
|
||||
})
|
||||
|
||||
it('should return statment, having already started comment and ends', () => {
|
||||
expect(
|
||||
trimComments(
|
||||
`
|
||||
comment */
|
||||
some code;
|
||||
`,
|
||||
true
|
||||
)
|
||||
).toEqual({ statement: 'some code;', commentStarted: false })
|
||||
})
|
||||
|
||||
it('should return empty statment, having already started comment and continuity in comment', () => {
|
||||
expect(
|
||||
trimComments(
|
||||
`
|
||||
some code;
|
||||
`,
|
||||
true
|
||||
)
|
||||
).toEqual({ statement: '', commentStarted: true })
|
||||
})
|
||||
})
|
||||
19
src/utils/trimComments.ts
Normal file
19
src/utils/trimComments.ts
Normal file
@@ -0,0 +1,19 @@
|
||||
export const trimComments = (
|
||||
statement: string,
|
||||
commentStarted: boolean = false
|
||||
): { statement: string; commentStarted: boolean } => {
|
||||
let trimmed = (statement || '').trim()
|
||||
|
||||
if (commentStarted || trimmed.startsWith('/*')) {
|
||||
const parts = trimmed.split('*/')
|
||||
if (parts.length > 1) {
|
||||
return {
|
||||
statement: (parts.pop() as string).trim(),
|
||||
commentStarted: false
|
||||
}
|
||||
} else {
|
||||
return { statement: '', commentStarted: true }
|
||||
}
|
||||
}
|
||||
return { statement: trimmed, commentStarted: false }
|
||||
}
|
||||
@@ -7,6 +7,7 @@
|
||||
],
|
||||
"target": "es5",
|
||||
"module": "commonjs",
|
||||
"downlevelIteration": true,
|
||||
"moduleResolution": "node",
|
||||
"esModuleInterop": true,
|
||||
"declaration": true,
|
||||
|
||||
Reference in New Issue
Block a user