@sap/eslint-plugin-cds 2.1.1 → 2.3.2

package/lib/impl/utils/validate.js

@@ -0,0 +1,52 @@
+/**
+ * @typedef { import("eslint").Rule.RuleContext.options } ContextOptions
+ */
+
+module.exports = {
+  /**
+   * 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
+   * @returns
+   */
+  isValidRule: function (context, rules) {
+    if (rules.includes(context.ruleID.replace("@sap/cds/", ""))) {
+      return true;
+    }
+    return false;
+  },
+
+  /**
+   * Checks whether a cds model is error-free
+   * @param context cds context object
+   * @returns
+   */
+  isValidModel: function (context) {
+    const cds = context.cds;
+    if (cds) {
+      if (cds.model) {
+        return !cds.model.err;
+      }
+      return true;  // allow no model
+    }
+    return false;
+  },
+
+  /**
+   * Checks whether a well-defined cds environment exists
+   * @param context cds context object
+   * @returns
+   */
+  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.1.1",
+  "version": "2.3.2",
   "description": "ESLint plugin including recommended SAP Cloud Application Programming model and environment rules",
   "homepage": "https://cap.cloud.sap/",
   "keywords": [
@@ -20,7 +20,7 @@
     "README.md"
   ],
   "dependencies": {
-    "@sap/cds": "^5.0.0",
+    "@sap/cds": "^5.6.0",
     "semver": "^7.3.4"
   },
   "peerDependencies": {

package/lib/api/formatter.js

@@ -1,205 +0,0 @@
-/**
- * Custom ESLint formatter:
- * https://eslint.org/docs/developer-guide/working-with-custom-formatters
- * Here, we take the ESLint.LintResult[] and format it into ESLint's standard (stylish) error report.
- * Then, we adapt it to report environment errors:
- * - Separately from model errors
- * - Report them within a project scope but independent of a specific file within that scope
- */
-const fs = require("fs");
-const path = require("path");
-const { CLIEngine } = require("eslint")
-// Note: CliEngine depracted, but new Node API requires
-// async Linter framework
-const formatter = CLIEngine.getFormatter("stylish");
-const { Cache } = require("../impl/utils/model");
-const { styleText, isEditor, isTest } = require("../impl/utils/helpers");
-
-const CONSTANTS = require("../impl/constants");
-
-// 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 ruleIDs from custom rules
-  const customRules = [];
-  projects.forEach((project) => {
-    const customRulesPath = path.resolve(project, CONSTANTS.customRulesDir, 'rules');
-    if (fs.existsSync(customRulesPath)) {
-      fs.readdirSync(customRulesPath).forEach((customRule) => {
-        const ruleID = path.basename(customRule, '.js');
-        if (!customRules.includes(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);
-      //   }
-      // })
-    }
-    // Get standard ESLint 'stylish' output
-    const outputStylish = formatter(results);
-
-    // Split according to category
-    const msgs = splitOutput(outputStylish, rules);
-
-    // Format new CDSLint output
-    output = formatOutput(output, msgs);
-  }
-  return output;
-};
-
-/**
- * Splits rules by config and category
- * @param data Rules meta data
- * @returns rules object based on category
- */
-function getPluginRules (data) {
-  const rules = { environment: [], model: [], recommended: [] };
-  Object.keys(data.rulesMeta).forEach((rule) => {
-    if (data.rulesMeta[rule]) {
-      const category = data.rulesMeta[rule].docs.category;
-      if (category === CONSTANTS.categories.model) {
-        rules.model.push(rule);
-        rules.recommended.push(rule);
-      } else if (category === CONSTANTS.categories.env) {
-        rules.environment.push(rule);
-        rules.recommended.push(rule);
-      }
-    }
-  });
-  return rules;
-}
-
-/**
- * Obtains ESLint's standard (*stylish*) output, then splits and reccollects error messages
- * based on rule category and content type (msg vs. error count/report)
- * @param outputStylish ESLint's standard output
- * @param rules Plugin rules based on category
- * @returns Collected msgs
- */
-function splitOutput (outputStylish, rules) {
-  const msgs = { environment: {}, model: {}, report: [] };
-  let projects = Cache.getModels();
-  let file = "";
-  outputStylish.split(REGEX_NEWLINE).forEach((line) => {
-    const lineStripped = line.replace(REGEX_STRIP_ANSI, "");
-    // Collect model file (default)
-    const lineStrippedSplit = lineStripped.split(" ");
-    const rule = lineStrippedSplit[lineStrippedSplit.length - 1];
-    if (
-      !lineStripped.startsWith(" ") &&
-      !rules.recommended.includes(rule) &&
-      !lineStripped.startsWith("✖")
-    ) {
-      file = line;
-      if (
-        process.argv[1].includes("jest") ||
-        process.argv[1].includes("mocha")
-      ) {
-        projects = [path.dirname(lineStripped)];
-      }
-    } else if (rules.environment.includes(rule)) {
-      // Collect error/warning messages from @sap/cds/ rules
-      const delimiter = line.split(/  +/, 2)[1];
-      const lineWithoutLocation = line.split(delimiter)[1];
-      let project = "";
-      for (let i = 0; i < projects.length; i++) {
-        project = projects[i];
-        if (file.includes(project)) {
-          project = styleText(project, ["link"]);
-          break;
-        }
-      }
-      if (project) {
-        if (!Object.keys(msgs.environment).includes(project)) {
-          msgs.environment[project] = [lineWithoutLocation];
-        } else if (
-          !msgs.environment[project].includes(lineWithoutLocation)
-        ) {
-          msgs.environment[project].push(lineWithoutLocation);
-        }
-      }
-    } else if (
-      lineStripped &&
-      !rules.environment.includes(rule) &&
-      !lineStripped.includes("potentially fixable") &&
-      !lineStripped.startsWith("✖")
-    ) {
-      if (lineStripped) {
-        if (!msgs.model[file]) {
-          msgs.model[file] = [line];
-        } else {
-          msgs.model[file].push(line);
-        }
-      }
-    } else if (
-      lineStripped.startsWith("✖") ||
-      lineStripped.includes("potentially fixable")
-    ) {
-      msgs.report.push(line);
-    }
-  });
-  return msgs;
-}
-
-/**
- * Takes the collected error messages and collects them
- * in a final string for ESLint to output
- * @param output final string to output
- * @param msgs error messages based on category
- * @returns
- */
-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) {
-      output += `${fileModel}\n`;
-      output += `${msgs.model[fileModel].join("\n")}\n\n`;
-    }
-  }
-  // Next, output env msgs (file-independent but associated to project)
-  for (const fileModel in msgs.environment) {
-    if (msgs.environment[fileModel].length > 0) {
-      output += `${fileModel}\n`;
-      output += `${msgs.environment[fileModel].join("\n")}\n\n`;
-    }
-  }
-  // Finally output error/warning report count
-  if (output && msgs.report) {
-    output += `${msgs.report.join("\n")}`;
-  }
-  if (output) {
-    output = `\n${output}`;
-  }
-  return output;
-}

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}}",
-});