@sap/eslint-plugin-cds 2.6.0 → 2.6.3

package/CHANGELOG.md

@@ -6,6 +6,27 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
+## [2.6.3] - 2023-02-13
+
+### Changed
+
+- Filter rule reports using *inferred* models on $location.
+
+## [2.6.2] - 2023-02-13
+
+### Changed
+
+- Fixed rule reports using *inferred* models to always receive valid _file_ $locations.
+
+## [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

package/README.md

@@ -1,6 +1,5 @@
 # @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/conf/all.js

@@ -3,20 +3,20 @@
 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'
+  '@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/recommended.js

@@ -9,7 +9,7 @@ module.exports = {
   '@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-db-keywords': 1,
   '@sap/cds/no-dollar-prefixed-names': 1,
   '@sap/cds/no-join-on-draft': 1,
   '@sap/cds/require-2many-oncond': 2,

package/lib/constants.js

@@ -31,6 +31,7 @@ const MODEL_FILES = ['*.cds', '*.csn']
 const GLOBALS = {
   SELECT: true,
   INSERT: true,
+  UPSERT: true,
   UPDATE: true,
   DELETE: true,
   CREATE: true,

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

package/lib/rules/auth-valid-restrict-grant.js

@@ -78,6 +78,7 @@ module.exports = {
                       })
                     }
                   }
