@sap/eslint-plugin-cds 2.5.0 → 2.6.1

package/CHANGELOG.md

@@ -6,6 +6,30 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
+## [2.6.1] - 2023-01-26
+
+### Changed
+
+- Fixed rule name in ESLint config:all to `@sap/cds/start-elements-lowercase`.
+- Allow expensive rules to be reported when running from ESLint Cli.
+- In _auth-valid-restrict-grant_, only suggest closely related user roles.
+- In _auth-valid-restrict-to_, only suggest `*` if other entries apart from `*` exist.
+
+## [2.6.0] - 2022-09-29
+
+### Changed
+
+- Renamed rule `no-join-on-draft-enabled-entities` to `no-join-on-draft`.
+- Expanded list of reserved keywords to check for in rule `no-db-keywords`.
+
+### Added
+
+- New `extension-restrictions` rule that validates extension projects' models against restrictions set by the extended SaaS app.
+
+### Fixed
+
+- Errors from rules are shown again in the console output
+
 ## [2.5.0] - 2022-08-04
 
 ### Changed

package/README.md

@@ -1,5 +1,6 @@
 # @sap/eslint-plugin-cds
-
+[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
+[![Sync Files Workflow](https://github.tools.sap/cap/eslint-plugin-cds/actions/workflows/sync.yml/badge.svg)](https://github.tools.sap/cap/eslint-plugin-cds/actions/workflows/sync.yml)
 
 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.
 

package/lib/api/index.js

@@ -1,4 +1,4 @@
-"use strict";
+'use strict'
 
 /**
  * Our custom ESLint plugin API should:
@@ -9,12 +9,12 @@
  * - Expose 'parserPath' for CDS Lint rule unit tests with ESLint's ruleTester
  */
 
-const runRuleTester = require("../utils/runRuleTester");
-const createRule = require("../utils/createRule");
-const genDocs = require("../utils/genDocs");
-const getConfigPath = require("../utils/getConfigPath");
-const getConfiguredFileTypes = require("../utils/getConfiguredFileTypes");
-const parserPath = require.resolve("../parser");
+const runRuleTester = require('../utils/runRuleTester')
+const createRule = require('../utils/createRule')
+const genDocs = require('../utils/genDocs')
+const getConfigPath = require('../utils/getConfigPath')
+const getConfiguredFileTypes = require('../utils/getConfiguredFileTypes')
+const parserPath = require.resolve('../parser')
 
 module.exports = {
   runRuleTester,
@@ -22,5 +22,5 @@ module.exports = {
   genDocs,
   getConfigPath,
   getFileExtensions: getConfiguredFileTypes,
-  parserPath,
-};
+  parserPath
+}

package/lib/conf/all.js

@@ -1,21 +1,22 @@
-"use strict";
+'use strict'
 
 module.exports = {
-  "@sap/cds/assoc2many-ambiguous-key": 2,
-  "@sap/cds/auth-no-empty-restrictions": 2,
-  "@sap/cds/auth-use-requires": 1,
-  "@sap/cds/auth-valid-restrict-grant": 1,
-  "@sap/cds/auth-valid-restrict-keys": 1,
-  "@sap/cds/auth-valid-restrict-to": "warn",
-  "@sap/cds/auth-valid-restrict-where": "warn",
-  "@sap/cds/latest-cds-version": "warn",
-  "@sap/cds/min-node-version": "error",
-  "@sap/cds/no-db-keywords": "error",
-  "@sap/cds/no-dollar-prefixed-names": "warn",
-  "@sap/cds/no-join-on-draft-enabled-entities": "warn",
-  "@sap/cds/require-2many-oncond": "error",
-  "@sap/cds/sql-cast-suggestion": "warn",
-  "@sap/cds/start-elements-uppercase": "warn",
-  "@sap/cds/start-entities-uppercase": "warn",
-  "@sap/cds/valid-csv-header": "error"
-};
+  '@sap/cds/assoc2many-ambiguous-key': 2,
+  '@sap/cds/auth-no-empty-restrictions': 2,
+  '@sap/cds/auth-use-requires': 2,
+  '@sap/cds/auth-valid-restrict-grant': 2,
+  '@sap/cds/auth-valid-restrict-keys': 2,
+  '@sap/cds/auth-valid-restrict-to': 2,
+  '@sap/cds/auth-valid-restrict-where': 2,
+  '@sap/cds/latest-cds-version': 2,
+  '@sap/cds/min-node-version': 2,
+  '@sap/cds/no-db-keywords': 2,
+  '@sap/cds/no-dollar-prefixed-names': 2,
+  '@sap/cds/no-join-on-draft': 2,
+  '@sap/cds/require-2many-oncond': 2,
+  '@sap/cds/sql-cast-suggestion': 2,
+  '@sap/cds/start-elements-lowercase': 2,
+  '@sap/cds/start-entities-uppercase': 2,
+  '@sap/cds/valid-csv-header': 2,
+  '@sap/cds/extension-restrictions': 2
+}

package/lib/conf/index.js

@@ -1,7 +1,7 @@
-const { FILES, GLOBALS, PLUGIN_NAME } = require("../constants");
-const { parserPath } = require("../api");
+const { FILES, GLOBALS, PLUGIN_NAME } = require('../constants')
+const { parserPath } = require('../api')
 
-function _createConfig(config) {
+function _createConfig (config) {
   return {
     root: true,
     globals: GLOBALS,
@@ -9,14 +9,14 @@ function _createConfig(config) {
     overrides: [
       {
         files: FILES,
-        parser: parserPath,
-      },
+        parser: parserPath
+      }
     ],
-    rules: config,
-  };
+    rules: config
+  }
 }
 
 module.exports = {
-  all: _createConfig(require("./all")),
-  recommended: _createConfig(require("./recommended")),
-};
+  all: _createConfig(require('./all')),
+  recommended: _createConfig(require('./recommended'))
+}

package/lib/conf/recommended.js

@@ -1,18 +1,19 @@
-"use strict";
+'use strict'
 
 module.exports = {
-  "@sap/cds/assoc2many-ambiguous-key": [2, "hide"],
-  "@sap/cds/auth-no-empty-restrictions": 2,
-  "@sap/cds/auth-use-requires": 1,
-  "@sap/cds/auth-valid-restrict-grant": 1,
-  "@sap/cds/auth-valid-restrict-keys": 1,
-  "@sap/cds/auth-valid-restrict-to": 1,
-  "@sap/cds/auth-valid-restrict-where": 1,
-  "@sap/cds/min-node-version": 2,
-  "@sap/cds/no-db-keywords": 2,
-  "@sap/cds/no-dollar-prefixed-names": 1,
-  "@sap/cds/no-join-on-draft-enabled-entities": [1, "hide"],
-  "@sap/cds/require-2many-oncond": 2,
-  "@sap/cds/sql-cast-suggestion": 1,
-  "@sap/cds/valid-csv-header": 1
-};
+  '@sap/cds/assoc2many-ambiguous-key': 2,
+  '@sap/cds/auth-no-empty-restrictions': 2,
+  '@sap/cds/auth-use-requires': 1,
+  '@sap/cds/auth-valid-restrict-grant': 1,
+  '@sap/cds/auth-valid-restrict-keys': 1,
+  '@sap/cds/auth-valid-restrict-to': 1,
+  '@sap/cds/auth-valid-restrict-where': 1,
+  '@sap/cds/min-node-version': 2,
+  '@sap/cds/no-db-keywords': 1,
+  '@sap/cds/no-dollar-prefixed-names': 1,
+  '@sap/cds/no-join-on-draft': 1,
+  '@sap/cds/require-2many-oncond': 2,
+  '@sap/cds/sql-cast-suggestion': 1,
+  '@sap/cds/valid-csv-header': 1,
+  '@sap/cds/extension-restrictions': 2
+}

