@sap/eslint-plugin-cds 2.4.1 → 2.6.0

package/CHANGELOG.md

@@ -6,14 +6,43 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
+## [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
+
+- Model Validation rules use `parsed` flavor by default (`meta.model` property)
+- Environment rules have { model: "none" }
+
+### Added
+
+- Flavor in `model` property on `meta` object of rule
+- Context function `getNode()` returns Node with proper location
+
 ## [2.4.1] - 2022-06-17
 
-- Added authorization rules 'auth-*'.
+### Added
+
+- Authorization rules 'auth-*'.
 
 ### Changed
 
 - Node.js 14 is now the minimum required Node.js version.  Version 12 is no longer supported.
-
+- Default CSN flavor in rules is `parsed`.
 
 ## [2.4.0] - 2022-04-14
 

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,25 +1,26 @@
-"use strict";
+'use strict'
 
 /**
  * Our custom ESLint plugin API should:
  * - Expose 'createRule' and 'runRuleTester' to
  *   support the addition of *custom* CDS Lint rules at runtime
- * - Expose 'getConfigPath', 'getFileExtensions', and 'genDocs' for usage in
+ * - Expose '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 { 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");
+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 = {
-  createRule,
   runRuleTester,
-  getConfigPath,
-  getFileExtensions,
+  createRule,
   genDocs,
-  parserPath,
-};
+  getConfigPath,
+  getFileExtensions: getConfiguredFileTypes,
+  parserPath
+}

package/lib/conf/all.js

@@ -0,0 +1,22 @@
+'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': '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/extension-restrictions': 'error'
+}

package/lib/conf/index.js

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

package/lib/conf/recommended.js

@@ -0,0 +1,19 @@
+'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': 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': 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

@@ -1,6 +1,5 @@
 /**
  * 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
@@ -13,18 +12,21 @@
  * - 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 RULE_FLAVORS = ['parsed', 'inferred']
 
-const PLUGIN_NAME = require("../package.json").name;
-const PLUGIN_PREFIX = "@sap/cds";
-const PROCESSOR_NAME = `${PLUGIN_PREFIX}/cds`
-const CUSTOM_RULES_DIR = ".cdslint";
+const DEFAULT_RULE_CATEGORY = 'Model Validation'
+const DEFAULT_RULE_FLAVOR = RULE_FLAVORS[0]
+const DEFAULT_RULE_SEVERITY = 'error'
+const DEFAULT_RULE_TYPE = 'problem'
 
-const FILES = ["*.cds", "*.csn", "*.csv"];
-const MODEL_FILES = ["*.cds", "*.csn"];
+const PLUGIN_NAME = require('../package.json').name
+
+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 GLOBALS = {
   SELECT: true,
@@ -36,19 +38,20 @@ const GLOBALS = {
   CDL: true,
   CQL: true,
   CXL: true,
-  cds: true,
-};
+  cds: true
+}
 
 module.exports = {
-  RULE_CATEGORIES,
+  RULE_FLAVORS,
   DEFAULT_RULE_CATEGORY,
+  DEFAULT_RULE_FLAVOR,
   DEFAULT_RULE_SEVERITY,
   DEFAULT_RULE_TYPE,
   PLUGIN_NAME,
+  PLUGIN_SCOPE,
   PLUGIN_PREFIX,
-  PROCESSOR_NAME,
   CUSTOM_RULES_DIR,
   FILES,
   MODEL_FILES,
   GLOBALS
-};
+}

package/lib/index.js

@@ -1,44 +1,22 @@
 /**
  * Custom ESLint plugin:
  * https://eslint.org/docs/developer-guide/working-with-plugins
- * This file exposes our plugins ESLint configuration, which must:
+ * 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],
-    };
-}
+const api = require('./api')
+const rules = Object.assign(
+  {},
+  ...Object.entries(require('./rules')).map(([k, v]) => ({ [k]: v() }))
+)
+const configs = require('./conf')
 
 module.exports = {
-    configs: {
-        recommended: _getConfig("recommended"),
-        all: _getConfig("all"),
-    },
-    processors: {
-        cds: processor,
-    },
-    rules: rules.sources,
-};
+  configs,
+  rules,
+  ...api
+}

package/lib/parser.js

@@ -6,23 +6,182 @@
  *   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). Note, that because we use a 'empty' preprocessor, the
- * parser is only used by ESLint's ruleTester.
+ * (parserOptions).
  */
- const { getAST } = require("./utils/model");
+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: getAST(code),
-      services: {},
+      ast: createProgramAST(code),
+      services: {
+        getParsedCsn: function () {
+          let compiledModel
+          let reflectedModel
+          const messages = []
+          try {
+            compiledModel = cds.parse(code)
+          } catch (err) {
+            // Do nothing
+          }
+          if (compiledModel) {
+            try {
+              reflectedModel = cds.linked(compiledModel)
+              if (messages) {
+                reflectedModel.messages = messages
+              }
+            } catch (err) {
+              LOG && LOG(colors.red + 'ERROR:' + colors.reset, err)
+              LOG && LOG('COMPILED', compiledModel)
+              LOG && LOG('REFLECTED', reflectedModel)
+            }
+          }
+          return reflectedModel
+        },
+        getInferredCsn: function () {
+          const rootPath = Cache.get('rootpath')
+          if (Cache.has('test')) {
+            return Cache.get(`model:${rootPath}`)
+          }
+          let compiledModel
+          let reflectedModel
+          cds.resolve.cache = {}
+
+          if (!Cache.has(`model:${rootPath}`) && rootPath) {
+            const roots = Cache.get(`roots:${rootPath}`)
+            const messages = []
+            if (roots) {
+              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}`)
+          }
+          return reflectedModel
+        },
+        updateInferredCsn: compileModelFromDict,
+        getEnvironment: function () {
+          const options = Cache.get('options')
+          return (options && options[0] && options[0].environment) ? options[0].environment : undefined
+        },
+        getLocation: function (name, obj, model) {
+          let loc
+          const defaultLoc = {
+            start: { line: 0, column: 0 },
+            end: { line: 1, column: 0 }
+          }
+          if (obj.$location) {
+            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 (objLoc.col === 0) {
+                objLoc.col = 1
+              }
+              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)
+            }
+          }
+          // Empty locations default to line 0, column 0
+          if (!loc) {
+            loc = defaultLoc
+          }
+          return loc
+        },
+        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: null,
-    };
+      visitorKeys: []
+    }
   },
-};
+  createProgramAST,
+  compileModelFromDict
+}
+
+/**
+ * Generates dummy AST with just single Program node
+ * @param code Parse file contents
+ * @returns AST
+ */
+function createProgramAST (code, loc) {
+  loc = loc || {
+    start: {
+      line: 1,
+      column: 0
+    },
+    end: {
+      line: 1,
+      column: 0
+    }
+  }
+  return {
+    type: 'Program',
+    body: [],
+    sourceType: 'module',
+    tokens: [],
+    comments: [],
+    range: [0, code.length],
+    loc
+  }
+}
+
+function compileModelFromDict (dictFiles, options) {
+  let reflectedModel
+  const messages = []
+  const compiledModel = cds.compile(dictFiles, {
+    sync: true,
+    locations: true,
+    messages,
+    ...options
+  })
+  if (compiledModel) {
+    reflectedModel = cds.linked(compiledModel)
+    if (messages) {
+      reflectedModel.messages = messages
+    }
+  }
+  return reflectedModel
+}