@sasjs/lint 2.2.1 → 2.3.0

package/README.md

@@ -23,7 +23,7 @@ Configuration is via a `.sasjslint` file with the following structure (these are
   "hasDoxygenHeader": true,
   "hasMacroNameInMend": true,
   "hasMacroParentheses": true,
-  "ignoreList": ["sajsbuild/", "sasjsresults/"],
+  "ignoreList": ["sasjsbuild/", "sasjsresults/"],
   "indentationMultiple": 2,
   "lineEndings": "off",
   "lowerCaseFileNames": true,
@@ -49,9 +49,11 @@ 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.
 
+Configuring a non-zero return code (ERROR) is helpful when running `sasjs lint` as part of a git pre-commit hook.  An example is available [here](https://github.com/sasjs/template_jobs/blob/main/.git-hooks/pre-commit).
+
 ### allowedGremlins
 
-An array of hex codes that represents allowed gremlins (invisible / undesirable characters). To allow all gremlins, you can also set the `noGremlins` rule to `false`.
+An array of hex codes that represents allowed gremlins (invisible / undesirable characters). To allow all gremlins, you can also set the `noGremlins` rule to `false`.  The full gremlin list is [here](https://github.com/sasjs/lint/blob/main/src/utils/gremlinCharacters.ts).
 
 Example:
 
@@ -228,6 +230,13 @@ In addition, when such files are used in URLs, they are often padded with a mess
 - Default: true
 - Severity: WARNING
 
+As an alternative (or in addition) to using a lint rule, you can also set the following in your `.gitignore` file to prevent files with spaces from being committed:
+
+```
+# prevent files/folders with spaces
+**\ **
+```
+
 ### noTabs
 
 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).

package/format/formatProject.js

@@ -49,10 +49,11 @@ var formatProject = function () { return __awaiter(void 0, void 0, void 0, funct
         switch (_a.label) {
             case 0: return [4 /*yield*/, getProjectRoot_1.getProjectRoot()];
             case 1:
-                projectRoot = (_a.sent()) || process.projectDir || process.currentDir;
+                projectRoot = (_a.sent()) || process.currentDir;
                 if (!projectRoot) {
                     throw new Error('SASjs Project Root was not found.');
                 }
+                console.info("Formatting all .sas files under " + projectRoot);
                 return [4 /*yield*/, formatFolder_1.formatFolder(projectRoot)];
             case 2: return [2 /*return*/, _a.sent()];
         }

package/format/formatProject.js.map

@@ -1 +1 @@
-{"version":3,"file":"formatProject.js","sourceRoot":"","sources":["../../src/format/formatProject.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEA,0DAAwD;AACxD,+CAA6C;AAE7C;;;GAGG;AACI,IAAM,aAAa,GAAG;;;;oBAExB,qBAAM,+BAAc,EAAE,EAAA;;gBADnB,WAAW,GACf,CAAC,SAAsB,CAAC,IAAI,OAAO,CAAC,UAAU,IAAI,OAAO,CAAC,UAAU;gBACtE,IAAI,CAAC,WAAW,EAAE;oBAChB,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAA;iBACrD;gBAEM,qBAAM,2BAAY,CAAC,WAAW,CAAC,EAAA;oBAAtC,sBAAO,SAA+B,EAAA;;;KACvC,CAAA;AARY,QAAA,aAAa,iBAQzB"}
+{"version":3,"file":"formatProject.js","sourceRoot":"","sources":["../../src/format/formatProject.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEA,0DAAwD;AACxD,+CAA6C;AAE7C;;;GAGG;AACI,IAAM,aAAa,GAAG;;;;oBACN,qBAAM,+BAAc,EAAE,EAAA;;gBAArC,WAAW,GAAG,CAAC,SAAsB,CAAC,IAAI,OAAO,CAAC,UAAU;gBAClE,IAAI,CAAC,WAAW,EAAE;oBAChB,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAA;iBACrD;gBAED,OAAO,CAAC,IAAI,CAAC,qCAAmC,WAAa,CAAC,CAAA;gBAEvD,qBAAM,2BAAY,CAAC,WAAW,CAAC,EAAA;oBAAtC,sBAAO,SAA+B,EAAA;;;KACvC,CAAA;AATY,QAAA,aAAa,iBASzB"}

package/lint/lintProject.js

@@ -49,10 +49,11 @@ var lintProject = function () { return __awaiter(void 0, void 0, void 0, functio
         switch (_a.label) {
             case 0: return [4 /*yield*/, getProjectRoot_1.getProjectRoot()];
             case 1:
-                projectRoot = (_a.sent()) || process.projectDir || process.currentDir;
+                projectRoot = (_a.sent()) || process.currentDir;
                 if (!projectRoot) {
                     throw new Error('SASjs Project Root was not found.');
                 }
+                console.info("Linting all .sas files under " + projectRoot);
                 return [4 /*yield*/, lintFolder_1.lintFolder(projectRoot)];
             case 2: return [2 /*return*/, _a.sent()];
         }

package/lint/lintProject.js.map

@@ -1 +1 @@
-{"version":3,"file":"lintProject.js","sourceRoot":"","sources":["../../src/lint/lintProject.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,0DAAwD;AACxD,2CAAyC;AAEzC;;;GAGG;AACI,IAAM,WAAW,GAAG;;;;oBAEtB,qBAAM,+BAAc,EAAE,EAAA;;gBADnB,WAAW,GACf,CAAC,SAAsB,CAAC,IAAI,OAAO,CAAC,UAAU,IAAI,OAAO,CAAC,UAAU;gBACtE,IAAI,CAAC,WAAW,EAAE;oBAChB,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAA;iBACrD;gBACM,qBAAM,uBAAU,CAAC,WAAW,CAAC,EAAA;oBAApC,sBAAO,SAA6B,EAAA;;;KACrC,CAAA;AAPY,QAAA,WAAW,eAOvB"}
+{"version":3,"file":"lintProject.js","sourceRoot":"","sources":["../../src/lint/lintProject.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,0DAAwD;AACxD,2CAAyC;AAEzC;;;GAGG;AACI,IAAM,WAAW,GAAG;;;;oBACJ,qBAAM,+BAAc,EAAE,EAAA;;gBAArC,WAAW,GAAG,CAAC,SAAsB,CAAC,IAAI,OAAO,CAAC,UAAU;gBAClE,IAAI,CAAC,WAAW,EAAE;oBAChB,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAA;iBACrD;gBAED,OAAO,CAAC,IAAI,CAAC,kCAAgC,WAAa,CAAC,CAAA;gBAEpD,qBAAM,uBAAU,CAAC,WAAW,CAAC,EAAA;oBAApC,sBAAO,SAA6B,EAAA;;;KACrC,CAAA;AATY,QAAA,WAAW,eASvB"}

package/package.json

@@ -51,5 +51,5 @@
     "@sasjs/utils": "2.52.0",
     "ignore": "5.2.4"
   },
-  "version": "2.2.1"
+  "version": "2.3.0"
 }

package/sasjslint-schema.json

@@ -20,7 +20,7 @@
     "noSpacesInFileNames": true,
     "noTabs": true,
     "noTrailingSpaces": true,
-    "lineEndings": "lf",
+    "lineEndings": "off",
     "strictMacroDefinition": true,
     "ignoreList": ["sajsbuild", "sasjsresults"]
   },
@@ -185,7 +185,7 @@
       "enum": ["lf", "crlf", "off"],
       "title": "lineEndings",
       "description": "Enforces the configured terminating character for each line. Shows a warning when incorrect line endings are present.",
-      "default": "lf",
+      "default": "off",
       "examples": ["lf", "crlf"]
     },
     "strictMacroDefinition": {

package/utils/getLintConfig.d.ts

@@ -1,9 +1,11 @@
 import { LintConfig } from '../types/LintConfig';
+import { LineEndings } from '../types/LineEndings';
 export declare const getDefaultHeader: () => string;
 /**
  * Default configuration that is used when a .sasjslint file is not found
  */
 export declare const DefaultLintConfiguration: {
+    lineEndings: LineEndings;
     noTrailingSpaces: boolean;
     noEncodedPasswords: boolean;
     hasDoxygenHeader: boolean;
@@ -22,7 +24,7 @@ export declare const DefaultLintConfiguration: {
     defaultHeader: string;
 };
 /**
- * Fetches the config from the .sasjslint file and creates a LintConfig object.
+ * Fetches the config from the .sasjslint file (at project root or home directory) and creates a LintConfig object.
  * Returns the default configuration when a .sasjslint file is unavailable.
  * @returns {Promise<LintConfig>} resolves with an object representing the current lint configuration.
  */

package/utils/getLintConfig.js

@@ -41,9 +41,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getLintConfig = exports.DefaultLintConfiguration = exports.getDefaultHeader = void 0;
 var path_1 = __importDefault(require("path"));
+var os_1 = __importDefault(require("os"));
 var LintConfig_1 = require("../types/LintConfig");
 var file_1 = require("@sasjs/utils/file");
 var getProjectRoot_1 = require("./getProjectRoot");
+var LineEndings_1 = require("../types/LineEndings");
 var getDefaultHeader = function () {
     return "/**{lineEnding}  @file{lineEnding}  @brief <Your brief here>{lineEnding}  <h4> SAS Macros </h4>{lineEnding}**/";
 };
@@ -52,6 +54,7 @@ exports.getDefaultHeader = getDefaultHeader;
  * Default configuration that is used when a .sasjslint file is not found
  */
 exports.DefaultLintConfiguration = {
+    lineEndings: LineEndings_1.LineEndings.OFF,
     noTrailingSpaces: true,
     noEncodedPasswords: true,
     hasDoxygenHeader: true,
@@ -70,19 +73,20 @@ exports.DefaultLintConfiguration = {
     defaultHeader: exports.getDefaultHeader()
 };
 /**
- * Fetches the config from the .sasjslint file and creates a LintConfig object.
+ * Fetches the config from the .sasjslint file (at project root or home directory) and creates a LintConfig object.
  * Returns the default configuration when a .sasjslint file is unavailable.
  * @returns {Promise<LintConfig>} resolves with an object representing the current lint configuration.
  */
 function getLintConfig() {
     return __awaiter(this, void 0, void 0, function () {
-        var projectRoot, configuration;
+        var projectRoot, lintFileLocation, configuration;
         return __generator(this, function (_a) {
             switch (_a.label) {
                 case 0: return [4 /*yield*/, getProjectRoot_1.getProjectRoot()];
                 case 1:
                     projectRoot = _a.sent();
-                    return [4 /*yield*/, file_1.readFile(path_1.default.join(projectRoot, '.sasjslint')).catch(function (_) {
+                    lintFileLocation = projectRoot || os_1.default.homedir();
+                    return [4 /*yield*/, file_1.readFile(path_1.default.join(lintFileLocation, '.sasjslint')).catch(function (_) {
                             return JSON.stringify(exports.DefaultLintConfiguration);
                         })];
                 case 2:

package/utils/getLintConfig.js.map

@@ -1 +1 @@
-{"version":3,"file":"getLintConfig.js","sourceRoot":"","sources":["../../src/utils/getLintConfig.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,8CAAuB;AACvB,kDAAgD;AAChD,0CAA4C;AAC5C,mDAAiD;AAE1C,IAAM,gBAAgB,GAAG;IAC9B,OAAA,gHAAgH;AAAhH,CAAgH,CAAA;AADrG,QAAA,gBAAgB,oBACqF;AAElH;;GAEG;AACU,QAAA,wBAAwB,GAAG;IACtC,gBAAgB,EAAE,IAAI;IACtB,kBAAkB,EAAE,IAAI;IACxB,gBAAgB,EAAE,IAAI;IACtB,mBAAmB,EAAE,IAAI;IACzB,kBAAkB,EAAE,IAAI;IACxB,aAAa,EAAE,EAAE;IACjB,mBAAmB,EAAE,EAAE;IACvB,iBAAiB,EAAE,EAAE;IACrB,gBAAgB,EAAE,IAAI;IACtB,mBAAmB,EAAE,CAAC;IACtB,kBAAkB,EAAE,IAAI;IACxB,cAAc,EAAE,IAAI;IACpB,mBAAmB,EAAE,IAAI;IACzB,qBAAqB,EAAE,IAAI;IAC3B,UAAU,EAAE,IAAI;IAChB,aAAa,EAAE,wBAAgB,EAAE;CAClC,CAAA;AAED;;;;GAIG;AACH,SAAsB,aAAa;;;;;wBACb,qBAAM,+BAAc,EAAE,EAAA;;oBAApC,WAAW,GAAG,SAAsB;oBACpB,qBAAM,eAAQ,CAClC,cAAI,CAAC,IAAI,CAAC,WAAW,EAAE,YAAY,CAAC,CACrC,CAAC,KAAK,CAAC,UAAC,CAAC;4BACR,OAAO,IAAI,CAAC,SAAS,CAAC,gCAAwB,CAAC,CAAA;wBACjD,CAAC,CAAC,EAAA;;oBAJI,aAAa,GAAG,SAIpB;oBACF,sBAAO,IAAI,uBAAU,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,EAAA;;;;CACjD;AARD,sCAQC"}
+{"version":3,"file":"getLintConfig.js","sourceRoot":"","sources":["../../src/utils/getLintConfig.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,8CAAuB;AACvB,0CAAmB;AACnB,kDAAgD;AAChD,0CAA4C;AAC5C,mDAAiD;AACjD,oDAAkD;AAE3C,IAAM,gBAAgB,GAAG;IAC9B,OAAA,gHAAgH;AAAhH,CAAgH,CAAA;AADrG,QAAA,gBAAgB,oBACqF;AAElH;;GAEG;AACU,QAAA,wBAAwB,GAAG;IACtC,WAAW,EAAE,yBAAW,CAAC,GAAG;IAC5B,gBAAgB,EAAE,IAAI;IACtB,kBAAkB,EAAE,IAAI;IACxB,gBAAgB,EAAE,IAAI;IACtB,mBAAmB,EAAE,IAAI;IACzB,kBAAkB,EAAE,IAAI;IACxB,aAAa,EAAE,EAAE;IACjB,mBAAmB,EAAE,EAAE;IACvB,iBAAiB,EAAE,EAAE;IACrB,gBAAgB,EAAE,IAAI;IACtB,mBAAmB,EAAE,CAAC;IACtB,kBAAkB,EAAE,IAAI;IACxB,cAAc,EAAE,IAAI;IACpB,mBAAmB,EAAE,IAAI;IACzB,qBAAqB,EAAE,IAAI;IAC3B,UAAU,EAAE,IAAI;IAChB,aAAa,EAAE,wBAAgB,EAAE;CAClC,CAAA;AAED;;;;GAIG;AACH,SAAsB,aAAa;;;;;wBACb,qBAAM,+BAAc,EAAE,EAAA;;oBAApC,WAAW,GAAG,SAAsB;oBACpC,gBAAgB,GAAG,WAAW,IAAI,YAAE,CAAC,OAAO,EAAE,CAAA;oBAC9B,qBAAM,eAAQ,CAClC,cAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,YAAY,CAAC,CAC1C,CAAC,KAAK,CAAC,UAAC,CAAC;4BACR,OAAO,IAAI,CAAC,SAAS,CAAC,gCAAwB,CAAC,CAAA;wBACjD,CAAC,CAAC,EAAA;;oBAJI,aAAa,GAAG,SAIpB;oBACF,sBAAO,IAAI,uBAAU,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,EAAA;;;;CACjD;AATD,sCASC"}

package/utils/getProjectRoot.js

@@ -41,6 +41,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getProjectRoot = void 0;
 var path_1 = __importDefault(require("path"));
+var os_1 = __importDefault(require("os"));
 var file_1 = require("@sasjs/utils/file");
 /**
  * Returns the absolute path to the location of the .sasjslint file.
@@ -49,7 +50,7 @@ var file_1 = require("@sasjs/utils/file");
  */
 function getProjectRoot() {
     return __awaiter(this, void 0, void 0, function () {
-        var root, rootFound, i, currentLocation, maxLevels, isRoot;
+        var root, rootFound, i, currentLocation, homeDir, maxLevels, isRoot;
         return __generator(this, function (_a) {
             switch (_a.label) {
                 case 0:
@@ -57,10 +58,11 @@ function getProjectRoot() {
                     rootFound = false;
                     i = 1;
                     currentLocation = process.cwd();
+                    homeDir = os_1.default.homedir();
                     maxLevels = currentLocation.split(path_1.default.sep).length;
                     _a.label = 1;
                 case 1:
-                    if (!(i <= maxLevels && !rootFound)) return [3 /*break*/, 3];
+                    if (!(i <= maxLevels && !rootFound && currentLocation !== homeDir)) return [3 /*break*/, 3];
                     return [4 /*yield*/, file_1.fileExists(path_1.default.join(currentLocation, '.sasjslint'))];
                 case 2:
                     isRoot = _a.sent();

package/utils/getProjectRoot.js.map

@@ -1 +1 @@
-{"version":3,"file":"getProjectRoot.js","sourceRoot":"","sources":["../../src/utils/getProjectRoot.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,8CAAuB;AACvB,0CAA8C;AAE9C;;;;GAIG;AACH,SAAsB,cAAc;;;;;;oBAC9B,IAAI,GAAG,EAAE,CAAA;oBACT,SAAS,GAAG,KAAK,CAAA;oBACjB,CAAC,GAAG,CAAC,CAAA;oBACL,eAAe,GAAG,OAAO,CAAC,GAAG,EAAE,CAAA;oBAE7B,SAAS,GAAG,eAAe,CAAC,KAAK,CAAC,cAAI,CAAC,GAAG,CAAC,CAAC,MAAM,CAAA;;;yBAEjD,CAAA,CAAC,IAAI,SAAS,IAAI,CAAC,SAAS,CAAA;oBAClB,qBAAM,iBAAU,CAAC,cAAI,CAAC,IAAI,CAAC,eAAe,EAAE,YAAY,CAAC,CAAC,EAAA;;oBAAnE,MAAM,GAAG,SAA0D;oBAEzE,IAAI,MAAM,EAAE;wBACV,SAAS,GAAG,IAAI,CAAA;wBAChB,IAAI,GAAG,eAAe,CAAA;wBAEtB,wBAAK;qBACN;yBAAM;wBACL,eAAe,GAAG,cAAI,CAAC,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,CAAA;wBAClD,CAAC,EAAE,CAAA;qBACJ;;wBAGH,sBAAO,IAAI,EAAA;;;;CACZ;AAvBD,wCAuBC"}
+{"version":3,"file":"getProjectRoot.js","sourceRoot":"","sources":["../../src/utils/getProjectRoot.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,8CAAuB;AACvB,0CAAmB;AACnB,0CAA8C;AAE9C;;;;GAIG;AACH,SAAsB,cAAc;;;;;;oBAC9B,IAAI,GAAG,EAAE,CAAA;oBACT,SAAS,GAAG,KAAK,CAAA;oBACjB,CAAC,GAAG,CAAC,CAAA;oBACL,eAAe,GAAG,OAAO,CAAC,GAAG,EAAE,CAAA;oBAC7B,OAAO,GAAG,YAAE,CAAC,OAAO,EAAE,CAAA;oBAEtB,SAAS,GAAG,eAAe,CAAC,KAAK,CAAC,cAAI,CAAC,GAAG,CAAC,CAAC,MAAM,CAAA;;;yBAEjD,CAAA,CAAC,IAAI,SAAS,IAAI,CAAC,SAAS,IAAI,eAAe,KAAK,OAAO,CAAA;oBACjD,qBAAM,iBAAU,CAAC,cAAI,CAAC,IAAI,CAAC,eAAe,EAAE,YAAY,CAAC,CAAC,EAAA;;oBAAnE,MAAM,GAAG,SAA0D;oBAEzE,IAAI,MAAM,EAAE;wBACV,SAAS,GAAG,IAAI,CAAA;wBAChB,IAAI,GAAG,eAAe,CAAA;wBAEtB,wBAAK;qBACN;yBAAM;wBACL,eAAe,GAAG,cAAI,CAAC,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,CAAA;wBAClD,CAAC,EAAE,CAAA;qBACJ;;wBAGH,sBAAO,IAAI,EAAA;;;;CACZ;AAxBD,wCAwBC"}