@sap/eslint-plugin-cds 2.1.1 → 2.2.1

package/CHANGELOG.md

@@ -6,6 +6,62 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
+## [2.1.2] - 2021-10-05
+
+## Changed
+
+- Allow not only *.js but also other file types (i.e. *.ts, etc) to bypass plugin rules
+
+## [2.1.1] - 2021-10-04
+
+## Changed
+
+- Added preprocessor to avoid (other plugins) parsing errors on cds files
+
+## [2.2.0] - 2021-10-29
+
+## Added
+
+- Added typings to javascript for all exposed apis
+
+## Changed
+
+- Aligned rule creation and tester api with ESLint
+
+## [2.1.2] - 2021-10-05
+
+## Changed
+
+- Allow not only *.js but also other file types (i.e. *.ts, etc) to bypass plugin rules
+
+## [2.1.1] - 2021-10-04
+
+## Changed
+
+- Added preprocessor to avoid (other plugins) parsing errors on cds files
+
+## [2.2.1] - 2021-10-29
+
+## Changed
+
+- Optimized model loading and fixed bug in loading of 'outsider' files
+
+## [2.2.0] - 2021-10-29
+
+## Added
+
+- Added typings to javascript for all exposed apis
+
+## Changed
+
+- Aligned rule creation and tester api with ESLint
+
+## [2.1.2] - 2021-10-05
+
+## Changed
+
+- Allow not only *.js but also other file types (i.e. *.ts, etc) to bypass plugin rules
+
 ## [2.1.1] - 2021-10-04
 
 ## Changed

package/README.md

@@ -3,4 +3,4 @@
 
 The [ESLint](https://eslint.org) plugin includes a set of recommended [SAP Cloud Application Programming Model (CAP)](https://cap.cloud.sap) model and environment rules.	The aim of CDS linting is to catch issues with CDS models and with the environment early. To use this module we recommend to install [@sap/cds-dk](https://www.npmjs.com/package/@sap/cds-dk) globally.
 
-See the [CDS Linting documentation](https://cap.cloud.sap/docs/get-started/tools/#cds-lint) for more details, or jump directly to a complete [list of rules](https://cap.cloud.sap/docs/get-started/tools/#cds-lint-rules). CAP provides a set of recommended rules. On top, you can create your own, application-specific rules.
+See the [CDS Linting documentation](https://cap.cloud.sap/docs/tools/#cds-lint) for more details, or jump directly to a complete [list of rules](https://cap.cloud.sap/docs/tools/#cds-lint-rules). CAP provides a set of recommended rules. On top, you can create your own, application-specific rules.

package/lib/api/formatter.js

@@ -8,7 +8,7 @@
  */
 const fs = require("fs");
 const path = require("path");
-const { CLIEngine } = require("eslint")
+const { CLIEngine } = require("eslint");
 // Note: CliEngine depracted, but new Node API requires
 // async Linter framework
 const formatter = CLIEngine.getFormatter("stylish");
@@ -17,54 +17,40 @@ const { styleText, isEditor, isTest } = require("../impl/utils/helpers");
 
 const CONSTANTS = require("../impl/constants");
 
-// eslint-disable-next-line no-control-regex
+/* eslint-disable-next-line no-control-regex */
 const REGEX_STRIP_ANSI = /[\u001b\u009b][[()#;?]*(?:[0-9]{1,4}(?:;[0-9]{0,4})*)?[0-9A-ORZcf-nqry=><]/g;
 const REGEX_NEWLINE = /\r?\n/g;
 
 let projects = Cache.getModels();
 
-// Types: results: ESLint.LintResult[], data: any
 module.exports = function (results, data) {
   let output = "";
-    // Get plugin ruleIDs
-    const rules = getPluginRules(data);
+  // Get plugin ruleIDs
+  const rules = getPluginRules(data);
   // Get ruleIDs from custom rules
   const customRules = [];
   projects.forEach((project) => {
-    const customRulesPath = path.resolve(project, CONSTANTS.customRulesDir, 'rules');
+    const customRulesPath = path.resolve(project, CONSTANTS.customRulesDir, "rules");
     if (fs.existsSync(customRulesPath)) {
       fs.readdirSync(customRulesPath).forEach((customRule) => {
-        const ruleID = path.basename(customRule, '.js');
+        const ruleID = path.basename(customRule, ".js");
         if (!customRules.includes(ruleID)) {
-            customRules.push(ruleID)
-          }
-      })
+          customRules.push(ruleID);
+        }
+      });
     }
-  })
+  });
   if (!Cache.has("err")) {
     // Filter out error messages not from plugin or custom rules
     if (!isEditor() && !isTest()) {
       results.forEach((result) => {
-        result.messages = result.messages.filter (msg => (
-          rules.model.includes(msg.ruleId) ||
-          rules.environment.includes(msg.ruleId) ||
-          customRules.includes(msg.ruleId)
-        ))
-        // result.messages.forEach((msg) => {
-        //   if (!rules.model.includes(msg.ruleId) &&
-        //       !rules.environment.includes(msg.ruleId) &&
-        //       !customRules.includes(msg.ruleId)) {
-        //     if (!resultsToRemove.includes(i)) {
-        //       resultsToRemove.push(i);
-        //     }
-        //   }
-        // })
-      })
-      // results.forEach((result, index) => {
-      //   if (resultsToRemove.includes(index)) {
-      //     results.splice(index, 1);
-      //   }
-      // })
+        result.messages = result.messages.filter(
+          (msg) =>
+            rules.model.includes(msg.ruleId) ||
+            rules.environment.includes(msg.ruleId) ||
+            customRules.includes(msg.ruleId)
+        );
+      });
     }
     // Get standard ESLint 'stylish' output
     const outputStylish = formatter(results);
