@sap/eslint-plugin-cds 2.3.0 → 2.3.2

package/CHANGELOG.md

@@ -6,60 +6,75 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
+## [2.3.2] - 2022-01-24
 
-## [2.3.0] - 201-12-03
+### Changed
+
+- Rule `require-2many-oncond` now also detect navigations of aaspects for flavor 'parsed'
+- Removed duplicates from rule results of category 'Environment'
+
+## [2.3.1] - 2021-12-10
+
+### Changed
 
-## Added
+- Removed custom formatter as it is no longer used by `cds lint`.
+- Deduplicate lint results from from rules of category environment.
+- Removed 'unpeploy.json' from files as no lint rule requires it
+- Fixed redundant triggers of model recompilations for non-model files and model files without changes
+
+## [2.3.0] - 2021-12-03
+
+### Added
 
 - Added new rule 'valid-csv-header'
 
-## Changed
+### Changed
 
 - Fixed suggestion messages in editor option (and disabled auto-fix)
 - Added rule properties 'docs.recommended', 'severity'
 
 ## [2.2.2] - 2021-11-08
 
-## Added
+### Added
 
 - Added new rule 'no-join-on-draft-enabled-entities'
 
-## Changed
+### Changed
 
 - Compile 'model' files based on CSN flavor 'inferred'
 - Compile 'outsider' files based on CSN flavor 'parsed'
 
 ## [2.2.1] - 2021-11-01
 
-## Changed
+### Changed
 
 - Optimized model loading and fixed bug in loading of 'outsider' files
 
 ## [2.2.0] - 2021-10-29
 
-## Added
+### Added
 
 - Added typings to javascript for all exposed apis
 
-## Changed
+### Changed
 
 - Aligned rule creation and tester api with ESLint
 
 ## [2.1.2] - 2021-10-05
 
-## Changed
+### 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
+### Changed
 
 - Added preprocessor to avoid (other plugins) parsing errors on cds files
 
 ## [2.1.0] - 2021-09-23
 
-## Changed
+### Changed
 
 - Source code is now Javascript only
 - Rule API simplified to only include report and cds

package/lib/impl/constants.js

@@ -25,6 +25,6 @@ module.exports = {
     CXL: true,
     cds: true,
   },
-  files: ["*.cds", "*.csn", "*.csv", "undeploy.json"],
+  files: ["*.cds", "*.csn", "*.csv"],
   modelFiles: ["*.cds", "*.csn"],
 };

package/lib/impl/ruleFactory.js

@@ -179,7 +179,9 @@ function getProxyReport(obj) {
                   start: { line: 0, column: -1 },
                   end: { line: 0, column: -1 },
                 };