package/lib/constants.js

@@ -12,25 +12,26 @@
  * - GLOBALS:               Globals which should be exposed to ESLint by this plugin
  */
 
-const RULE_FLAVORS = ["parsed" , "inferred"];
+const RULE_FLAVORS = ['parsed', 'inferred']
 
-const DEFAULT_RULE_FLAVOR = RULE_FLAVORS[0];
+const DEFAULT_RULE_CATEGORY = 'Model Validation'
+const DEFAULT_RULE_FLAVOR = RULE_FLAVORS[0]
+const DEFAULT_RULE_SEVERITY = 'error'
+const DEFAULT_RULE_TYPE = 'problem'
 
-const DEFAULT_RULE_SEVERITY = "error";
-const DEFAULT_RULE_TYPE = "problem";
+const PLUGIN_NAME = require('../package.json').name
 
-const PLUGIN_NAME = require("../package.json").name;
+const PLUGIN_SCOPE = '@sap'
+const PLUGIN_PREFIX = `${PLUGIN_SCOPE}/cds`
+const CUSTOM_RULES_DIR = '.cdslint'
 
-const PLUGIN_SCOPE = "@sap";
-const PLUGIN_PREFIX = `${PLUGIN_SCOPE}/cds`;
-const CUSTOM_RULES_DIR = ".cdslint";
-
-const FILES = ["*.cds", "*.csn", "*.csv"];
-const MODEL_FILES = ["*.cds", "*.csn"];
+const FILES = ['*.cds', '*.csn', '*.csv']
+const MODEL_FILES = ['*.cds', '*.csn']
 
 const GLOBALS = {
   SELECT: true,
   INSERT: true,
+  UPSERT: true,
   UPDATE: true,
   DELETE: true,
   CREATE: true,
@@ -38,11 +39,12 @@ const GLOBALS = {
   CDL: true,
   CQL: true,
   CXL: true,
-  cds: true,
-};
+  cds: true
+}
 
 module.exports = {
   RULE_FLAVORS,
+  DEFAULT_RULE_CATEGORY,
   DEFAULT_RULE_FLAVOR,
   DEFAULT_RULE_SEVERITY,
   DEFAULT_RULE_TYPE,
@@ -53,4 +55,4 @@ module.exports = {
   FILES,
   MODEL_FILES,
   GLOBALS
-};
+}

