fix: check tab indentation in whole line

sasjs · Dec 9, 2022 · 3701253 · 3701253
1 parent 8be59ac
commit 3701253
Show file tree

Hide file tree

Showing 8 changed files with 163 additions and 116 deletions.
diff --git a/README.md b/README.md
@@ -10,47 +10,45 @@
 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.
+- [@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": true,
-    "hasMacroParentheses": true,
-    "ignoreList": [
-      "sajsbuild/",
-      "sasjsresults/"
-    ],
-    "indentationMultiple": 2,
-    "lowerCaseFileNames": true,
-    "maxLineLength": 80,
-    "noNestedMacros": true,
-    "noSpacesInFileNames": true,
-    "noTabIndentation": true,
-    "noTrailingSpaces": true,
-    "defaultHeader": "/**{lineEnding}  @file{lineEnding}  @brief <Your brief here>{lineEnding}  <h4> SAS Macros </h4>{lineEnding}**/"
+  "noEncodedPasswords": true,
+  "hasDoxygenHeader": true,
+  "hasMacroNameInMend": true,
+  "hasMacroParentheses": true,
+  "ignoreList": ["sajsbuild/", "sasjsresults/"],
+  "indentationMultiple": 2,
+  "lowerCaseFileNames": true,
+  "maxLineLength": 80,
+  "noNestedMacros": true,
+  "noSpacesInFileNames": true,
+  "noTabIndentation": true,
+  "noTrailingSpaces": true,
+  "defaultHeader": "/**{lineEnding}  @file{lineEnding}  @brief <Your brief here>{lineEnding}  <h4> SAS Macros </h4>{lineEnding}**/"
 }
 ```
 
 ### SAS Lint Settings
 
 Each setting can have three states:
 
-* OFF - usually by setting the value to `false` or 0.  In this case, the rule won't be executed.
-* WARN - a warning is written to the log, but the return code will be 0
-* ERROR - an error is written to the log, and the return code is 1
+- OFF - usually by setting the value to `false` or 0. In this case, the rule won't be executed.
+- WARN - a warning is written to the log, but the return code will be 0
+- ERROR - an error is written to the log, and the return code is 1
 
-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.
+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
 
-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)
+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)
 
 The default header is as follows:
 
@@ -61,6 +59,7 @@ The default header is as follows:
   <h4> SAS Macros </h4>
 **/
 ```
