@sap/eslint-plugin-cds 2.3.2 → 2.3.3

package/CHANGELOG.md

@@ -6,6 +6,14 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
+## [2.3.3] - 2022-03-24
+
+### Added
+
+- Added new rule `no-dollar-prefixed-names`
+- Lint reports with rules marked with '!' notify of rule compile errors
+- Lint reports of any thrown errors can be exposed by `--debug` (includes stack)
+
 ## [2.3.2] - 2022-01-24
 
 ### Changed
@@ -34,7 +42,6 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/).
 - Added rule properties 'docs.recommended', 'severity'
 
 ## [2.2.2] - 2021-11-08
-
 ### Added
 
 - Added new rule 'no-join-on-draft-enabled-entities'
@@ -45,13 +52,11 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/).
 - 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
@@ -61,19 +66,16 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/).
 - 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
@@ -82,8 +84,6 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/).
 - 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
@@ -92,8 +92,6 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/).
 -  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
@@ -102,21 +100,16 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/).
 - Custom formatter now prints projectPath for triggered env rule checks
 
 ## [2.0.3] - 20210-07-09
-
 ### Changed
 
 - Removed `npm-shrinkwrap.json` file from package
 
 ## [2.0.2] - 2021-07-07
-
-
 ### Changed
 
 - Fixed bug that always triggers csn-compile-err on type
 
 ## [2.0.1] - 2021-07-06
-
-
 ### Added
 
 - Re-added model rule 'csn-compile-err' to pass csn compile errors to eslint for readability
@@ -126,8 +119,6 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/).
 - Formatter ignores all lint reports for other file extensions except for those in plugin overrides files
 
 ## [2.0.0] - 2021-07-02
-
-
 ### Added
 
 - New API: split exports into 'impl' (for eslint) and 'api' (for user)
@@ -138,15 +129,11 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/).
 - API: getRuleTester now erquires relative path from ruleTester location to project root
 
 ## [1.1.7] - 2021-06-22
-
-
 ### Changed
 
 - Load/Update model must be in sync with every 'on-type' event
 
 ## [1.1.6] - 2021-06-21
-
-
 ### Changed
 
 - Formatter no longer has explicit dependencies, only reslies on 'stylish' output
@@ -155,26 +142,20 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/).
 - On glob file expressions, gets multiple models in series and reports on all warnings/errors
 
 ## [1.1.5] - 2021-05-26
-
+### Changed
 
 - Naming convention rules changed to severity 'warning'
 - Rules of type 'suggestion' must return 'fix' for appliable multipass fixes
 - Split model generation into load and update to be able to work on all files
 
 ## [1.1.4] - 2021-05-20
-
-
 ### Changed
 
 - Formatter does not show any (env/other) lint messages on model error
 - Rule lower-camelcase-elements reverted to also check type keys
 - Rule lower-camelcase-elements is not triggered by element 'ID' (see Bookshop in CAP samples)
 
-
 ## [1.1.3] - 2021-05-12
-
-
-
 ### Changed
 
 - Changed rule type for naming convention rules to "suggestion"
@@ -182,16 +163,12 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/).
 - Added extra layer to also support ruleTester "environment" checks
 
 ## [1.1.2] - 2021-05-05
-
-
 ### Changed
 
 - Updated all rules to ingest args: (cds, context)
 - Use context's sourcecode to get correct range indices for fixers
 
 ## [1.1.1] - 2021-05-04
-
-
 ### Changed
 
 - Removed bulky headers from custom formatter
@@ -201,8 +178,6 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/).
 - Fixed formatter to also print any other ESLint messages received
 
 ## [1.1.0] - 2021-04-29
-
-
 ### Added
 
 - Custom cds formatter for separate reporting of env and model checks
@@ -211,25 +186,19 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
 - Fixed version of model rule 'sql-cast-suggestion'
 
-
 ## [1.0.8] - 2021-04-12
-
-
 ### Added
 
 - Proxy for cds object replaces fragile object clone from before
 - Added proper typings and ignore where options should remain invisible to the (cds) api
 - Added docstrings and header to each file to explain ESLint context
 - Added model rule 'sql-cast-suggestion'