package/lib/index.js

@@ -1,3 +1,10 @@
+// index.js
+/**
+ * ## Plugin structure
+ * This is the main entry point of our [custom ESLint plugin](https://eslint.org/docs/developer-guide/working-with-plugins),
+ * which exposes sets of [rules]() along with their [severity configurations]() to the [ESLint Cli]() or [API]().
+ * @module
+ */
 /**
  * Custom ESLint plugin:
  * https://eslint.org/docs/developer-guide/working-with-plugins
@@ -8,16 +15,15 @@
  * - Expose any 'rules' for use in ESLint
  */
 
-const api = require("./api");
-const rules =  Object.assign(
-    {},
-    ...Object.entries(require("./rules")).map(([k, v]) => ({
-        [k]: v() }))
-    );
-const configs = require("./conf");
+const api = require('./api')
+const rules = Object.assign(
+  {},
+  ...Object.entries(require('./rules')).map(([k, v]) => ({ [k]: v() }))
+)
+const configs = require('./conf')
 
 module.exports = {
-    configs,
-    rules,
-    ...api
-};
+  configs,
+  rules,
+  ...api
+}

package/lib/parser.js

@@ -8,172 +8,180 @@
  * Both methods should take in the source code and an optional configuration
  * (parserOptions).
  */
-const cds = require("@sap/cds");
-const Cache = require("./utils/Cache");
-const LOG = cds.debug("lint:plugin");
-const colors = require("./utils/Colors");
+const cds = require('@sap/cds')
+const Cache = require('./utils/Cache')
+const LOG = cds.debug('lint:plugin')
+const colors = require('./utils/Colors')
+const { splitDefName } = require('./utils/rules')
 
 module.exports = {
   parse: function (code, options) {
-    return module.exports.parseForESLint(code, options).ast;
+    return module.exports.parseForESLint(code, options).ast
   },
   parseForESLint: function (code) {
     return {
       ast: createProgramAST(code),
       services: {
         getParsedCsn: function () {
-          let compiledModel;
-          let reflectedModel;
-          const messages = [];
+          let compiledModel
+          let reflectedModel
+          const messages = []
           try {
-            compiledModel = cds.parse(code);
+            compiledModel = cds.parse(code)
           } catch (err) {
             // Do nothing
           }
           if (compiledModel) {
             try {
-              reflectedModel = cds.linked(compiledModel);
+              reflectedModel = cds.linked(compiledModel)
               if (messages) {
-                reflectedModel.messages = messages;
+                reflectedModel.messages = messages
               }
             } catch (err) {
-              LOG && LOG(colors.red + 'ERROR:' +  colors.reset, err)
+              LOG && LOG(colors.red + 'ERROR:' + colors.reset, err)
               LOG && LOG('COMPILED', compiledModel)
               LOG && LOG('REFLECTED', reflectedModel)
             }
           }
-          return reflectedModel;
+          return reflectedModel
         },
-        getInferredCsn: function() {
-          const rootPath = Cache.get(`rootpath`);
-          if (Cache.has("test")) {
-            return Cache.get(`model:${rootPath}`);
+        getInferredCsn: function () {
+          const rootPath = Cache.get('rootpath')
+          if (Cache.has('test')) {
+            return Cache.get(`model:${rootPath}`)
           }
-          let compiledModel;
-          let reflectedModel;
-          cds.resolve.cache = {};
+          let compiledModel
+          let reflectedModel
+          cds.resolve.cache = {}
 
-          if (!Cache.has(`model:${rootPath}`)) {
-            const roots = cds.resolve("*", { root: rootPath });
-            const messages = [];
+          if (!Cache.has(`model:${rootPath}`) && rootPath) {
+            const roots = Cache.get(`roots:${rootPath}`)
+            const messages = []
             if (roots) {
-                try {
-                  compiledModel = cds.load(roots, {
-                    cwd: ".",
-                    sync: true,
-                    locations: true,
-                    messages,
-                  });
-                  Cache.remove('errRootModel');
-                } catch (err) {
-                  Cache.set('errRootModel', err);
-                }
-                if (compiledModel) {
-                  reflectedModel = cds.linked(compiledModel);
-                  Cache.set(`model:${Cache.get(`rootpath`)}`, reflectedModel);
-                  if (messages) {
-                    reflectedModel.messages = messages;
-                  }
+              try {
+                compiledModel = cds.load(roots, {
+                  cwd: rootPath,
+                  sync: true,
+                  locations: true,
+                  messages
+                })
+                Cache.remove('errRootModel')
+              } catch (err) {
+                Cache.set('errRootModel', err)
+              }
+              if (compiledModel) {
+                reflectedModel = cds.linked(compiledModel)
+                Cache.set(`model:${Cache.get('rootpath')}`, reflectedModel)
+                if (messages) {
+                  reflectedModel.messages = messages
                 }
               }
+            }
           } else {
-              reflectedModel = Cache.get(`model:${rootPath}`);
+            reflectedModel = Cache.get(`model:${rootPath}`)
           }
-          return reflectedModel;
+          return reflectedModel
         },
         updateInferredCsn: compileModelFromDict,
         getEnvironment: function () {
-          const options = Cache.get("options");
+          const options = Cache.get('options')
           return (options && options[0] && options[0].environment) ? options[0].environment : undefined
         },
-        getLocation: function(name, obj, model) {
-          let loc;
+        getLocation: function (name, obj, model) {
+          let loc
           const defaultLoc = {
             start: { line: 0, column: 0 },
-            end: { line: 1, column: 0 },
-          };
+            end: { line: 1, column: 0 }
+          }
           if (obj.$location) {
-            const nameloc = obj.$location;
-            if (nameloc) {
+            const objLoc = obj.$location
+            if (objLoc) {
               // CSN entry with column 0 is equivalent to 'undefined'
               // It means that the column in that line cannot be determined,
               // so we assign a value 1 to get a column location of 0
-              if (nameloc.col === 0) {
-                nameloc.col = 1;
+              if (objLoc.col === 0) {
+                objLoc.col = 1
               }
-              loc = defaultLoc;
-              loc.start.column = nameloc.col - 1;
-              loc.start.line = nameloc.line;
-              loc.end.column = nameloc.col - 1 + name.length;
-              loc.end.line = nameloc.line;
+              loc = defaultLoc
+              loc.start.column = objLoc.col - 1
+              loc.start.line = objLoc.line
+              let colLength = name?.length // use length of `name` property
+              // TODO bug in reflect? : `annotate` elements have an unusable index-like `name`, e.g. "1"
+              if (obj.annotate) colLength = 0
+              loc.end.column = objLoc.col - 1 + colLength
+              loc.end.line = objLoc.line
             } else if (obj.parent) {
-              this.getLocation(name, obj.parent, model);
+              this.getLocation(name, obj.parent, model)
             }
           }
           // Empty locations default to line 0, column 0
           if (!loc) {
-            loc = defaultLoc;
+            loc = defaultLoc
           }
-          return loc;
+          return loc
         },
-        getNode: function(obj) {
-          let loc;
-          if (obj && obj.name) {
-            loc = this.getLocation(obj.name, obj);
+        getNode: function (obj) {
+          let loc
+          if (obj) {
+            let name = obj.name
+            if (['entity', 'service'].includes(obj.kind)) {
+              name = splitDefName(obj).name
+            }
+            loc = this.getLocation(name, obj)
           }
           return createProgramAST(code, loc)
         }
       },
       scopeManager: null,
       tokensAndComments: [],
-      visitorKeys: [],
-    };
+      visitorKeys: []
+    }
   },
   createProgramAST,
-  compileModelFromDict,
-};
+  compileModelFromDict
+}
 
 /**
  * Generates dummy AST with just single Program node
  * @param code Parse file contents
  * @returns AST
  */
-function createProgramAST(code, loc) {
+function createProgramAST (code, loc) {
   loc = loc || {
     start: {
       line: 1,
-      column: 0,
+      column: 0
     },
     end: {
       line: 1,
-      column: 0,
+      column: 0
     }
-  };
+  }
   return {
-    type: "Program",
+    type: 'Program',
     body: [],
-    sourceType: "module",
+    sourceType: 'module',
     tokens: [],
     comments: [],
     range: [0, code.length],
     loc
-  };
+  }
 }
 
-function compileModelFromDict(dictFiles, options) {
-  let reflectedModel;
-  const messages = [];
+function compileModelFromDict (dictFiles, options) {
+  let reflectedModel
+  const messages = []
   const compiledModel = cds.compile(dictFiles, {
     sync: true,
     locations: true,
     messages,
-    ...options,
-  });
+    ...options
+  })
   if (compiledModel) {
-    reflectedModel = cds.linked(compiledModel);
+    reflectedModel = cds.linked(compiledModel)
     if (messages) {
-      reflectedModel.messages = messages;
+      reflectedModel.messages = messages
     }
   }
-  return reflectedModel;
+  return reflectedModel
 }