-                report = true;
+                if (!seenReport(lint, thisArg.ruleID)) {
+                  report = true;
+                }
                 // Only show 'model' lints at corrsponding file
               } else if (
                 fileAbs === thisArg.filePath ||
@@ -199,6 +201,23 @@ function getProxyReport(obj) {
   return new Proxy(obj, handler);
 }
 
+function seenReport(msg, ruleID) {
+  let seenReports = [];
+  if (Cache.has("reports")) {
+    seenReports = Cache.get("reports");
+  }
+  const lintString = `configpath:${Cache.get('configpath')}|rule:${ruleID}|` +
+    `message:${msg.message}|` +
+    `loc:${msg.loc.start.line},${msg.loc.start.column}-${msg.loc.end.line},${msg.loc.end.column}`;
+  if (!seenReports.includes(lintString)) {
+    seenReports.push(lintString);
+    Cache.set("reports", seenReports);
+    return false;
+  } else {
+    return true;
+  }
+}
+
 /**
  * Expands CDS context object with some CDS properties
  * We also retrieve the file contents cached by the preprocessor

package/lib/impl/rules/require-2many-oncond.js

@@ -16,7 +16,7 @@ module.exports = require("../../api").createRule({
         if (!d.elements) return;
         for (const elementName in d.elements) {
           const element = d.elements[elementName];
-          if (element.is2many && !element.on) {
+          if (element.is2many && !element.on && typeof element.target === 'string') {
             const loc = context.cds.getLocation(elementName, element);
             context.report({
               message: `You must provide an \`ON\` condition for \`TO MANY\` relationship '${element.name}'.`,

package/lib/impl/utils/model.js

@@ -104,6 +104,7 @@ module.exports = {
 
     if (
       process.env["LINT_FLAVOR"] !== "parsed" &&
+      isValidFile(context.filePath, "model") &&
       (module.exports.isNewFile(context.filePath) ||
         module.exports.isNewConfigPath(context.configPath))
     ) {
@@ -148,22 +149,12 @@ module.exports = {
   isNewConfigPath: function (configPath) {
     let update = false;
     if (
-      !module.exports.Cache.has("pluginpath") ||
+      !module.exports.Cache.has("pluginpath") &&
       !module.exports.Cache.has("configpath") ||
       configPath !== module.exports.Cache.get("configpath")
     ) {
       update = true;
     }
-    // Keep track of all config paths visited
-    // - Used in formatter to group lint reports
-    // - Dirnames are used to assign any 'env' lints
-    if (!module.exports.Cache.has("configpaths")) {
-      module.exports.Cache.set("configpaths", [configPath]);
-    } else {
-      const configPaths = module.exports.Cache.get("configpaths");
-      configPaths.push(configPath);
-      module.exports.Cache.set("configpaths", configPaths);
-    }
     return update;
   },
 
@@ -421,6 +412,9 @@ module.exports = {
       files = reflectedModel.$sources;
       if (files) {
         module.exports.Cache.set(`modelfiles:${configPath}`, files);
+        files.forEach(file => {
+          module.exports.Cache.set(`model:${file}`, reflectedModel);
+        })
       } else {
         files = [];
       }

package/lib/impl/utils/rules.js

@@ -353,7 +353,7 @@ module.exports = {
    * @param {string} projectPath
    * @param {string} customRulesDir
    */
-  async genDocs(projectPath, customRulesDir, registry) {
+  async genDocs(projectPath, customRulesDir, registry, prepareRelease = false) {
     let docsPath, rulePath, testPath, release;
 
     if (!projectPath) {
@@ -380,14 +380,31 @@ module.exports = {
 
     if (registry) {
       // Get rules (internal on artifactory)
-      const versionInternal = module.exports.getPackageVersion(registry);
+      let versionInternal;
+      if (!prepareRelease) {
+        versionInternal = module.exports.getPackageVersion(registry);
+      } else {
+        versionInternal = JSON.parse(
+          fs.readFileSync(path.join(__dirname, "../../../package.json"))
+        ).version;
+      }
       if (versionInternal) {
+        console.log(`Updating internal rules from v>=${versionInternal}:\n${registry}\n`);
         const ruleDictInternal = module.exports.getRuleDict(docsPath, rulePath, testPath, versionInternal);
         module.exports.genDocFiles(ruleDictInternal, docsPath);
       }
       // Get rules released (external on npm)
-      const versionExternal = module.exports.getPackageVersion("https://registry.npmjs.org");
+      const npmRegistry = "https://registry.npmjs.org";
+      let versionExternal;
+      if (!prepareRelease) {
+        versionExternal = module.exports.getPackageVersion(npmRegistry);
+      } else {
+        versionExternal = JSON.parse(
+          fs.readFileSync(path.join(__dirname, "../../../package.json"))
+        ).version;
+      }
       if (versionExternal) {
+        console.log(`Updating external rules from v>=${versionExternal}:\n${npmRegistry}\n`);
         const ruleDictExternal = module.exports.getRuleDict(docsPath, rulePath, testPath, versionExternal, release);
         module.exports.genDocFiles(ruleDictExternal, docsPath, release);
       }
@@ -396,6 +413,7 @@ module.exports = {
       const ruleDict = module.exports.getRuleDict(docsPath, rulePath, testPath);
       module.exports.genDocFiles(ruleDict, docsPath);
     }
+    console.log('Done!')
   },
 
   getRuleDict: function (docsPath, rulePath, testPath, versionRequired='0.0.0', release=false) {
@@ -423,6 +441,7 @@ module.exports = {
             let underConstruction = "";
             if (!release && semver.satisfies(version, `>${versionRequired}`)) {
               underConstruction = "🚧";
+              console.log(`  > 🚧 Rule '${rule}' still under construction.\n`)
             }
 
             let isFixable = "";

package/package.json

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

package/lib/api/formatter.js

@@ -1,182 +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 formatter = require("eslint/lib/cli-engine/formatters/stylish");
-
- const { Cache } = require("../impl/utils/model");
- const { styleText, isEditor } = 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.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()) {
-       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);
-
-     // 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 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}`;
-     if (Cache.has('linted')) {
-       output += `\n\nTotal files linted: ${Cache.get('linted').files.length}\n`;
-     }
-   }
-   return output;
- }