-
 ## [1.0.7] - 2021-04-01
-
-### Fixed
+### Changed
 
 - Do not crash if `parserServices.cds` is not available
 
 ## [1.0.6] - 2021-04-01
-
 ### Added
 
 - peer dependency to `eslint`
@@ -237,7 +206,6 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/).
 - simplified api, cds instead of parserServices
 
 ## [1.0.4] - 2021-03-24
-
 ### Changed
 
 - Added sync model load from cds to generate fully resolved models
@@ -246,25 +214,19 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/).
 - Removed model rule 'no-entity-moo' and use as sample custom rule in docs
 - Refactored and added more parserServices
 
-
 ## [1.0.3] - 2021-01-22
-
 ### Changed
 
 - Fixed rule min-node-version to check if cds dependency is installed
 - Updated README glob statement to double asterisk for check nested dirs
 
-
 ## [1.0.2] - 2021-01-21
-
 ### Changed
 
 - Fixed rules to work in concert and allow for globs
 - Improved README for better readability
 
-
 ## [1.0.1] - 2021-01-19
-
 ### Added
 
 - Rule `assocs-card-flaw` in category *Model validation*
@@ -273,7 +235,6 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
 - Refactoring of ruleFactory and parser code
 
-
 ## [1.0.0] - 2020-12-07
-
+### Added
 - Initial release 1.0.0

package/lib/api/index.js

@@ -1,24 +1,22 @@
+"use strict";
+
 /**
  * Our custom ESLint plugin API should:
- * - 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 'createRule' and 'runRuleTester' to
+ *   support the addition of *custom* CDS Lint rules at runtime
+ * - Expose 'getConfigPath', 'getFileExtensions', and 'genDocs' for usage in
+ *   'cds lint' client (@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/helpers");
-const { genDocs } = require("../impl/utils/rules");
-const parserPath = require.resolve("../impl/parser");
+const { runRuleTester } = require("../utils/ruleTester")
+const { getConfigPath } = require("../utils/model");
+const { getFileExtensions } = require("../utils/helpers");
+const { createRule, genDocs } = require("../utils/rules");
+const parserPath = require.resolve("../parser");
 
 module.exports = {
   createRule,
-  defineRule,
   runRuleTester,
   getConfigPath,
   getFileExtensions,

package/lib/api/lint.d.ts

@@ -0,0 +1,48 @@
+
+import { Linter, Rule, RuleTester, SourceCode } from "eslint";
+
+export interface CDSRuleContext extends Rule.RuleContext {
+    cds: any;
+    configPath: string;
+    code: string;
+    filePath: string;
+    options: [];
+    id: string;
+    sourcecode: SourceCode;
+    report: (CDSRuleReport) => void;
+    err: Error;
+}
+
+export interface CDSRuleSpec {
+    meta: CDSRuleMetaData,
+    create: (context: CDSRuleContext) => void;
+}
+
+export interface CDSRuleMetaData extends Rule.RuleMetaData {
+    docs: Rule.RuleMetaData['docs'] & {
+        version: string;
+    };
+    severity?: Linter.RuleLevel;
+}
+
+export type CDSRuleReport = Rule.ReportDescriptor & {
+    loc?: Rule.ReportDescriptorLocation;
+    file?: string;
+};
+
+export interface CDSTestCaseError extends RuleTester.TestCaseError {
+    message: string | RegExp;
+}
+
+export interface CDSRuleTestOpts {
+    /** specifies __dirname */
+    root: string;
+    /** requires your rule .js here */
+    rule?: string;
+    /** filename ('schema.cds' for model, 'package.json' for env) */
+    filename: string;
+    /** resolves cds parser path */
+    parser?: string;
+    /** list of errors from ESLint's [RuleTester](https://eslint.org/docs/developer-guide/nodejs-api#ruletester) */
+    errors: CDSTestCaseError[]
+}

package/lib/constants.js

