@sap/eslint-plugin-cds 2.1.1 → 2.3.2

package/CHANGELOG.md

@@ -6,15 +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
+
+### 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
+
+- 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
+
+- Fixed suggestion messages in editor option (and disabled auto-fix)
+- Added rule properties 'docs.recommended', 'severity'
+
+## [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
+### 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/README.md

@@ -3,4 +3,4 @@
 
 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/#cds-lint) for more details, or jump directly to a complete [list of rules](https://cap.cloud.sap/docs/get-started/tools/#cds-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/index.js

@@ -1,12 +1,27 @@
 /**
  * Our custom ESLint plugin API should:
- * - Expose 'createRule', and 'runRuleTester' to users to support the addition of *custom* cds rules
- * - Expose 'getConfigPath' and 'getFileExtensions' for usage in 'cds lint' (@sap/cds-dk)
+ * - 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 { defineRule, createRule, runRuleTester } = require("../impl/ruleFactory");
- const { getConfigPath } = require("../impl/utils/model");
- const { getFileExtensions } = require("../impl/utils/rules");
- const { genDocs } = require("../impl/utils/rules");
+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");
 
- module.exports = { defineRule, createRule, runRuleTester, getConfigPath, getFileExtensions, genDocs }
+module.exports = {
+  createRule,
+  defineRule,
+  runRuleTester,
+  getConfigPath,
+  getFileExtensions,
+  genDocs,
+  parserPath,
+};

package/lib/impl/constants.js

@@ -2,12 +2,9 @@
  * 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: Any globals which should be exposed to ESLint by this plugin
- * - overrides:
- *   - files: Any additional file extensions which ESLint should lint
- *   - parser: The custom parser require to lint the additional files types
+ *                   which contains the subdirs 'docs', 'rules' and 'tests'
+ * - globals: The globals which should be exposed to ESLint by this plugin
+ * - files: Any additional file extensions which ESLint should lint
  */
 
 module.exports = {
@@ -15,18 +12,7 @@ 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-db-keywords": 2,
-    "@sap/cds/require-2many-oncond": 2,
-    "@sap/cds/sql-cast-suggestion": 1
-  },
-
   globals: {
     SELECT: true,
     INSERT: true,
@@ -39,7 +25,6 @@ module.exports = {
     CXL: true,
     cds: true,
   },
-
-  files: ["*.cds", "*.csn"],
-
+  files: ["*.cds", "*.csn", "*.csv"],
+  modelFiles: ["*.cds", "*.csn"],
 };

package/lib/impl/index.js

@@ -1,46 +1,63 @@
 /**
  * Custom ESLint plugin:
  * https://eslint.org/docs/developer-guide/working-with-plugins
- * This file exposes our plugins ESLint config, which (according to ESLint guidelines) 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 
+ * 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 use this file to initiate our cached 'cds', which:
- * - Store our models and envs (internally)
- * - Caches cds services api uses in custom lint rules (externally)
+ * We also initiate and cache the objects 'rulesInfo' and 'cds' for later use.
  */
 
-const { rules } = require("./rules");
+const path = require("path");
 const processor = require("./processor");
 const plugin = require("../../package.json").name;
-const { files, globals, recommended } = require("./constants");
-const { Cache, getProxy, getLocation, getRange } = require("../impl/utils/model");
+
+const { getRules } = require("../impl/utils/rules");
+const {
+  Cache,
+  getCDSProxy,
+  getLocation,
+  getRange,
+} = require("../impl/utils/model");
+const { files, globals } = require("./constants");
 
 const cds = require("@sap/cds");
 cds.getLocation = getLocation;
 cds.getRange = getRange;
-Cache.set('cds', getProxy(cds));
+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");
+}
+const recommended = Object.assign({}, 
+  ...Object.entries(rulesInfo.rules)
+    .filter(([k,v]) => (v.meta.docs.recommended))
+    .map(([k,v]) => ({ [`@sap/cds/${k}`]:v.meta.severity }))
+);
 
 module.exports = {
   configs: {
     recommended: {
+      globals,
       plugins: [plugin],
       overrides: [
         {
           files: files,
-          parser: "./parser",
-          processor: "@sap/cds/cds"
+          processor: "@sap/cds/cds",
         },
       ],
       rules: recommended,
-    }
+    },
   },
-  globals,
   processors: {
-    cds: processor
+    cds: processor,
   },
-  parser: "./parser",
-  rules
-}
+  rules: rulesInfo.rules,
+};

package/lib/impl/parser.js

@@ -2,12 +2,20 @@
  * Custom ESLint parser:
  * https://eslint.org/docs/developer-guide/working-with-custom-parsers
  * This file must:
- * - Expose 'parseForESLint' method on the parser which should return the AST, optional properties services, a scopeManager, and visitorKeys
+ * - Expose 'parseForESLint' method on the parser which should return the AST,
+ *   optional properties services, a scopeManager, and visitorKeys
  * - Expose default method 'parse' which should return the AST
- * Both methods should take in the source code and an optional configuration (parserOptions)
+ * Both methods should take in the source code and an optional configuration
+ * (parserOptions). Note, that because we use a 'empty' preprocessor, the
+ * parser is only used by ESLint's ruleTester.
  */
 
-const { getAST, getProxy, getLocation, getRange } = require("./utils/model");
+const {
+  getAST,
+  getCDSProxy,
+  getLocation,
+  getRange,
+} = require("../impl/utils/model");
 const cds = require("@sap/cds");
 
 module.exports = {
@@ -21,7 +29,7 @@ module.exports = {
     return {
       ast: getAST(code),
       services: {
-        cdsProxy: getProxy(cds),
+        cdsProxy: getCDSProxy(cds),
       },
       scopeManager: null,
       tokensAndComments: [],

package/lib/impl/processor.js

@@ -1,12 +1,23 @@
-const path = require("path");
+/**
+ * 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
+ * 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).
+ */
+
 const { Cache } = require("./utils/model");
+const { isValidFile } = require("./utils/helpers");
 
 module.exports = {
   preprocess: function (text, filename) {
-    const fileExtension = `*${path.extname(filename)}`;
-    if (["*.cds", "*.csn"].includes(fileExtension)) {
-        Cache.set(`file:${filename}`, text)
+    if (isValidFile(filename)) {
+      Cache.set(`file:${filename}`, text);
     }
-    return [{ text: '', filename }];
-  }
+    return [{ text: "", filename }];
+  },
+  supportsAutofix: true,
 };