@@ -83,7 +69,7 @@ module.exports = function (results, data) {
  * @param data Rules meta data
  * @returns rules object based on category
  */
-function getPluginRules (data) {
+function getPluginRules(data) {
   const rules = { environment: [], model: [], recommended: [] };
   Object.keys(data.rulesMeta).forEach((rule) => {
     if (data.rulesMeta[rule]) {
@@ -107,7 +93,7 @@ function getPluginRules (data) {
  * @param rules Plugin rules based on category
  * @returns Collected msgs
  */
-function splitOutput (outputStylish, rules) {
+function splitOutput(outputStylish, rules) {
   const msgs = { environment: {}, model: {}, report: [] };
   let projects = Cache.getModels();
   let file = "";
@@ -122,10 +108,7 @@ function splitOutput (outputStylish, rules) {
       !lineStripped.startsWith("✖")
     ) {
       file = line;
-      if (
-        process.argv[1].includes("jest") ||
-        process.argv[1].includes("mocha")
-      ) {
+      if (process.argv[1].includes("jest") || process.argv[1].includes("mocha")) {
         projects = [path.dirname(lineStripped)];
       }
     } else if (rules.environment.includes(rule)) {
@@ -143,9 +126,7 @@ function splitOutput (outputStylish, rules) {
       if (project) {
         if (!Object.keys(msgs.environment).includes(project)) {
           msgs.environment[project] = [lineWithoutLocation];
-        } else if (
-          !msgs.environment[project].includes(lineWithoutLocation)
-        ) {
+        } else if (!msgs.environment[project].includes(lineWithoutLocation)) {
           msgs.environment[project].push(lineWithoutLocation);
         }
       }
@@ -162,10 +143,7 @@ function splitOutput (outputStylish, rules) {
           msgs.model[file].push(line);
         }
       }
-    } else if (
-      lineStripped.startsWith("✖") ||
-      lineStripped.includes("potentially fixable")
-    ) {
+    } else if (lineStripped.startsWith("✖") || lineStripped.includes("potentially fixable")) {
       msgs.report.push(line);
     }
   });
@@ -179,7 +157,7 @@ function splitOutput (outputStylish, rules) {
  * @param msgs error messages based on category
  * @returns
  */
-function formatOutput (output, msgs) {
+function formatOutput(output, msgs) {
   // First, output model msgs per file (from ESLint 'stylish' output)
   for (const fileModel in msgs.model) {
     if (msgs.model[fileModel].length > 0) {

package/lib/api/index.js

@@ -1,12 +1,22 @@
 /**
  * Our custom ESLint plugin API should:
- * - Expose 'createRule', and 'runRuleTester' to users to support the addition of *custom* cds rules
- * - Expose 'getConfigPath' and 'getFileExtensions' for usage in 'cds lint' (@sap/cds-dk)
+ * - Expose 'defineRule', and 'runRuleTester' to users to support the addition of *custom* cds rules
+ * - Expose 'getConfigPath', 'getFileExtensions', and 'genDocs' for usage in 'cds lint' (@sap/cds-dk)
+ * - Expose 'parserPath' for 'cds lint' rule unit tests with ESLint's ruleTester
  */
 
- const { defineRule, createRule, runRuleTester } = require("../impl/ruleFactory");
- const { getConfigPath } = require("../impl/utils/model");
- const { getFileExtensions } = require("../impl/utils/rules");
- const { genDocs } = require("../impl/utils/rules");
+const { createRule, defineRule, runRuleTester } = require("../impl/ruleFactory");
+const { getConfigPath } = require("../impl/utils/model");
+const { getFileExtensions } = require("../impl/utils/rules");
+const { genDocs } = require("../impl/utils/rules");
+const parserPath = require.resolve("../impl/parser");
 
- module.exports = { defineRule, createRule, runRuleTester, getConfigPath, getFileExtensions, genDocs }
+module.exports = {
+  createRule,
+  defineRule,
+  runRuleTester,
+  getConfigPath,
+  getFileExtensions,
+  genDocs,
+  parserPath,
+};

package/lib/impl/constants.js

@@ -2,12 +2,10 @@
  * This file contains all constants for:
  * - categories: The category labels we use to for model and environment rules
  * - customRulesDir: The custom rules directory name in the user's project home
- *                   which contains the subdirs docs, rules and tests
+ *                   which contains the subdirs 'docs', 'rules' and 'tests'
  * - recommended: The set of this plugin's recommended rules and their severities
- * - globals: Any globals which should be exposed to ESLint by this plugin
- * - overrides:
- *   - files: Any additional file extensions which ESLint should lint
- *   - parser: The custom parser require to lint the additional files types
+ * - globals: The globals which should be exposed to ESLint by this plugin
+ * - files: Any additional file extensions which ESLint should lint
  */
 
 module.exports = {

package/lib/impl/index.js

@@ -1,46 +1,58 @@
 /**
  * Custom ESLint plugin:
  * https://eslint.org/docs/developer-guide/working-with-plugins
- * This file exposes our plugins ESLint config, which (according to ESLint guidelines) must:
- * - Expose any 'configs' for prescribed rule configuration bundles (i.e. "recommended")
- *   See shareable configs: https://eslint.org/docs/developer-guide/shareable-configs
- * - Expose any 'globals' for use in ESLint 
+ * This file exposes our plugins ESLint configuration, which must:
+ * - Expose any 'configs' for prescribed rule configuration bundles
+ *     (i.e. "recommended"). See shareable configs:
+ *     https://eslint.org/docs/developer-guide/shareable-configs
+ * - Expose any 'globals' for use in ESLint
  * - Expose any 'processors' for use in ESLint
  * - Expose any 'rules' for use in ESLint
- * We also use this file to initiate our cached 'cds', which:
- * - Store our models and envs (internally)
- * - Caches cds services api uses in custom lint rules (externally)
+ * We also initiate and cache the objects 'rulesInfo' and 'cds' for later use.
  */
 
-const { rules } = require("./rules");
+const path = require("path");
 const processor = require("./processor");
 const plugin = require("../../package.json").name;
+
+const { getRules } = require("../impl/utils/rules");
+const {
+  Cache,
+  getCDSProxy,
+  getLocation,
+  getRange,
+} = require("../impl/utils/model");
 const { files, globals, recommended } = require("./constants");
-const { Cache, getProxy, getLocation, getRange } = require("../impl/utils/model");
 
 const cds = require("@sap/cds");
 cds.getLocation = getLocation;
 cds.getRange = getRange;
-Cache.set('cds', getProxy(cds));
+Cache.set("cds", getCDSProxy(cds));
+
+let rulesInfo;
+if (!Cache.has("rulesInfo")) {
+  rulesInfo = getRules(path.join(__dirname, "rules"));
+  Cache.set("rulesInfo", rulesInfo);
+} else {
+  rulesInfo = Cache.get("rulesInfo");
+}
 
 module.exports = {
   configs: {
     recommended: {
+      globals,
       plugins: [plugin],
       overrides: [
         {
           files: files,
-          parser: "./parser",
-          processor: "@sap/cds/cds"
+          processor: "@sap/cds/cds",
         },
       ],
       rules: recommended,
-    }
+    },
   },
-  globals,
   processors: {
-    cds: processor
+    cds: processor,
   },
-  parser: "./parser",
-  rules
-}
+  rules: rulesInfo.rules,
+};

package/lib/impl/parser.js

@@ -2,12 +2,20 @@
  * Custom ESLint parser:
  * https://eslint.org/docs/developer-guide/working-with-custom-parsers
  * This file must:
- * - Expose 'parseForESLint' method on the parser which should return the AST, optional properties services, a scopeManager, and visitorKeys
+ * - Expose 'parseForESLint' method on the parser which should return the AST,
+ *   optional properties services, a scopeManager, and visitorKeys
  * - Expose default method 'parse' which should return the AST
- * Both methods should take in the source code and an optional configuration (parserOptions)
+ * Both methods should take in the source code and an optional configuration
+ * (parserOptions). Note, that because we use a 'empty' preprocessor, the
+ * parser is only used by ESLint's ruleTester.
  */
 
-const { getAST, getProxy, getLocation, getRange } = require("./utils/model");
+const {
+  getAST,
+  getCDSProxy,
+  getLocation,
+  getRange,
+} = require("../impl/utils/model");
 const cds = require("@sap/cds");
 
 module.exports = {
@@ -21,7 +29,7 @@ module.exports = {
     return {
       ast: getAST(code),
       services: {
-        cdsProxy: getProxy(cds),
+        cdsProxy: getCDSProxy(cds),
       },
       scopeManager: null,
       tokensAndComments: [],

package/lib/impl/processor.js

@@ -1,12 +1,23 @@
-const path = require("path");
+/**
+ * ESLint custom processor:
+ * https://eslint.org/docs/developer-guide/working-with-plugins#processors-in-plugins
+ * This processor is used to avoid parsing errors when this plugin is extended
+ * in ESLint alongside other plugins, such as prettier which then also try to 
+ * read the new file types exposed via globs.
+ * Note, that because we cache the file contents and return empty files, the
+ * plugin's parser is not actually used and we must retrieve the file contents
+ * later on (ruleFactory).  
+ */
+
 const { Cache } = require("./utils/model");
+const { isValidFile } = require("./utils/helpers");
 
 module.exports = {
   preprocess: function (text, filename) {
-    const fileExtension = `*${path.extname(filename)}`;
-    if (["*.cds", "*.csn"].includes(fileExtension)) {
-        Cache.set(`file:${filename}`, text)
+    if (isValidFile(filename)) {
+      Cache.set(`processed:${filename}`, text);
     }
-    return [{ text: '', filename }];
-  }
+    return [{ text: "", filename }];
+  },
+  supportsAutofix: true,
 };