From 049aa6bf26a11d425ed03f9874555d6767d097d9 Mon Sep 17 00:00:00 2001 From: Allan Bowe Date: Tue, 13 Dec 2022 17:32:13 +0000 Subject: [PATCH] chore: updating README to describe new behaviour for noTabs. BREAKING CHANGE: we now check for ANY tab characters rather than just the tabs at the start of a line. --- README.md | 45 ++++++++++++++++++++++----------------------- 1 file changed, 22 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 08e7745..b0206a5 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ 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 +# Linting @sasjs/lint is used by the following products: @@ -30,13 +30,13 @@ Configuration is via a `.sasjslint` file with the following structure (these are "maxLineLength": 80, "noNestedMacros": true, "noSpacesInFileNames": true, - "noTabIndentation": true, + "noTabs": true, "noTrailingSpaces": true, "defaultHeader": "/**{lineEnding} @file{lineEnding} @brief {lineEnding}

SAS Macros

{lineEnding}**/" } ``` -### SAS Lint Settings +## SAS Lint Settings Each setting can have three states: @@ -46,7 +46,7 @@ Each setting can have three states: For more details, and the default state, see the description of each rule below. It is also possible to change whether a rule returns ERROR or WARN using the `severityLevels` object. -#### defaultHeader +### defaultHeader This isn't actually a rule - but rather a formatting setting, which applies to SAS program that do NOT begin with `/**`. It can be triggered by running `sasjs lint fix` in the SASjs CLI, or by hitting "save" when using the SASjs VS Code extension (with "formatOnSave" in place) @@ -68,53 +68,53 @@ If creating a new value, use `{lineEnding}` instead of `\n`, eg as follows: } ``` -#### noEncodedPasswords +### noEncodedPasswords This rule will highlight any rows that contain a `{sas00X}` type password, or `{sasenc}`. These passwords (especially 001 and 002) are NOT secure, and should NEVER be pushed to source control or saved to the filesystem without special permissions applied. - Default: true - Severity: ERROR -#### hasDoxygenHeader +### 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 +### 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 was the result of a poll with over 300 votes. - Default: true - Severity: WARNING -#### hasMacroParentheses +### 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 -#### ignoreList +### ignoreList There may be specific files (or folders) that are not good candidates for linting. Simply list them in this array and they will be ignored. In addition, any files in the project `.gitignore` file will also be ignored. -#### indentationMultiple +### 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 +### 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 +### 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) @@ -125,14 +125,14 @@ We strongly recommend a line length limit, and set the bar at 80. To turn this f - Default: 80 - Severity: WARNING -#### noNestedMacros +### noNestedMacros Where macros are defined inside other macros, they are recompiled every time the outer macro is invoked. Hence, it is widely considered inefficient, and bad practice, to nest macro definitions. - Default: true - Severity: WARNING -#### noSpacesInFileNames +### noSpacesInFileNames The 'beef' we have with spaces in filenames is twofold: @@ -144,22 +144,22 @@ In addition, when such files are used in URLs, they are often padded with a mess - Default: true - Severity: WARNING -#### noTabs +### noTabs -Whilst there are some arguments for using tabs to indent (such as the ability to set your own indentation width, and to reduce character count) there are many, many, many developers who think otherwise. We're in that camp. Sorry (not sorry). +Whilst there are some arguments for using tabs (such as the ability to set your own indentation width, and to reduce character count) there are many, many, many developers who think otherwise. We're in that camp. Sorry (not sorry). - Alias: noTabIndentation - Default: true - Severity: WARNING -#### noTrailingSpaces +### noTrailingSpaces This will highlight lines with trailing spaces. Trailing spaces serve no useful purpose in a SAS program. - Default: true - severity: WARNING -### severityLevel +## severityLevel This setting allows the default severity to be adjusted. This is helpful when running the lint in a pipeline or git hook. Simply list the rules you would like to adjust along with the desired setting ("warn" or "error"), eg as follows: @@ -179,13 +179,12 @@ This setting allows the default severity to be adjusted. This is helpful when ru - "warn" - show warning in the log (doesn’t affect exit code) - "error" - show error in the log (exit code is 1 when triggered) -### Upcoming Linting Rules: +## 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 +# SAS Formatter A formatter will automatically apply rules when you hit SAVE, which can save a LOT of time. @@ -203,13 +202,13 @@ We're looking to implement the following rules: We are also investigating some harder stuff, such as automatic indentation and code layout -## Sponsorship & Contributions +# 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. -## Contributors ✨ +# Contributors ✨