@sap/eslint-plugin-cds 3.2.0 → 4.1.0

package/lib/rules/sql-cast-suggestion.js

@@ -1,40 +1,64 @@
 'use strict'
 
+const { RULE_CATEGORIES } = require('../constants')
+
 module.exports = {
   meta: {
     schema: [{/* to avoid deprecation warning for ESLint 9 */}],
     docs: {
+      category: RULE_CATEGORIES.model,
       description: 'Should make suggestions for possible missing SQL casts.',
       recommended: true,
       url: 'https://cap.cloud.sap/docs/tools/cds-lint/rules/sql-cast-suggestion',
     },
     type: 'suggestion',
     messages: {
-      missingSQLCast: 'Potential issue - Missing SQL cast for column expression?'
-    }
+      missingSqlCast: 'Potential issue - Missing SQL cast for column expression?'
+    },
+    model: 'parsed',
   },
   create: function (context) {
-    return { view: checkSqlCast }
+    const model = context.getModel()
+    if (!model?.definitions)
+      return
+
+    return function checkAllElementsStartWithLowercase() {
+      for (const defName in model.definitions) {
+        const def = model.definitions[defName]
+        checkSqlCastsInView(defName, def)
+      }
+    }
 
-    function checkSqlCast (v) {
+    function checkSqlCastsInView(defName, def) {
       // TODO: restructure and make more robust (#507)
-      if (v?.query?.SET?.args) {
-        for (const arg of v.query.SET.args) {
-          if (arg?.SELECT) {
-            // Only in UNION cases?
-            for (const each of arg.SELECT.columns || []) {
-              if (each) {
-                const { xpr, cast } = each
-                if (cast && xpr) {
-                  if (!(xpr[0]?.xpr && xpr[0]?.cast)) {
-                    context.report({
-                      messageId: 'missingSQLCast',
-                      node: context.getNode(v)
-                    })
-                  }
-                }
-              }
-            }
+      if (!def?.query?.SET?.args?.length)
+        return
+
+      for (const arg of def.query.SET.args) {
+        if (arg?.SELECT?.columns?.length) {
+          // Only in UNION cases?
+          for (const col of arg.SELECT.columns) {
+            if (col)
+              checkColumn(col)
+          }
+        }
+      }
+
+      function checkColumn(col) {
+        const { xpr, cast } = col
+        if (cast && xpr) {
+          if (!(xpr[0]?.xpr && xpr[0]?.cast)) {
+            // we don't pass a name for the column's location, as it would be used to calculate
+            // endColumn, which is not correct for this expression
+            const loc = col.$location ?
+              context.getLocation('', col, model) :
+              context.getLocation(defName, def, model)
+
+            context.report({
+              messageId: 'missingSqlCast',
+              loc,
+              file: def.$location.file,
+            })
           }
         }
       }

package/lib/rules/sql-null-comparison.js

@@ -11,8 +11,7 @@ module.exports = {
       description: 'Ensure SQL comparisons with \'null\' are valid',
       category: 'Model Validation',
       recommended: false,
-      // TODO: Add documentation
-      // url: 'https://cap.cloud.sap/docs/tools/cds-lint/rules/sql-null-comparison',
+      url: 'https://cap.cloud.sap/docs/tools/cds-lint/rules/sql-null-comparison',
     },
     type: 'problem',
     model: 'parsed',
@@ -21,40 +20,45 @@ module.exports = {
     }
   },
   create(context) {
-    return {
-      view(v) {
-        forEachXprInDefinition(v, checkExpression)
-
-        function checkExpression(xpr, ctx) {
-          if (!xpr || !Array.isArray(xpr))
-            return
-
-          for (let i = 0; i < xpr.length; i++) {
-            if (typeof xpr[i] !== 'object')
-              continue // scalar value, etc.
-
-            if (xpr[i]?.val === null) {
-              const prev = i > 0 && typeof xpr[i-1] === 'string' ? xpr[i-1] : null
-              if (prev && invalidComparisonOperators.includes(prev)) {
-                reportComparison(xpr, ctx)
-                continue
-              }
-              const next = i+1 < xpr.length && typeof xpr[i+1] === 'string' ? xpr[i+1] : null
-              if (next && invalidComparisonOperators.includes(next))
-                reportComparison(xpr, ctx)
-            }
-          }
-        }
+    const model = context.getModel()
+    if (!model?.definitions)
+      return
 
-        function reportComparison(xpr, ctx) {
-          context.report({
-            messageId: 'nullComparison',
-            loc: context.getLocation(null, ctx),
-            file: ctx.$location?.file,
-          })
-        }
+    return function checkSqlNullComparisonsInModel() {
+      for (const defName in model.definitions) {
+        const def = model.definitions[defName]
+        if (def.query || def.projection)
+          forEachXprInDefinition(def, checkExpression)
+      }
+    }
+
+    function checkExpression(xpr, ctx) {
+      if (!xpr || !Array.isArray(xpr))
+        return
 
+      for (let i = 0; i < xpr.length; i++) {
+        if (typeof xpr[i] !== 'object')
+          continue // scalar value, etc.
+
+        if (xpr[i]?.val === null) {
+          const prev = i > 0 && typeof xpr[i-1] === 'string' ? xpr[i-1] : null
+          if (prev && invalidComparisonOperators.includes(prev)) {
+            reportComparison(xpr, ctx)
+            continue
+          }
+          const next = i+1 < xpr.length && typeof xpr[i+1] === 'string' ? xpr[i+1] : null
+          if (next && invalidComparisonOperators.includes(next))
+            reportComparison(xpr, ctx)
+        }
       }
     }
+
+    function reportComparison(xpr, ctx) {
+      context.report({
+        messageId: 'nullComparison',
+        loc: context.getLocation('', ctx),
+        file: ctx.$location?.file,
+      })
+    }
   }
 }

package/lib/rules/start-elements-lowercase.js

@@ -1,11 +1,14 @@
 'use strict'
 
+const { RULE_CATEGORIES } = require('../constants')
+
 const allowedUpperCaseElements = ['ID']
 
 module.exports = {
   meta: {
     schema: [{/* to avoid deprecation warning for ESLint 9 */}],
     docs: {
+      category: RULE_CATEGORIES.model,
       description: 'Regular element names should start with lowercase letters.',
       url: 'https://cap.cloud.sap/docs/tools/cds-lint/rules/start-elements-lowercase',
     },

package/lib/rules/start-entities-uppercase.js

@@ -1,11 +1,13 @@
 'use strict'
 
+const { RULE_CATEGORIES } = require('../constants')
 const { splitDefName } = require('../utils/rules')
 
 module.exports = {
   meta: {
     schema: [{/* to avoid deprecation warning for ESLint 9 */}],
     docs: {
+      category: RULE_CATEGORIES.model,
       description: 'Regular entity names should start with uppercase letters.',
       url: 'https://cap.cloud.sap/docs/tools/cds-lint/rules/start-entities-uppercase',
     },

package/lib/rules/valid-csv-header.js

@@ -3,6 +3,7 @@
 const cds = require('@sap/cds')
 const { basename, extname } = require('node:path')
 const findFuzzy = require('../utils/findFuzzy')
+const { RULE_CATEGORIES } = require('../constants')
 const SEP = '[,;\t]'
 const EOL = '\\r?\\n'
 
@@ -11,7 +12,7 @@ module.exports = {
     schema: [{/* to avoid deprecation warning for ESLint 9 */}],
     docs: {
       description: 'CSV files for entities must refer to valid element names.',
-      category: 'Model Validation',
+      category: RULE_CATEGORIES.csv,
       recommended: true,
       url: 'https://cap.cloud.sap/docs/tools/cds-lint/rules/valid-csv-header',
     },

package/lib/utils/createRule.js

@@ -127,7 +127,6 @@ function setMetaDefaults (meta) {
   meta ??= {}
   meta.severity ??= constants.DEFAULT_RULE_SEVERITY
   meta.docs ??= {}
-  meta.docs.category ??= constants.DEFAULT_RULE_CATEGORY
   meta.model ??= 'parsed'
   return meta
 }
@@ -184,8 +183,10 @@ 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
+  while (!parent.$location && parent.parent && !parent.parent.definitions)
+    parent = d.parent
+  if (parent.$location)
+    d.$location = parent.$location
   return d
 }
 
@@ -213,8 +214,11 @@ function extendContext (node, context, meta) {
 
   const cdscontext = Object.create(Object.getPrototypeOf(context), descriptors)
   const { parserServices } = context.sourceCode || context
-  cdscontext.getModel =
-    meta.model === 'inferred' ? parserServices.getInferredCsn : parserServices.getParsedCsn
+
+  cdscontext.getModel = meta.model === 'inferred'
+    ? parserServices.getInferredCsn
+    : parserServices.getParsedCsn
+
   cdscontext.getEnvironment = () => {
     const options = context.options
     return options && options[0] && options[0].environment ? options[0].environment : undefined

package/lib/utils/getConfigPath.js

@@ -11,23 +11,12 @@
 const fs = require('node:fs')
 const path = require('node:path')
 
-module.exports = (currentDir = '.', legacy=false) => {
+module.exports = (currentDir = '.') => {
   let configFiles = [
     'eslint.config.js',
     'eslint.config.cjs',
     'eslint.config.mjs'
   ]
-  if (legacy) {
-    configFiles = [
-      '.eslintrc.js',
-      '.eslintrc.cjs',
-      '.eslintrc.yaml',
-      '.eslintrc.yml',
-      '.eslintrc.json',
-      '.eslintrc',
-      'package.json',
-    ]
-  }
   let configDir = path.resolve(currentDir)
   while (configDir !== path.resolve(configDir, '..')) {
     for (const configFile of configFiles) {

package/lib/utils/rules.js

@@ -8,23 +8,24 @@ const findFuzzy = require('./findFuzzy')
 module.exports = {
   findFuzzy,
   /**
-   *
-   * @param {*} e
+   * @param {object} definition CSN definition object.
+   * @param {string} [name] The definition's name. Inferred for "linked CSN".
    */
-  splitDefName(e) {
+  splitDefName(definition, name = definition.name) {
+    if (!name)
+      return null
     // Entity names from CSN are of the form:
     // <namespace>.<service>.<def>.<'texts'|'localized'>|<composition value>
     let prefix = ''
     let suffix = ''
-    let defName = e.name
-    const names = defName.split('.')
-    defName = names[names.length - 1]
+    const names = name.split('.')
+    let defName = names[names.length - 1]
 
     if (defName) {
       // Managed composition get compiler tag `_up`
       let isManagedComposition = false
-      if (e.elements) {
-        isManagedComposition = Object.keys(e.elements).some(k => k === 'up_')
+      if (definition.elements) {
+        isManagedComposition = Object.keys(definition.elements).some(k => k === 'up_')
       }
       // Check for compiler tags
       const compilerTagsToExclude = ['texts', 'localized']
@@ -34,7 +35,7 @@ module.exports = {
         suffix = names[names.length - 1]
         defName = names[names.length - 2]
       }
-      prefix = e.name.split(`.${defName}`)[0]
+      prefix = name.split(`.${defName}`)[0]
     }
     return { prefix, name: defName, suffix }
   },

package/lib/utils/runRuleTester.js

@@ -5,7 +5,7 @@
 const fs = require('node:fs')
 const path = require('node:path')
 
-const { Linter, RuleTester } = require('eslint')
+const { RuleTester } = require('eslint')
 const { globalCache } = require('./Cache')
 const isConfiguredFileType = require('./isConfiguredFileType')
 const { compileModelFromDict } = require('../parser')
@@ -56,6 +56,7 @@ module.exports = function runRuleTester(options) {
     rule = testRuleWrapper(rules[path.basename(options.root)]())
   } else {
     // Otherwise from project root
+
     // eslint-disable-next-line
     const resolvedPlugin = require.resolve('@sap/eslint-plugin-cds', {
       paths: [options.root]
@@ -66,9 +67,7 @@ module.exports = function runRuleTester(options) {
 
   let tester
   if (parserPath) {
-    const options = _isEslint9OrLater()
-      ? { languageOptions: { parser: require(parserPath) } }
-      : { parser: parserPath }
+    const options = { languageOptions: { parser: require(parserPath) } }
     tester = new RuleTester(options)
   } else {
     tester = new RuleTester()
@@ -82,10 +81,7 @@ module.exports = function runRuleTester(options) {
         filename: filePath,
       }
     ]
-    if (_isEslint9OrLater()) {
-      // property not supported for ESLint 8
-      testerCases[type][0].name = `${path.basename(options.root)}/${type}/${options.filename}`
-    }
+    testerCases[type][0].name = `${path.basename(options.root)}/${type}/${options.filename}`
     if (!isConfiguredFileType(options.filename, 'FILES')) {
       const fileContents = JSON.parse(fs.readFileSync(filePath, 'utf8'))
       testerCases[type][0].code = ''
@@ -150,7 +146,3 @@ function _getDictFiles(input, filenames) {
   }
   return dictFiles
 }
-
-function _isEslint9OrLater() {
-  return Number(Linter.version.split('.')[0]) >= 9
-}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap/eslint-plugin-cds",
-  "version": "3.2.0",
+  "version": "4.1.0",
   "description": "ESLint plugin including recommended SAP Cloud Application Programming model and environment rules",
   "homepage": "https://cap.cloud.sap/",
   "keywords": [
@@ -20,13 +20,13 @@
     "README.md"
   ],
   "dependencies": {
-    "@sap/cds": ">=7",
     "semver": "^7.7.1"
   },
   "peerDependencies": {
-    "eslint": ">=8"
+    "@sap/cds": ">=9",
+    "eslint": "^9"
   },
   "engines": {
-    "node": ">=18"
+    "node": ">=20"
   }
 }