@sap/eslint-plugin-cds 2.2.1 → 2.2.2

package/lib/impl/utils/rules.js

@@ -5,23 +5,14 @@
 const fs = require("fs");
 const path = require("path");
 const { mkdirp } = require("@sap/cds/lib/utils");
-const { getLastLine } = require("./model");
+const { Cache, getLastLine } = require("./model");
 
 const JSONC = require("./jsonc");
-const { categories, files, recommended } = require("../constants");
+const { categories, 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 {ConfigOverrideFiles} Array of file extensions
-   */
-  getFileExtensions: function () {
-    return files;
-  },
-
   /**
    * Turns rules "on" or "off" for given line according to eslint-disable
    * comments:
@@ -33,16 +24,13 @@ module.exports = {
    * @param line current code line to analyze
    * @returns rules dictionary with rules being either 'on' and 'off'
    */
-  getDisabled: function (
-    rules,
-    listEnvRules,
-    listModelRules,
-    code,
-    sourcecode,
-    line
-  ) {
+  getDisabled: function (code, sourcecode, line) {
     const listDisabled = [];
-    const rulesDisabled = rules.reduce((o, key) => ({ ...o, [key]: "on" }), {});
+    let { listEnvRules, listModelRules, listRules } = Cache.get("rulesInfo");
+    const rulesDisabled = listRules.reduce(
+      (o, key) => ({ ...o, [key]: "on" }),
+      {}
+    );
     let matches = [];
     if (code) {
       matches = [...code.matchAll(REGEX_COMMENTS)];
@@ -131,29 +119,20 @@ module.exports = {
   },
 
   /**
-   * Checks whether a given lint error/warning has been disabled
-   * by comments (as it should then be suppressed)
+   * Checks whether a lint rule has been disabled by eslint-disable
+   * comments at a given location
    * @param entry lint report
    * @param cdscontext cds context object
    * @param rules all availabe rules
    * @returns boolean
    */
 
-  checkDisabled: function (
-    entry,
-    cdscontext,
-    rules,
-    listEnvRules,
-    listModelRules
-  ) {
+  isRuleDisabled: function (entry, cdscontext) {
     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
@@ -187,7 +166,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) {
@@ -264,17 +243,22 @@ module.exports = {
     if (release) {
       version = release;
     }
+
     let mdRules = `# @sap/eslint-plugin-cds [${version}]\n\n`;
     if (table) {
+      mdRules += `Rules in ESLint are grouped by type to help you understand their purpose. Each rule has emojis denoting:\n\n`;
+      mdRules += `✔️ if the plugin's "recommended" configuration enables the rule\n\n`;
+      mdRules += `🔧 if problems reported by the rule are automatically fixable (\`--fix\`)\n\n`;
+      mdRules += `💡  if problems reported by the rule are manually fixable (editor)\n\n`;
       mdRules += "|  |   |   |   |  |\n";
       mdRules += "|:-:|:-:|:-:|:-:|:-|\n";
       /* eslint-disable-next-line no-unused-vars */
       Object.entries(ruleDict).forEach(([, rules]) => {
         rules.forEach(function (rule) {
           if (release) {
-            mdRules += `| ${rule.recommended} | ${rule.fixable} | ${rule.hasSuggestions} | [${rule.name}](Rules-released.md#rule-${rule.name}) | ${rule.details}|\n`;
+            mdRules += `| ${rule.recommended} | ${rule.fixable} | ${rule.hasSuggestions} | [${rule.name}](Rules-released.md#${rule.name}) | ${rule.details}|\n`;
           } else {
-            mdRules += `| ${rule.recommended} | ${rule.fixable} | ${rule.hasSuggestions} | [${rule.name}](Rules.md#rule-${rule.name}) | ${rule.details}|\n`;
+            mdRules += `| ${rule.recommended} | ${rule.fixable} | ${rule.hasSuggestions} | [${rule.name}](Rules.md#${rule.name}) | ${rule.details}|\n`;
           }
         });
       });
@@ -538,4 +522,29 @@ module.exports = {
     const listRules = listEnvRules.concat(listModelRules);
     return { rules, listRules, listEnvRules, listModelRules };
   },
+
+  populateRules: function (context, customRulesDir) {
+    const configPath = Cache.get("configpath") || "";
+    // Allow for custom rules
+    if (configPath) {
+      let customRulesPath = path.join(
+        Cache.get("configpath"),
+        customRulesDir,
+        "rules"
+      );
+      let customRulesInfo;
+      if (fs.existsSync(customRulesPath)) {
+        customRulesInfo = module.exports.getRules(customRulesPath);
+        Cache.set("rulesInfo", {
+          listEnvRules: context.listEnvRules.concat(
+            customRulesInfo.listEnvRules
+          ),
+          listModelRules: context.listModelRules.concat(
+            customRulesInfo.listModelRules
+          ),
+          listRules: context.listRules.concat(customRulesInfo.listRules),
+        });
+      }
+    }
+  },
 };

package/lib/impl/utils/validate.js

@@ -4,9 +4,8 @@
 
 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
+   * Checks whether the rule name is valid (i.e. is contained within
+   * the plugin's or user's *custom* rules).
    * @param context
    * @param pluginRules
    * @param customRules
@@ -20,35 +19,29 @@ module.exports = {
   },
 
   /**
-   * Checks whether the compiled cds model is eligible
-   * for performing the plugin's rule checks
-   * @param cds cds object
-   * @param ruleID rule name
+   * Checks whether a well-defined cds model exists
+   * @param context cds context object
    * @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"
-      )
-    ) {
+    const cds = context.cds;
+    if (cds && cds.model && !cds.model.err) {
       return true;
     }
     return false;
   },
 
   /**
-   * Checks whether the cds environment is passed
-   * @param {ContextOptions} options
+   * Checks whether a well-defined cds environment exists
+   * @param context cds context object
    * @returns
    */
-  isValidEnv: function (options) {
-    if (options[0] && options[0].environment) {
+  isValidEnv: function (context) {
+    if (
+      context.options &&
+      context.options[0] &&
+      context.options[0].environment
+    ) {
       return true;
     }
     return false;

package/package.json

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