@@ -0,0 +1,54 @@
+/**
+ * This file is used to store/share any constants for this plugin:
+ * - RULE_CATEGORIES:       List of plugin's rule categories (used purely as documentation labels)
+ * - DEFAULT_RULE_CATEGORY: Default rule category (must be one of plugin's rule categories)
+ * - DEFAULT_RULE_SEVERITY: Default rule severity (must be one of those define by ESLint):
+ *                          https://eslint.org/docs/user-guide/configuring/rules#configuring-rules
+ * - DEFAULT_RULE_TYPE:     Default rule type (must be one of those defined by ESLint):
+ *                          https://eslint.org/docs/developer-guide/working-with-rules#rule-basics
+ * - CUSTOM_RULES_DIR:      Custom rules directory name in the user's project home
+ *                          (contains rules, docs, tests)
+ * - FILES:                 Files/file extensions which ESLint should lint with this plugin
+ * - MODEL_FILES:           Files/file extensions which should can be compiled (to CSN)
+ * - GLOBALS:               Globals which should be exposed to ESLint by this plugin
+ */
+
+const RULE_CATEGORIES = ["Model Validation", "Environment"];
+const DEFAULT_RULE_CATEGORY = RULE_CATEGORIES[0];
+const DEFAULT_RULE_SEVERITY = "error";
+const DEFAULT_RULE_TYPE = "problem";
+
+const PLUGIN_NAME = require("../package.json").name;
+const PLUGIN_PREFIX = "@sap/cds";
+const PROCESSOR_NAME = `${PLUGIN_PREFIX}/cds`
+const CUSTOM_RULES_DIR = ".cdslint";
+
+const FILES = ["*.cds", "*.csn", "*.csv"];
+const MODEL_FILES = ["*.cds", "*.csn"];
+
+const GLOBALS = {
+  SELECT: true,
+  INSERT: true,
+  UPDATE: true,
+  DELETE: true,
+  CREATE: true,
+  DROP: true,
+  CDL: true,
+  CQL: true,
+  CXL: true,
+  cds: true,
+};
+
+module.exports = {
+  RULE_CATEGORIES,
+  DEFAULT_RULE_CATEGORY,
+  DEFAULT_RULE_SEVERITY,
+  DEFAULT_RULE_TYPE,
+  PLUGIN_NAME,
+  PLUGIN_PREFIX,
+  PROCESSOR_NAME,
+  CUSTOM_RULES_DIR,
+  FILES,
+  MODEL_FILES,
+  GLOBALS
+};

package/lib/index.js

@@ -0,0 +1,44 @@
+/**
+ * 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
+ */
+
+const path = require("path");
+const processor = require("./processor");
+
+const { FILES, GLOBALS, PLUGIN_NAME, PROCESSOR_NAME } = require("./constants");
+const { getRules } = require("./utils/rules");
+
+const rules = getRules(path.join(__dirname, "rules"));
+
+function _getConfig(configName) {
+    return {
+        globals: GLOBALS,
+        plugins: [PLUGIN_NAME],
+        overrides: [
+            {
+                files: FILES,
+                processor: PROCESSOR_NAME,
+            },
+        ],
+        rules: rules[configName],
+    };
+}
+
+module.exports = {
+    configs: {
+        recommended: _getConfig("recommended"),
+        all: _getConfig("all"),
+    },
+    processors: {
+        cds: processor,
+    },
+    rules: rules.sources,
+};

package/lib/{impl/parser.js → parser.js}

@@ -9,14 +9,7 @@
  * (parserOptions). Note, that because we use a 'empty' preprocessor, the
  * parser is only used by ESLint's ruleTester.
  */
