@sap/eslint-plugin-cds 2.2.1 → 2.2.2

package/CHANGELOG.md

@@ -68,6 +68,45 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
 - Added preprocessor to avoid (other plugins) parsing errors on cds files
 
+## [2.2.2] - 2021-11-08
+
+## Added
+
+- Added new rule 'no-join-on-draft-enabled-entities'
+
+## Changed
+
+- Compile 'model' files based on CSN flavor 'inferred'
+- Compile 'outsider' files based on CSN flavor 'parsed'
+
+## [2.2.1] - 2021-11-01
+
+## 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
+
+- Added preprocessor to avoid (other plugins) parsing errors on cds files
+
 ## [2.1.0] - 2021-09-23
 
 ## Changed

package/lib/api/formatter.js

@@ -6,178 +6,177 @@
  * - 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 fs = require("fs");
+ const path = require("path");
+ const formatter = require("eslint/lib/cli-engine/formatters/stylish");
 
-const CONSTANTS = require("../impl/constants");
+ const { Cache } = require("../impl/utils/model");
+ const { styleText, isEditor } = require("../impl/utils/helpers");
 
-/* 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;
+ 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();
+ let projects = Cache.get('configpaths') || [];
 
-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)
-        );
-      });
-    }
-    // Get standard ESLint 'stylish' output
-    const outputStylish = formatter(results);
+ 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()) {
+       results.forEach((result) => {
+         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);
 
-    // Split according to category
-    const msgs = splitOutput(outputStylish, rules);
+     // Split according to category
+     const msgs = splitOutput(outputStylish, rules);
 
-    // Format new CDSLint output
-    output = formatOutput(output, msgs);
-  }
-  return output;
-};
+     // 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;
-}
+ /**
+  * 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;
-}
+ /**
+  * 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 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;
-}
+ /**
+  * 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}`;
+     if (Cache.has('linted')) {
+       output += `\n\nTotal files linted: ${Cache.get('linted').files.length}\n`;
+     }
+   }
+   return output;
+ }

package/lib/api/index.js

@@ -1,13 +1,18 @@
 /**
  * Our custom ESLint plugin API should:
- * - 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
+ * - Expose 'createRule', 'defineRule' (experimental) and 'runRuleTester' to
+ *   support the addition of *custom* CDS Lint 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 { createRule, defineRule, runRuleTester } = require("../impl/ruleFactory");
+const {
+  createRule,
+  defineRule,
+  runRuleTester,
+} = require("../impl/ruleFactory");
 const { getConfigPath } = require("../impl/utils/model");
-const { getFileExtensions } = require("../impl/utils/rules");
+const { getFileExtensions } = require("../impl/utils/helpers");
 const { genDocs } = require("../impl/utils/rules");
 const parserPath = require.resolve("../impl/parser");
 

package/lib/impl/constants.js

@@ -13,18 +13,16 @@ module.exports = {
     env: "Environment",
     model: "Model Validation",
   },
-
   customRulesDir: ".eslint",
-
   recommended: {
     "@sap/cds/assoc2many-ambiguous-key": 1,
     "@sap/cds/cds-compile-error": 2,
     "@sap/cds/min-node-version": 2,
+    "@sap/cds/no-join-on-draft-enabled-entities": 1,
     "@sap/cds/no-db-keywords": 2,
     "@sap/cds/require-2many-oncond": 2,
-    "@sap/cds/sql-cast-suggestion": 1
+    "@sap/cds/sql-cast-suggestion": 1,
   },
-
   globals: {
     SELECT: true,
     INSERT: true,
@@ -37,7 +35,6 @@ module.exports = {
     CXL: true,
     cds: true,
   },
-
   files: ["*.cds", "*.csn"],
-
+  modelFiles: ["*.cds", "*.csn"],
 };

package/lib/impl/processor.js

@@ -2,11 +2,11 @@
  * 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 
+ * 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).  
+ * later on (ruleFactory).
  */
 
 const { Cache } = require("./utils/model");
@@ -15,7 +15,7 @@ const { isValidFile } = require("./utils/helpers");
 module.exports = {
   preprocess: function (text, filename) {
     if (isValidFile(filename)) {
-      Cache.set(`processed:${filename}`, text);
+      Cache.set(`file:${filename}`, text);
     }
     return [{ text: "", filename }];
   },