@sap/eslint-plugin-cds 2.1.1 → 2.2.1

package/lib/impl/utils/rules.js

@@ -1,25 +1,30 @@
+/**
+ * @typedef { import('eslint').Linter.ConfigOverride.files } ConfigOverrideFiles
+ */
+
 const fs = require("fs");
 const path = require("path");
 const { mkdirp } = require("@sap/cds/lib/utils");
 const { getLastLine } = require("./model");
 
 const JSONC = require("./jsonc");
-const CONSTANTS = require("../constants");
-const REGEX_COMMENT_START = "(/\\*|(.+)?//)\\s+eslint-";
+const { categories, files, recommended } = require("../constants");
+const REGEX_COMMENT_START = "(/\\*|(.+)?//)(\\s?)+eslint-";
 const REGEX_COMMENTS = `${REGEX_COMMENT_START}(enable|disable)(-next)?(-line)?(.+)?`;
 
 module.exports = {
   /**
    * Returns an array of allowed file extensions
    * the plugin can parse of the form "*.ext"
-   * @returns Array of file extensions
+   * @returns {ConfigOverrideFiles} Array of file extensions
    */
   getFileExtensions: function () {
-    return CONSTANTS.files;
+    return files;
   },
 
   /**
-   * Turns rules on/off for given line according to eslint-disable comments:
+   * Turns rules "on" or "off" for given line according to eslint-disable
+   * comments:
    * 1. Reads code string and extracts a list of comments (in order)
    * 2. Initiates rulesDisabled array with all rules "on" by default
    * 3. Switches rules "off" (or "on" again) based on disable comment
@@ -28,92 +33,152 @@ module.exports = {
    * @param line current code line to analyze
    * @returns rules dictionary with rules being either 'on' and 'off'
    */
-  getDisabledFromComments: function (rules, code, sourcecode, line) {
+  getDisabled: function (
+    rules,
+    listEnvRules,
+    listModelRules,
+    code,
+    sourcecode,
+    line
+  ) {
     const listDisabled = [];
     const rulesDisabled = rules.reduce((o, key) => ({ ...o, [key]: "on" }), {});
-    const matches = [...code.matchAll(REGEX_COMMENTS)];
-    if (matches.length > 0) {
-      matches.forEach((match) => {
-        if (match) {
-          const index = match.index;
-          match = match[0];
-          if (match.includes("*/")) {
-            match = match.split("*/")[0].replace("/*", "");
-          } else if (match.includes("//")) {
-            match = match.split("//")[1];
-          }
-          if (match) match = match.trim();
-          ["disable", "enable"].forEach((keyword) => {
-            const loc = sourcecode.getLocFromIndex(index);
-            const disableType = match.split(" ")[0];
-            let disableRules = match.split(`${disableType} `)[1];
-            if (disableRules) {
-              disableRules = disableRules.split(",").map((rule) => rule.trim());
-            } else {
-              const envRules = module.exports.getEnvRules(path.join(__dirname, "../rules"));
-              const modelRules = module.exports.getModelRules(path.join(__dirname, "../rules"));
-              disableRules = envRules.concat(modelRules).map((rule) => `@sap/cds/${rule}`);
+    let matches = [];
+    if (code) {
+      matches = [...code.matchAll(REGEX_COMMENTS)];
+      if (matches.length > 0) {
+        matches.forEach((match) => {
+          if (match) {
+            const index = match.index;
+            match = match[0];
+            if (match.includes("*/")) {
+              match = match.split("*/")[0].replace("/*", "");
+            } else if (match.includes("//")) {
+              match = match.split("//")[1];
             }
-            let comment = {};
-            if (
-              [
-                `eslint-${keyword}`,
-                `eslint-${keyword}-line`,
-                `eslint-${keyword}-next-line`,
-              ].includes(disableType)
-            ) {
-              if (disableType.includes("-next-line")) {
-                comment = {
-                  lineComment: loc.line,
-                  lineDisabled: loc.line + 1,
-                  rules: disableRules,
-                  type: keyword,
-                };
+            if (match) {
+              match = match.trim();
+            }
+            ["disable", "enable"].forEach((keyword) => {
+              const loc = sourcecode.getLocFromIndex(index);
+              const disableType = match.split(" ")[0];
+              let disableRules = match.split(`${disableType} `)[1];
+              if (disableRules) {
+                disableRules = disableRules
+                  .split(",")
+                  .map((rule) => rule.trim());
               } else {
-                comment = {
-                  lineComment: loc.line,
-                  lineDisabled: loc.line,
-                  rules: disableRules,
-                  type: keyword,
-                };
+                disableRules = listEnvRules
+                  .concat(listModelRules)
+                  .map((rule) => `@sap/cds/${rule}`);
               }
-              if (!disableType.includes("-line")) {
-                comment.lineDisabled = "EOF";
+              let comment = {};
+              if (
+                [
+                  `eslint-${keyword}`,
+                  `eslint-${keyword}-line`,
+                  `eslint-${keyword}-next-line`,
+                ].includes(disableType)
+              ) {
+                if (disableType.includes("-next-line")) {
+                  comment = {
+                    lineComment: loc.line,
+                    lineDisabled: loc.line + 1,
+                    rules: disableRules,
+                    type: keyword,
+                  };
+                } else {
+                  comment = {
+                    lineComment: loc.line,
+                    lineDisabled: loc.line,
+                    rules: disableRules,
+                    type: keyword,
+                  };
+                }
+                if (!disableType.includes("-line")) {
+                  comment.lineDisabled = "EOF";
+                }
               }
+              listDisabled.push(comment);
+            });
+          }
+        });
+        for (let i = 0; i <= listDisabled.length - 1; i++) {
+          if (listDisabled[i].lineComment > line) {
+            break;
+          }
+          if (
+            listDisabled[i].lineDisabled === "EOF" ||
+            listDisabled[i].lineDisabled === line
+          ) {
+            if (listDisabled[i].lineDisabled === "EOF") {
+              listDisabled[i].lineDisabled = getLastLine(code);
             }
-            listDisabled.push(comment);
-          });
+            if (listDisabled[i].rules) {
+              listDisabled[i].rules.forEach((rule) => {
+                if (listDisabled[i].type === "disable") {
+                  rulesDisabled[rule] = "off";
+                } else if (listDisabled[i].type === "enable") {
+                  rulesDisabled[rule] = "on";
+                }
+              });
+            }
+          }
         }
-      });
-      for (let i = 0; i <= listDisabled.length - 1; i++) {
-        if (listDisabled[i].lineComment > line) {
-          break;
+      }
+    }
+    return rulesDisabled;
+  },
+
+  /**
+   * Checks whether a given lint error/warning has been disabled
+   * by comments (as it should then be suppressed)
+   * @param entry lint report
+   * @param cdscontext cds context object
+   * @param rules all availabe rules
+   * @returns boolean
+   */
+
+  checkDisabled: function (
+    entry,
+    cdscontext,
+    rules,
+    listEnvRules,
+    listModelRules
+  ) {
+    let isDisabled = false;
+    if (entry.loc && entry.loc.start) {
+      const line = entry.loc.start.line;
+      if (cdscontext) {
+        const rulesDisabled = module.exports.getDisabled(
+          rules,
+          listEnvRules,
+          listModelRules,
+          cdscontext.code,
+          cdscontext.sourcecode,
+          line
+        );
+        let ruleID = cdscontext.ruleID;
+        if (!ruleID) {
+          ruleID = cdscontext.id;
         }
         if (
-          listDisabled[i].lineDisabled === "EOF" ||
-          listDisabled[i].lineDisabled === line
+          line &&
+          ruleID in rulesDisabled &&
+          rulesDisabled[ruleID] === "off"
         ) {
-          if (listDisabled[i].lineDisabled === "EOF") {
-            listDisabled[i].lineDisabled = getLastLine(code);
-          }
-          if (listDisabled[i].rules) {
-            listDisabled[i].rules.forEach((rule) => {
-              if (listDisabled[i].type === "disable") {
-                rulesDisabled[rule] = "off";
-              } else if (listDisabled[i].type === "enable") {
-                rulesDisabled[rule] = "on";
-              }
-            });
-          }
+          isDisabled = true;
         }
       }
     }
-    return rulesDisabled;
+    return isDisabled;
   },
+
   /**
-   * Gets value for a given key in allowed keys of ESLint's meta data in createRule api
-   * @param {*} text
-   * @param {*} key
+   * Gets value for a given key in allowed keys of ESLint's meta data in
+   * defineRule api
+   * @param {string} text meta object from rule
+   * @param {string} key key to get value for
    * @returns Value for given key
    */
   getKeyFromMeta: function (text, key) {
@@ -122,7 +187,7 @@ module.exports = {
     if (matchQuote) {
       const quote = matchQuote[0].slice(-1);
       const exprStart = `${key}:[\\s]+\\${quote}`;
-      const exprEnd = `(\\${quote},,?)`;
+      const exprEnd = `(\\${quote},?)`;
       const regexKey = new RegExp(`${exprStart}[\\s\\S]*?${exprEnd}`, "gm");
       const matchKey = regexKey.exec(text);
       if (matchKey) {
@@ -138,14 +203,23 @@ module.exports = {
         return "";
       }
     } else {
+      const regexBoolean = new RegExp(`${key}:[\\s]+true[\\s]?,`, "gm");
+      const matchBoolean = regexBoolean.exec(text);
+      if (matchBoolean) {
+        if (matchBoolean[0].includes("true,")) {
+          return true;
+        } else {
+          return false;
+        }
+      }
       return "";
     }
   },
 
   /**
    * Gets value for a given key in allowed keys for input of runRuleTester api
-   * @param {*} text
-   * @param {*} key
+   * @param {string} text test input for ruleTester
+   * @param {string} key key to get value for
    * @returns Value for given key
    */
   getKeyFromTest: function (text, key) {
@@ -180,9 +254,9 @@ module.exports = {
 
   /**
    * Generates overview table of all rules based on rule dictionary.
-   * @param {*} ruleDict
-   * @param {*} release
-   * @param {*} table
+   * @param ruleDict
+   * @param release
+   * @param table
    * @returns Markdown table
    */
   genMdRules: function (ruleDict, release, table = true) {
@@ -192,14 +266,19 @@ module.exports = {
     }
     let mdRules = `# @sap/eslint-plugin-cds [${version}]\n\n`;
     if (table) {
-      mdRules += "<table>";
-      mdRules += "<tr><th>Rule</th><th>Category</th><th>Recommended</th><th>Fixable</th><th>Version</th></tr>";
-      Object.entries(ruleDict).forEach(([category, rules]) => {
+      mdRules += "|  |   |   |   |  |\n";
+      mdRules += "|:-:|:-:|:-:|:-:|:-|\n";
+      /* eslint-disable-next-line no-unused-vars */
+      Object.entries(ruleDict).forEach(([, rules]) => {
         rules.forEach(function (rule) {
-          mdRules += `<tr><td><a title="${rule.details}" href="./Rules.md#rule-${rule.name}">${rule.name}</a></td><td>${category}</td><td>${rule.recommended}</td><td>${rule.fix}</td><td>${rule.version}</td></tr>`;
+          if (release) {
+            mdRules += `| ${rule.recommended} | ${rule.fixable} | ${rule.hasSuggestions} | [${rule.name}](Rules-released.md#rule-${rule.name}) | ${rule.details}|\n`;
+          } else {
+            mdRules += `| ${rule.recommended} | ${rule.fixable} | ${rule.hasSuggestions} | [${rule.name}](Rules.md#rule-${rule.name}) | ${rule.details}|\n`;
+          }
         });
       });
-      mdRules += "</table>\n\n<br>\n\n";
+      mdRules += "\n";
     }
     return mdRules;
   },
@@ -211,9 +290,9 @@ module.exports = {
    * If used internally within the @sap/eslint-plugin-cds, this
    * also generates 'released' files, which only contain information
    * on rules published until the currently released version.
-   * @param {*} ruleDict
-   * @param {*} docsPath
-   * @param {*} release
+   * @param ruleDict
+   * @param docsPath
+   * @param release
    */
   genDocFiles: function (ruleDict, docsPath, release) {
     let suffix = "";
@@ -252,7 +331,8 @@ module.exports = {
    * for user according to contents of:
    * - Rule files
    * - Test files (with valid/invalid/fixed examples)
-   * @param {*} projectPath
+   * @param {string} projectPath
+   * @param {string} customRulesDir
    */
   async genDocs(projectPath, customRulesDir) {
     let mdRule, mdRuleSources, mdRuleContents;
@@ -296,6 +376,10 @@ module.exports = {
           );
           const category = module.exports.getKeyFromMeta(ruleMeta, "category");
           const fixable = module.exports.getKeyFromMeta(ruleMeta, "fixable");
+          const suggestions = module.exports.getKeyFromMeta(
+            ruleMeta,
+            "hasSuggestions"
+          );
 
           let isFixable = "";
           if (["code", "whitespace"].includes(fixable)) {
@@ -303,10 +387,15 @@ module.exports = {
           }
 
           let isRecommended = "";
-          if (Object.keys(CONSTANTS.recommended).includes(`@sap/cds/${rule}`)) {
+          if (Object.keys(recommended).includes(`@sap/cds/${rule}`)) {
             isRecommended = "✔️";
           }
 
+          let hasSuggestions = "";
+          if (suggestions === true) {
+            hasSuggestions = "💡";
+          }
+
           const version = module.exports.getKeyFromMeta(ruleMeta, "version");
 
           // Get rule valid/invalid tests
@@ -338,6 +427,9 @@ module.exports = {
             const insertAt = (str, sub, pos) =>
               `${str.slice(0, pos)}${sub}${str.slice(pos)}`;
             errors.forEach((err) => {
+              if (err.messageId) {
+                err.message = err.messageId;
+              }
               const msg = err.message.replace(/"/gm, "`");
               if (err.line) {
                 const code = invalid.split("\n");
@@ -365,24 +457,24 @@ module.exports = {
               `code for this rule:</span>\n\n<pre><code>\n${invalid}\n</code></pre>`;
           }
 
-          mdRuleContents = `## Rule: ${rule}\n`;
+          mdRuleContents = `## ${rule}\n`;
           mdRuleContents += `<span class='label shifted'>${category}</span>\n\n`;
           mdRuleContents += `### Rule Details\n${details}\n\n`;
           if (mdRule) {
             mdRuleContents += `### Examples\n${mdRule}\n\n`;
           }
           mdRuleContents += `### Version\nThis rule was introduced in \`@sap/eslint-plugin-cds ${version}\`.\n\n`;
-          mdRuleSources = `### Resources\n[Rule & Documentation source](${path.relative(
-            docsPath,
-            path.join(rulePath, `${rule}.js`)
-          ).replace(/\\/g,'/')})\n\n`;
+          mdRuleSources = `### Resources\n[Rule & Documentation source](${path
+            .relative(docsPath, path.join(rulePath, `${rule}.js`))
+            .replace(/\\/g, "/")})\n\n`;
 
           if (Object.keys(ruleDict).includes(category)) {
             ruleDict[category].push({
               name: rule,
               details,
               recommended: isRecommended,
-              fix: isFixable,
+              fixable: isFixable,
+              hasSuggestions,
               version: version,
               contents: mdRuleContents,
               sources: mdRuleSources,
@@ -393,7 +485,8 @@ module.exports = {
                 name: rule,
                 details,
                 recommended: isRecommended,
-                fix: isFixable,
+                fixable: isFixable,
+                hasSuggestions,
                 version: version,
                 contents: mdRuleContents,
                 sources: mdRuleSources,
@@ -410,48 +503,39 @@ module.exports = {
     }
   },
 
-  getRules: function (dirname) {
+  /**
+   * Gets all relevant rules information (dictionary of rules contents, lists
+   * of 'env' and 'model' rules) for the rules directory provided
+   * - Default categories is 'model'
+   * @param {string} dirname
+   * @returns rules information
+   */
+  getRules(dirname) {
     const rules = {};
+    const listEnvRules = [];
+    const listModelRules = [];
     fs.readdirSync(dirname).forEach((file) => {
       if (path.extname(file) === ".js" && file !== "index.js") {
-        rules[file.replace(".js", "")] = require(path.join(dirname, file));
-      }
-    });
-    return rules;
-  },
-
-  // REVISIT: The two methods below...
-  // 1. Read all rule implementations .js sources and scan them for meta data -> why not using these files' module exports?
-  // 2. They do so twice per file -> once for getEnvRules, once for getModelRules
-  // 3. Both are even invoked twice by `cds lint` -> once before `eslint` is spawned, once after
-
-  getEnvRules: function (dirname) {
-    const envRules = [];
-    fs.readdirSync(dirname).forEach((file) => {
-      if (path.extname(file) === ".js" && file !== "index.js") {
-        const rulePath = path.join(dirname, file);
-        const ruleMeta = fs.readFileSync(rulePath, "utf8");
-        const category = module.exports.getKeyFromMeta(ruleMeta, "category");
-        if (category === "Environment") {
-          envRules.push(file.replace(".js", ""));
+        const rulename = file.replace(".js", "");
+        const ruleID = `${rulename}`;
+        rules[ruleID] = require(path.join(dirname, file));
+        const category =
+          rules[ruleID].meta.docs.category || categories["model"];
+        if (
+          !listEnvRules.includes(rulename) &&
+          category === categories["env"]
+        ) {
+          listEnvRules.push(rulename);
         }
-      }
-    });
-    return envRules;
-  },
-
-  getModelRules: function (dirname) {
-    const modelRules = [];
-    fs.readdirSync(dirname).forEach((file) => {
-      if (path.extname(file) === ".js" && file !== "index.js") {
-        const rulePath = path.join(dirname, file);
-        const ruleMeta = fs.readFileSync(rulePath, "utf8");
-        const category = module.exports.getKeyFromMeta(ruleMeta, "category");
-        if (category === CONSTANTS.categories.model) {
-          modelRules.push(file.replace(".js", ""));
+        if (
+          !listModelRules.includes(rulename) &&
+          category === categories["model"]
+        ) {
+          listModelRules.push(rulename);
         }
       }
     });
-    return modelRules;
+    const listRules = listEnvRules.concat(listModelRules);
+    return { rules, listRules, listEnvRules, listModelRules };
   },
 };

package/lib/impl/utils/validate.js

@@ -0,0 +1,56 @@
+/**
+ * @typedef { import("eslint").Rule.RuleContext.options } ContextOptions
+ */
+
+module.exports = {
+  /**
+   * Checks whether the rule name is valid, as it must be
+   * contained in either the plugins rule set or the user's
+   * custom rules provided at runtime
+   * @param context
+   * @param pluginRules
+   * @param customRules
+   * @returns
+   */
+  isValidRule: function (context, rules) {
+    if (rules.includes(context.ruleID.replace("@sap/cds/", ""))) {
+      return true;
+    }
+    return false;
+  },
+
+  /**
+   * Checks whether the compiled cds model is eligible
+   * for performing the plugin's rule checks
+   * @param cds cds object
+   * @param ruleID rule name
+   * @returns
+   */
+  isValidModel: function (context) {
+    const { cds, ruleID } = context;
+    if (
+      cds &&
+      cds.model &&
+      !cds.model.err &&
+      !(
+        ruleID === "@sap/cds/cds-compile-error" ||
+        ruleID === "cds-compile-error"
+      )
+    ) {
+      return true;
+    }
+    return false;
+  },
+
+  /**
+   * Checks whether the cds environment is passed
+   * @param {ContextOptions} options
+   * @returns
+   */
+  isValidEnv: function (options) {
+    if (options[0] && options[0].environment) {
+      return true;
+    }
+    return false;
+  },
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap/eslint-plugin-cds",
-  "version": "2.1.1",
+  "version": "2.2.1",
   "description": "ESLint plugin including recommended SAP Cloud Application Programming model and environment rules",
   "homepage": "https://cap.cloud.sap/",
   "keywords": [

package/lib/impl/rules/index.js

@@ -1,5 +0,0 @@
-const { getRules } = require("../utils/rules");
-
-const rules = getRules(__dirname);
-
-module.exports = { rules };

package/lib/impl/rules/test.hbs

@@ -1,10 +0,0 @@
-const path = require("path");
-const { runRuleTester } = require("../../../lib/api");
-
-runRuleTester({
-  root: path.resolve(__dirname),
-  rule: require(`../../../lib/rules/${path.basename(__dirname)}`),
-  filename: "{{filename}}",
-  parser: path.resolve(path.join(__dirname, '../../../lib/impl/parser')),
-  errors: "{{errors}}",
-});