-
-const {
-  getAST,
-  getCDSProxy,
-  getLocation,
-  getRange,
-} = require("../impl/utils/model");
-const cds = require("@sap/cds");
+ const { getAST } = require("./utils/model");
 
 module.exports = {
   parse: function (code, options) {
@@ -24,13 +17,9 @@ module.exports = {
   },
 
   parseForESLint: function (code) {
-    cds.getLocation = getLocation;
-    cds.getRange = getRange;
     return {
       ast: getAST(code),
-      services: {
-        cdsProxy: getCDSProxy(cds),
-      },
+      services: {},
       scopeManager: null,
       tokensAndComments: [],
       visitorKeys: null,

package/lib/processor.js

@@ -0,0 +1,47 @@
+/**
+ * Custom ESLint 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
+ * read the new file types exposed via globs.
+ * 
+ * Note, that because we cache the file contents and return files contents,
+ * the plugin's parser is bypassed so we must retrieve the file contents (see createRule()
+ * in utils/rules.js).
+ */
+
+const { Cache } = require("./utils/model");
+const { isValidFile } = require("./utils/helpers");
+
+module.exports = {
+  preprocess: function (text, filename) {
+    if (isValidFile(filename, 'FILES')) {
+      Cache.set(`file:${filename}`, text);
+    }
+    return [{ text: "", filename }];
+  },
+  /**
+   * Returns message objects as defined by ESLint:
+   * https://eslint.org/docs/developer-guide/working-with-custom-formatters#the-message-object
+   * @param {*} messages 
+   * @returns 
+   */
+  postprocess: function (messages) {
+    const messagesSanitized = [];
+    messages.forEach(fileMessages => {
+      const fileMessagesSanitized = [];
+      fileMessages.forEach(r => {
+        if (r.message.startsWith(`CompilationError:`)) {
+          r.message = r.message.replace(`CompilationError: `,
+            'CDS model could not be compiled!\n');
+          r.ruleId = `❗${r.ruleId}`;
+          r.severity = 2;
+        }
+        fileMessagesSanitized.push(r);
+      })
+      messagesSanitized.push(fileMessagesSanitized);
+    })
+    return [].concat(...messagesSanitized);
+  },
+  supportsAutofix: true,
+};

package/lib/{impl/rules → rules}/assoc2many-ambiguous-key.js

@@ -1,30 +1,36 @@
-module.exports = require("../../api").createRule({
+module.exports = {
   meta: {
     docs: {
-      description: "Ambiguous key with a `TO MANY` relationship since entries could appear multiple times with the same key.",
+      description:
+        "Ambiguous key with a `TO MANY` relationship since entries could appear multiple times with the same key.",
       category: "Model Validation",
       recommended: true,
       version: "1.0.1",
     },
     severity: "warn",
-    type: "problem"
+    type: "problem",
   },
   create(context) {
-    let csnOdata;
-    const m = context.cds.model;
-    if (m && m.definitions) {
-      try {
+    return { all: check_assoc2many_ambiguous_key };
+
+    function check_assoc2many_ambiguous_key() {
+      let reports = [];
+      let csnOdata;
+      const m = context.cds.model;
+      if (m && m.definitions) {
         csnOdata = context.cds.compile.for.odata(m);
         const csnOdataLinked = context.cds.linked(csnOdata);
-        associationCardinalityFlaw(csnOdataLinked, context);
-      } catch (err) {
-        // Don't continue with rule if model fails to compile
+        reports = associationCardinalityFlaw(csnOdataLinked, context);
+      }
+      if (reports.length > 0) {
+        return reports;
       }
     }
   },
-});
+};
 
 function associationCardinalityFlaw(csn, context) {
+  const reports = [];
   processEntity(csn, (definition, sourceEntity, sourceAlias) => {
     let refCardinalityMult = false;
     let refPlainElement = false;
@@ -38,10 +44,7 @@ function associationCardinalityFlaw(csn, context) {
         refPlainElement = false;
       },
       (refEntity, refElement) => {
-        if (
-          refElement.type === "cds.Association" ||
-          refElement.type === "cds.Composition"
-        ) {
+        if (refElement.type === "cds.Association" || refElement.type === "cds.Composition") {
           if (refElement.cardinality && refElement.cardinality.max === "*") {
             refCardinalityMult = true;
           }
@@ -57,20 +60,35 @@ function associationCardinalityFlaw(csn, context) {
           refCardinalityMult &&
           refPlainElement
         ) {
-          const loc = context.cds.getLocation(definition.name, definition);
-          context.report({
-            message: `Ambiguous key in '${definition.name}'. Element '${
-              column.as ? column.as : column.name
-            }' leads to multiple entries so that key '${
-              Object.keys(definition.keys)[0]
-            }' is not unique.`,
-            loc,
-            file: definition.$location.file,
-          });
+          const keyName = Object.keys(definition.keys)[0];
+          const key = definition.keys[keyName];
+          const keyLoc = context.cds.getLocation(keyName, key, csn);
+          const colName = column.as ? column.as : column.name;
+          if (context.sourcecode.lines[column.$location.line - 1]) {
+            const endCol = context.sourcecode.lines[column.$location.col - 1].length;
+            const colLoc = {
+              start: { line: column.$location.line, column: column.$location.col - 1 },
+              end: { line: column.$location.line, column: endCol },
+            };
+            const message = `Ambiguous key in '${definition.name}'. Element '${colName}' leads to multiple entries so that key '${keyName}' is not unique.`;
+            reports.push(
+              {
+                message,
+                loc: keyLoc,
+                file: key.$location.file,
+              },
+              {
+                message,
+                loc: colLoc,
+                file: column.$location.file,
+              }
+            );
+          }
         }
       }
     );
   });
+  return reports;
 }
 
 function processEntity(csn, eachCallback) {
@@ -89,21 +107,14 @@ function processEntity(csn, eachCallback) {
       const sourceAlias = [];
       if (definition.query.SELECT.from.ref) {
         // From
-        sourceEntity =
-          csn.definitions[definition.query.SELECT.from.ref.join("_")];
+        sourceEntity = csn.definitions[definition.query.SELECT.from.ref.join("_")];
         sourceAlias.push({
           from: sourceEntity.name,
-          as:
-            definition.query.SELECT.from.as ||
-            definition.query.SELECT.from.ref.slice(-1)[0].split(".").pop(),
+          as: definition.query.SELECT.from.as || definition.query.SELECT.from.ref.slice(-1)[0].split(".").pop(),
         });
-      } else if (
-        definition.query.SELECT.from.args &&
-        definition.query.SELECT.from.args[0].ref
-      ) {
+      } else if (definition.query.SELECT.from.args && definition.query.SELECT.from.args[0].ref) {
         // Join
-        sourceEntity =
-          csn.definitions[definition.query.SELECT.from.args[0].ref.join("_")];
+        sourceEntity = csn.definitions[definition.query.SELECT.from.args[0].ref.join("_")];
         definition.query.SELECT.from.args.forEach((arg) => {
           sourceAlias.push({
             from: arg.ref.join("_"),
@@ -119,15 +130,7 @@ function processEntity(csn, eachCallback) {
   });
 }
 
-function processElement(
-  csn,
-  definition,
-  sourceEntity,
-  sourceAlias,
-  beforeCallback,
-  eachCallback,
-  afterCallback
-) {
+function processElement(csn, definition, sourceEntity, sourceAlias, beforeCallback, eachCallback, afterCallback) {
   definition.query.SELECT.columns.forEach((column) => {
     if (column.ref && column.ref.length > 1) {
       let refEntity = sourceEntity;
@@ -150,18 +153,12 @@ function processElement(
             if (!refElement && definition.query.SELECT.mixin) {
               refElement = definition.query.SELECT.mixin[ref];
               if (!refElement && definition.query.SELECT.mixin[column.ref[0]]) {
-                refElement =
-                  definition.query.SELECT.mixin[column.ref[0]]._target.elements[
-                    ref
-                  ];
+                refElement = definition.query.SELECT.mixin[column.ref[0]]._target.elements[ref];
               }
             }
           }
           eachCallback(refEntity, refElement);
-          if (
-            refElement.type === "cds.Association" ||
-            refElement.type === "cds.Composition"
-          ) {
+          if (refElement.type === "cds.Association" || refElement.type === "cds.Composition") {
             refEntity = csn.definitions[refElement.target];
           }
         }