+                  // If values do not contain 'READ, WRITE, *', 'WRITE' only is enough
                   const allValuesIncluded = grantValue.every((v) => valuesForWrite.includes(v))
                   if (allValuesIncluded) {
                     context.report({
@@ -87,7 +88,8 @@ module.exports = {
                       file
                     })
                   }
-                  if (grantValue.includes('*')) {
+                  // If values contain '*', '*' only is enough
+                  if (grantValue.length > 1 && grantValue.includes('*')) {
                     context.report({
                       messageId: 'InvalidItem',
                       data: { invalid: `[${grantValue}]`, candidates: ['["*"]'] },

package/lib/rules/auth-valid-restrict-to.js

@@ -101,7 +101,8 @@ module.exports = {
                     file
                   })
                 } else {
-                  if (toValue.includes('any')) {
+                  // If values contain 'any', 'any' only is enough
+                  if (toValue.length > 1 && toValue.includes('any')) {
                     context.report({
                       messageId: 'InvalidItem',
                       data: { invalid: `[${toValue}]`, candidates: ['["any"]'] },
@@ -111,13 +112,15 @@ module.exports = {
                   }
                   toValue.forEach((value) => {
                     if (!ROLES.includes(value)) {
-                      const candidates = findFuzzy(value, ROLES.sort())
-                      context.report({
-                        messageId: 'InvalidItem',
-                        data: { invalid: value, candidates },
-                        node,
-                        file
-                      })
+                      const candidates = findFuzzy(value, ROLES.sort(), undefined, false, 2)
+                      if (candidates.length > 0) {
+                        context.report({
+                          messageId: 'InvalidItem',
+                          data: { invalid: value, candidates },
+                          node,
+                          file
+                        })
+                      }
                     }
                   })
                 }

package/lib/rules/no-db-keywords.js

@@ -7,7 +7,8 @@ module.exports = {
       description: 'Avoid using reserved SQL keywords.',
       recommended: true
     },
-    type: 'problem'
+    type: 'problem',
+    model: 'inferred'
   },
   create (context) {
     const { db = { kind: 'sql' } } = cds.env.requires
@@ -23,9 +24,11 @@ module.exports = {
         // Do not blame in case of external services
         const srv = d._service || (d.parent && d.parent._service)
         if (srv && srv['@cds.external']) return
+        if (d.kind === 'entity' && d['@cds.persistence.skip'] === true) return
         context.report({
           message: `'${d.name}' is a reserved keyword in ${db.kind.toUpperCase()}`,
-          node: context.getNode(d)
+          node: context.getNode(d),
+          file: d.$location.file
         })
       }
     }

package/lib/utils/createRule.js

@@ -91,11 +91,15 @@ function isRunningWithCDSLint () {
   return process.argv[0].endsWith('node') && process.argv[1].endsWith('cds') && process.argv[2] === 'lint'
 }
 
+function isRunningWithESLint () {
+  return process.argv[0].endsWith('node') && process.argv[1].endsWith('eslint')
+}
+
 function checkEntryCriteria (meta, cdscontext) {
   const isTest = Cache.has('test')
   const hasProjectRoots = Cache.has(`roots:${Cache.get('rootpath')}`)
   const isValidFile = isConfiguredFileType(cdscontext.getFilename(), 'FILES')
-  const doRootModelChecks = isTest || (hasProjectRoots && (isRunningWithCDSLint() || cdscontext.options.includes('show')))
+  const doRootModelChecks = isTest || (hasProjectRoots && (isRunningWithCDSLint() || isRunningWithESLint() || cdscontext.options.includes('show')))
   // Also lint empty folders (i.e. lintText "" API)
   const doEnvironmentChecks =
     isTest || (hasProjectRoots && isRunningWithCDSLint() && cdscontext.getSourceCode().lines[0] === '')
@@ -140,8 +144,11 @@ function createReport (node, cdscontext, meta, create) {
 
         if (model) {
           model.forall((d) => {
+            d = (meta.model === 'inferred') ? sanitizeFileLocation(d) : d
+            const isValidLocation = (meta.model === 'parsed' && d.$location) ||
+              (meta.model === 'inferred' && d.$location?.file)
             Object.entries(handlers)
-              .filter(([type, lazy]) => d.is(type))
+              .filter(([type, lazy]) => d.is(type) && isValidLocation)
               .forEach(([lazy, handler]) => {
                 try {
                   handler(d)
@@ -157,6 +164,13 @@ function createReport (node, cdscontext, meta, create) {
   }
 }
 
+function sanitizeFileLocation (d) {
+  let parent = d
+  while (!parent.$location && parent.parent && !parent.parent.definitions) parent = d.parent
+  if (parent.$location) d.$location = parent.$location
+  return d
+}
+
 function extendContext (node, context, meta) {
   if (!Cache.has('test')) {
     const filePath = context.getFilename()
@@ -221,7 +235,9 @@ function isRuleDisabled (line, cdscontext) {
 
 function cacheReport (r, file, context, meta) {
   delete r.file
-  r.node.range = []
+  if (r.node && r.node.range) {
+    r.node.range = []
+  }
   if (r.messageId) {
     r.message = meta.messages[r.messageId]
     delete r.message

package/lib/utils/findFuzzy.js

@@ -9,7 +9,7 @@
 
 const cache = {}
 
-module.exports = (input, list, log, keepCase = false) => {
+module.exports = (input, list, log, keepCase = false, threshold = Number.MAX_SAFE_INTEGER) => {
   let minDistWords = []
 
   if (input.length > 50 || list.length > 50) {
@@ -38,12 +38,16 @@ module.exports = (input, list, log, keepCase = false) => {
     }
 
     if (levDist === minDist) {
-      minDistWords.push(word)
+      if (!threshold || (threshold && levDist < threshold)) {
+        minDistWords.push(word)
+      }
     }
 
     if (levDist < minDist) {
-      minDist = levDist
-      minDistWords = [word]
+      if (!threshold || (threshold && levDist < threshold)) {
+        minDist = levDist
+        minDistWords = [word]
+      }
     }
   }
 

package/package.json

@@ -1,38 +1,38 @@
 {
-  "name": "@sap/eslint-plugin-cds",
-  "version": "2.6.0",
-  "description": "ESLint plugin including recommended SAP Cloud Application Programming model and environment rules",
-  "homepage": "https://cap.cloud.sap/",
-  "keywords": [
-    "eslint",
-    "eslint-plugin",
-    "cds",
-    "cds-lint",
-    "cds-lint-plugin"
-  ],
-  "author": "SAP SE (https://www.sap.com)",
-  "license": "See LICENSE file",
-  "main": "lib/index.js",
-  "files": [
-    "lib/",
-    "CHANGELOG.md",
-    "LICENSE",
-    "README.md"
-  ],
-  "dependencies": {
-    "@sap/cds": ">=5.6.0",
-    "semver": "^7.3.4"
-  },
-  "eslintConfig": {
-    "extends": [
-      "eslint:recommended",
-      "standard"
-    ]
-  },
-  "peerDependencies": {
-    "eslint": ">=7"
-  },
-  "engines": {
-    "node": ">=14"
-  }
+    "name": "@sap/eslint-plugin-cds",
+    "version": "2.6.3",
+    "description": "ESLint plugin including recommended SAP Cloud Application Programming model and environment rules",
+    "homepage": "https://cap.cloud.sap/",
+    "keywords": [
+        "eslint",
+        "eslint-plugin",
+        "cds",
+        "cds-lint",
+        "cds-lint-plugin"
+    ],
+    "author": "SAP SE (https://www.sap.com)",
+    "license": "See LICENSE file",
+    "main": "lib/index.js",
+    "files": [
+        "lib/",
+        "CHANGELOG.md",
+        "LICENSE",
+        "README.md"
+    ],
+    "dependencies": {
+        "@sap/cds": ">=5.6.0",
+        "semver": "^7.3.4"
+    },
+    "eslintConfig": {
+        "extends": [
+            "eslint:recommended",
+            "standard"
+        ]
+    },
+    "peerDependencies": {
+        "eslint": ">=7"
+    },
+    "engines": {
+        "node": ">=14"
+    }
 }