@sap/eslint-plugin-cds 2.0.4 → 2.2.1

package/CHANGELOG.md

@@ -6,9 +6,90 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
+## [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.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.2.1] - 2021-10-29
+
+## 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
+
+- Source code is now Javascript only
+- Rule API simplified to only include report and cds
+- Added new rules `no-db-keywords` and `require-2many-oncond`
+- Filter out lint messages when run from command line with custom formatter
+
+## [2.0.5] - 2021-07-18
+
+
+### Added
+
+- When used from within VS Code ESLint exnteion, do not show environment rules
+### Changed
+
+-  Rule 'min-node-version' reverted to use cds.resolve not cds.home
 
 ## [2.0.4] - 2021-07-12
 
+
 ### Added
 
 - Plugin also considers 'outsider' files which are not part of a model
@@ -191,4 +272,4 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
 ## [1.0.0] - 2020-12-07
 
-- Initial release 1.0.0
+- Initial release 1.0.0

package/README.md

@@ -1,7 +1,6 @@
 # @sap/eslint-plugin-cds
 
 
-The [ESLint](https://eslint.org) plugin includes a set of recommended [SAP Cloud Application Programming Model (CAP)](https://cap.cloud.sap) model and environment rules.	The aim of CDS linting is to catch issues with CDS models and with the environment early.
+The [ESLint](https://eslint.org) plugin includes a set of recommended [SAP Cloud Application Programming Model (CAP)](https://cap.cloud.sap) model and environment rules.	The aim of CDS linting is to catch issues with CDS models and with the environment early. To use this module we recommend to install [@sap/cds-dk](https://www.npmjs.com/package/@sap/cds-dk) globally.
 
-
-<!-- See the [CDS Linting documentation](https://cap.cloud.sap/docs/get-started/tools/lint) for more details, or jump directly to a complete [list of rules](https://cap.cloud.sap/docs/get-started/tools/lint#rules).	CAP provides a set of recommended rules.  On top, you can create your own, application-specific rules. -->
+See the [CDS Linting documentation](https://cap.cloud.sap/docs/tools/#cds-lint) for more details, or jump directly to a complete [list of rules](https://cap.cloud.sap/docs/tools/#cds-lint-rules). CAP provides a set of recommended rules. On top, you can create your own, application-specific rules.

package/lib/api/formatter.js

@@ -1,132 +1,183 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-const path = __importStar(require("path"));
-const CLIEngine = require("eslint").CLIEngine;
-const formatter = CLIEngine.getFormatter('stylish');
-const utils_1 = require("../impl/utils");
+/**
+ * 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;
-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 === "Model Validation") {
-                rules.model.push(rule);
-                rules.recommended.push(rule);
-            }
-            else if (category === "Environment") {
-                rules.environment.push(rule);
-                rules.recommended.push(rule);
-            }
+
+let projects = Cache.getModels();
+
+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);
         }
-    });
-    return rules;
+      });
+    }
+  });
+  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);
+
+    // 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 = utils_1.Cache.getModels();
-    let file = '';
-    outputStylish.split(REGEX_NEWLINE).forEach((line) => {
-        const lineStripped = line.replace(REGEX_STRIP_ANSI, '');
-        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)) {
-            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 = utils_1.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);
-                }
-            }
+  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;
         }
-        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);
-                }
-            }
+      }
+      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.startsWith('✖') ||
-            lineStripped.includes("potentially fixable")) {
-            msgs['report'].push(line);
+      }
+    } 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);
         }
-    });
-    return msgs;
+      }
+    } 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) {
-    if (Object.keys(msgs['model']).length > 0) {
-        for (const fileModel in msgs['model']) {
-            if (msgs['model'][fileModel].length > 0) {
-                output += `${fileModel}\n`;
-                output += `${msgs['model'][fileModel].join('\n')}\n\n`;
-            }
-        }
-    }
-    if (Object.keys(msgs['environment']).length > 0) {
-        for (const fileModel in msgs['environment']) {
-            if (msgs['environment'][fileModel].length > 0) {
-                output += `${fileModel}\n`;
-                output += `${msgs['environment'][fileModel].join('\n')}\n\n`;
-            }
-        }
+  // 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`;
     }
-    if (output && msgs['report']) {
-        output += `${msgs['report'].join('\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`;
     }
-    if (output) {
-        output = `\n${output}`;
-    }
-    return output;
+  }
+  // Finally output error/warning report count
+  if (output && msgs.report) {
+    output += `${msgs.report.join("\n")}`;
+  }
+  if (output) {
+    output = `\n${output}`;
+  }
+  return output;
 }
-module.exports = function (results, data) {
-    let output = '';
-    if (!utils_1.Cache.has('err')) {
-        const outputStylish = formatter(results);
-        const rules = getPluginRules(data);
-        const msgs = splitOutput(outputStylish, rules);
-        output = formatOutput(output, msgs);
-    }
-    return output;
-};
-//# sourceMappingURL=formatter.js.map

package/lib/api/index.js

@@ -1,9 +1,22 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-var ruleFactory_1 = require("../impl/ruleFactory");
-Object.defineProperty(exports, "createRule", { enumerable: true, get: function () { return ruleFactory_1.createRule; } });
-Object.defineProperty(exports, "getRuleTester", { enumerable: true, get: function () { return ruleFactory_1.getRuleTester; } });
-var utils_1 = require("../impl/utils");
-Object.defineProperty(exports, "getConfigPath", { enumerable: true, get: function () { return utils_1.getConfigPath; } });
-Object.defineProperty(exports, "getFileExtensions", { enumerable: true, get: function () { return utils_1.getFileExtensions; } });
-//# sourceMappingURL=index.js.map
+/**
+ * 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
+ */
+
+const { createRule, defineRule, runRuleTester } = require("../impl/ruleFactory");
+const { getConfigPath } = require("../impl/utils/model");
+const { getFileExtensions } = require("../impl/utils/rules");
+const { genDocs } = require("../impl/utils/rules");
+const parserPath = require.resolve("../impl/parser");
+
+module.exports = {
+  createRule,
+  defineRule,
+  runRuleTester,
+  getConfigPath,
+  getFileExtensions,
+  genDocs,
+  parserPath,
+};

package/lib/impl/constants.js

@@ -1,49 +1,43 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Constants = void 0;
-class Constants {
-}
-exports.Constants = Constants;
-Constants.envRules = [
-    "latest-cds-version",
-    "min-node-version"
-];
-Constants.modelRules = [
-    "csn-compile-error",
-    "assocs-card-flaw",
-    "lower-camelcase-elements",
-    "sql-cast-suggestion",
-    "upper-camelcase-entities"
-];
-Constants.ruleSeverities = {
-    "csn-compile-error": 2,
-    "assocs-card-flaw": 1,
-    "latest-cds-version": 1,
-    "lower-camelcase-elements": 1,
-    "min-node-version": 2,
-    "sql-cast-suggestion": 1,
-    "upper-camelcase-entities": 1
+/**
+ * This file contains all constants for:
+ * - categories: The category labels we use to for model and environment rules
+ * - customRulesDir: The custom rules directory name in the user's project home
+ *                   which contains the subdirs 'docs', 'rules' and 'tests'
+ * - recommended: The set of this plugin's recommended rules and their severities
+ * - globals: The globals which should be exposed to ESLint by this plugin
+ * - files: Any additional file extensions which ESLint should lint
+ */
+
+module.exports = {
+  categories: {
+    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-db-keywords": 2,
+    "@sap/cds/require-2many-oncond": 2,
+    "@sap/cds/sql-cast-suggestion": 1
+  },
+
+  globals: {
+    SELECT: true,
+    INSERT: true,
+    UPDATE: true,
+    DELETE: true,
+    CREATE: true,
+    DROP: true,
+    CDL: true,
+    CQL: true,
+    CXL: true,
+    cds: true,
+  },
+
+  files: ["*.cds", "*.csn"],
+
 };
-Constants.globals = {
-    "SELECT": true,
-    "INSERT": true,
-    "UPDATE": true,
-    "DELETE": true,
-    "CREATE": true,
-    "DROP": true,
-    "CDL": true,
-    "CQL": true,
-    "CXL": true,
-    "cds": true
-};
-Constants.overrides = [
-    {
-        "files": ["*.cds", "*.csn"],
-        "parser": "./parser",
-        "parserOptions": {
-            "ecmaVersion": 2019,
-            "sourceType": "module"
-        }
-    }
-];
-//# sourceMappingURL=constants.js.map

package/lib/impl/index.js

@@ -1,51 +1,58 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.configs = exports.globals = exports.rules = void 0;
-const utils_1 = require("./utils");
-const constants_1 = require("./constants");
-const csn_compile_error_1 = __importDefault(require("./rules/csn-compile-error"));
-const assocs_card_flaw_1 = __importDefault(require("./rules/assocs-card-flaw"));
-const latest_cds_version_1 = __importDefault(require("./rules/latest-cds-version"));
-const lower_camelcase_elements_1 = __importDefault(require("./rules/lower-camelcase-elements"));
-const min_node_version_1 = __importDefault(require("./rules/min-node-version"));
-const sql_cast_suggestion_1 = __importDefault(require("./rules/sql-cast-suggestion"));
-const upper_camelcase_entities_1 = __importDefault(require("./rules/upper-camelcase-entities"));
-const rules = {
-    "csn-compile-error": csn_compile_error_1.default,
-    "assocs-card-flaw": assocs_card_flaw_1.default,
-    "latest-cds-version": latest_cds_version_1.default,
-    "lower-camelcase-elements": lower_camelcase_elements_1.default,
-    "min-node-version": min_node_version_1.default,
-    "sql-cast-suggestion": sql_cast_suggestion_1.default,
-    "upper-camelcase-entities": upper_camelcase_entities_1.default
-};
-exports.rules = rules;
-const envRules = utils_1.getRules(constants_1.Constants.envRules, constants_1.Constants.ruleSeverities);
-const modelRules = utils_1.getRules(constants_1.Constants.modelRules, constants_1.Constants.ruleSeverities);
-const recRules = Object.assign({}, modelRules, utils_1.getRules([
-    "min-node-version"
-], constants_1.Constants.ruleSeverities));
-const configs = {
-    "recommended": {
-        "plugins": ["@sap/eslint-plugin-cds"],
-        "overrides": constants_1.Constants.overrides,
-        "rules": recRules
-    },
-    "model": {
-        "plugins": ["@sap/eslint-plugin-cds"],
-        "overrides": constants_1.Constants.overrides,
-        "rules": modelRules
+/**
+ * Custom ESLint plugin:
+ * https://eslint.org/docs/developer-guide/working-with-plugins
+ * This file exposes our plugins ESLint configuration, which must:
+ * - Expose any 'configs' for prescribed rule configuration bundles
+ *     (i.e. "recommended"). See shareable configs:
+ *     https://eslint.org/docs/developer-guide/shareable-configs
+ * - Expose any 'globals' for use in ESLint
+ * - Expose any 'processors' for use in ESLint
+ * - Expose any 'rules' for use in ESLint
+ * We also initiate and cache the objects 'rulesInfo' and 'cds' for later use.
+ */
+
+const path = require("path");
+const processor = require("./processor");
+const plugin = require("../../package.json").name;
+
+const { getRules } = require("../impl/utils/rules");
+const {
+  Cache,
+  getCDSProxy,
+  getLocation,
+  getRange,
+} = require("../impl/utils/model");
+const { files, globals, recommended } = require("./constants");
+
+const cds = require("@sap/cds");
+cds.getLocation = getLocation;
+cds.getRange = getRange;
+Cache.set("cds", getCDSProxy(cds));
+
+let rulesInfo;
+if (!Cache.has("rulesInfo")) {
+  rulesInfo = getRules(path.join(__dirname, "rules"));
+  Cache.set("rulesInfo", rulesInfo);
+} else {
+  rulesInfo = Cache.get("rulesInfo");
+}
+
+module.exports = {
+  configs: {
+    recommended: {
+      globals,
+      plugins: [plugin],
+      overrides: [
+        {
+          files: files,
+          processor: "@sap/cds/cds",
+        },
+      ],
+      rules: recommended,
     },
-    "environment": {
-        "plugins": ["@sap/eslint-plugin-cds"],
-        "overrides": constants_1.Constants.overrides,
-        "rules": envRules
-    }
+  },
+  processors: {
+    cds: processor,
+  },
+  rules: rulesInfo.rules,
 };
-exports.configs = configs;
-const globals = constants_1.Constants.globals;
-exports.globals = globals;
-//# sourceMappingURL=index.js.map