+
 If creating a new value, use `{lineEnding}` instead of `\n`, eg as follows:
 
 ```json
@@ -71,86 +70,98 @@ If creating a new value, use `{lineEnding}` instead of `\n`, eg as follows:
 
 #### noEncodedPasswords
 
-This rule will highlight any rows that contain a `{sas00X}` type password, or `{sasenc}`.  These passwords (especially 001 and 002) are NOT secure, and should NEVER be pushed to source control or saved to the filesystem without special permissions applied.
+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
+- 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
+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 was the result of a poll with over 300 votes.
 
-* Default:  true
-* Severity: WARNING
+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
-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
+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
-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.
+
+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
+
 This will check each line to ensure that the count of leading spaces can be divided cleanly by this multiple.
 
-* Default:  2
-* Severity: WARNING
+- 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
+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)
+
+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.
 
-We strongly recommend a line length limit, and set the bar at 80.  To turn this feature off, set the value to 0.
+We strongly recommend a line length limit, and set the bar at 80. To turn this feature off, set the value to 0.
 
-* Default: 80
-* Severity: WARNING
+- Default: 80
+- Severity: WARNING
 
 #### 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
+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
+
 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
+- 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.
 
-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
 
-* Default:  true
-* Severity: WARNING
+#### noTabs
 
-#### noTabIndentation
-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 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).
 
-* Default:  true
-* Severity: WARNING
+- Alias: noTabIndentation
+- 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
+This will highlight lines with trailing spaces. Trailing spaces serve no useful purpose in a SAS program.
+
+- Default: true
+- severity: WARNING
 
 ### severityLevel
 
-This setting allows the default severity to be adjusted.  This is helpful when running the lint in a pipeline or git hook.  Simply list the rules you would like to adjust along with the desired setting ("warn" or "error"), eg as follows:
+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:
 
 ```json
 {
@@ -165,46 +176,47 @@ This setting allows the default severity to be adjusted.  This is helpful when r
 }
 ```
 
-* "warn" - show warning in the log (doesn’t affect exit code)
-* "error" - show error in the log (exit code is 1 when triggered)
+- "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:
 
-* `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
+- `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've already implemented the following rules:
 
-* Add the macro name to the %mend statement
-* Add a doxygen header template if none exists
-* Remove trailing spaces
+- Add the macro name to the %mend statement
+- Add a doxygen header template if none exists
+- Remove trailing spaces
 
 We're looking to implement the following rules:
 
-* Change tabs to spaces
-* zap gremlins
-* fix line endings
+- Change tabs to spaces
+- zap gremlins
+- fix line endings
 
 We are also investigating 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?
+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 ✨
+
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
+
 [![All Contributors](https://img.shields.io/badge/all_contributors-8-orange.svg?style=flat-square)](#contributors-)
+
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
+
 Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
 
 <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->

diff --git a/sasjslint-schema.json b/sasjslint-schema.json
@@ -15,7 +15,7 @@
     "maxLineLength": 80,
     "noNestedMacros": true,
     "noSpacesInFileNames": true,
-    "noTabIndentation": true,
+    "noTabs": true,
     "noTrailingSpaces": true,
     "lineEndings": "lf",
     "strictMacroDefinition": true,
@@ -29,7 +29,7 @@
       "noSpacesInFileNames": true,
       "lowerCaseFileNames": true,
       "maxLineLength": 80,
-      "noTabIndentation": true,
+      "noTabs": true,
       "indentationMultiple": 4,
       "hasMacroNameInMend": true,
       "noNestedMacros": true,
@@ -120,11 +120,11 @@
       "default": true,
       "examples": [true, false]
     },
-    "noTabIndentation": {
-      "$id": "#/properties/noTabIndentation",
+    "noTabs": {
+      "$id": "#/properties/noTabs",
       "type": "boolean",
-      "title": "noTabIndentation",
-      "description": "Enforces no indentation using tabs. Shows a warning when a line starts with a tab.",
+      "title": "noTabs",
+      "description": "Enforces no indentation using tabs. Shows a warning when a line contains a tab.",
       "default": true,
       "examples": [true, false]
     },
@@ -166,15 +166,18 @@
       "title": "severityLevel",
       "description": "An object which specifies the severity level of each rule.",
       "default": {},
-      "examples": [{
-        "hasDoxygenHeader": "warn",
-        "maxLineLength": "warn",
-        "noTrailingSpaces": "error"   
-      }, {
-        "hasDoxygenHeader": "warn",
-        "maxLineLength": "error",
-        "noTrailingSpaces": "error"   
-      }],
+      "examples": [
+        {
+          "hasDoxygenHeader": "warn",
+          "maxLineLength": "warn",
+          "noTrailingSpaces": "error"
+        },
+        {
+          "hasDoxygenHeader": "warn",
+          "maxLineLength": "error",
+          "noTrailingSpaces": "error"
+        }
+      ],
       "properties": {
         "noEncodedPasswords": {
           "$id": "#/properties/severityLevel/noEncodedPasswords",
@@ -188,7 +191,8 @@
           "title": "hasDoxygenHeader",
           "type": "string",
           "enum": ["error", "warn"],
-          "default": "warn"        },
+          "default": "warn"
+        },
         "hasMacroNameInMend": {
           "$id": "#/properties/severityLevel/hasMacroNameInMend",
           "title": "hasMacroNameInMend",
@@ -238,9 +242,9 @@
           "enum": ["error", "warn"],
           "default": "warn"
         },
-        "noTabIndentation": {
-          "$id": "#/properties/severityLevel/noTabIndentation",
-          "title": "noTabIndentation",
+        "noTabs": {
+          "$id": "#/properties/severityLevel/noTabs",
+          "title": "noTabs",
           "type": "string",
           "enum": ["error", "warn"],
           "default": "warn"
@@ -267,7 +271,6 @@
           "default": "warn"
         }
       }
-
     }
   }
 }
diff --git a/src/rules/line/index.ts b/src/rules/line/index.ts
@@ -1,5 +1,5 @@
 export { indentationMultiple } from './indentationMultiple'
 export { maxLineLength } from './maxLineLength'
 export { noEncodedPasswords } from './noEncodedPasswords'
-export { noTabIndentation } from './noTabIndentation'
+export { noTabs } from './noTabs'
 export { noTrailingSpaces } from './noTrailingSpaces'
diff --git a/src/rules/line/noTabIndentation.spec.ts → src/rules/line/noTabs.spec.ts b/src/rules/line/noTabIndentation.spec.ts → src/rules/line/noTabs.spec.ts
@@ -1,15 +1,15 @@
 import { Severity } from '../../types/Severity'
-import { noTabIndentation } from './noTabIndentation'
+import { noTabs } from './noTabs'
 
 describe('noTabs', () => {
   it('should return an empty array when the line is not indented with a tab', () => {
     const line = "%put 'hello';"
-    expect(noTabIndentation.test(line, 1)).toEqual([])
+    expect(noTabs.test(line, 1)).toEqual([])
   })
 
   it('should return an array with a single diagnostic when the line is indented with a tab', () => {
     const line = "\t%put 'hello';"
-    expect(noTabIndentation.test(line, 1)).toEqual([
+    expect(noTabs.test(line, 1)).toEqual([
       {
         message: 'Line is indented with a tab',
         lineNumber: 1,