@sap/eslint-plugin-cds 3.1.2 → 4.0.2

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/{getProjectRootPath.js → projectRootPath.js}

@@ -2,13 +2,13 @@
 
 const path = require('node:path')
 const cds = require('@sap/cds')
-const Cache = require('./Cache')
+const { globalCache } = require('./Cache')
 const fs = require('node:fs')
 
 const commonCapProjectFiles = ['build.gradle', '.git', 'srv', 'db', 'app']
 
 /**
- * Searches for directory containing cds roots
+ * Searches for a directory containing cds roots.
  *
  * As of today, there is no unified way to find the root directory for a CDS project.
  * ("The root is wherever the user typed `cds init`")
@@ -20,9 +20,8 @@ const commonCapProjectFiles = ['build.gradle', '.git', 'srv', 'db', 'app']
  * @param {string} currentDir start here and search until root dir
  * @returns {string} dir containing cds roots (empty if not exists)
  */
-module.exports = function getProjectRootPath(currentDir = '.') {
+function getProjectRootPath(currentDir = '.') {
   let dir = path.resolve(currentDir)
-
   while (!couldBeProjectRoot(dir)) {
     if (dir === path.resolve(dir, '..'))
       return '' // we reached the file system root -> abort
@@ -32,7 +31,7 @@ module.exports = function getProjectRootPath(currentDir = '.') {
   cds.resolve.cache = {}
   const roots = cds.resolve('*', { root: dir })
   if (roots?.length > 0) {
-    Cache.set(`roots:${dir}`, roots)
+    globalCache.set(`roots:${dir}`, roots)
     return dir
   }
   return ''
@@ -56,8 +55,21 @@ function isRootPackageJson(filepath) {
 
   try {
     const config = JSON.parse(fs.readFileSync(filepath, 'utf8'))
-    return Object.keys(config?.dependencies ?? {}).some(dep => dep === '@sap/cds')
+    return config && (config.cds ||
+      hasCdsPackage(config.dependencies) ||
+      hasCdsPackage(config.peerDependencies) ||
+      hasCdsPackage(config.devDependencies))
+
   } catch {
     return false
   }
 }
+
+function hasCdsPackage(deps) {
+  return deps && (('@sap/cds' in deps) || ('@sap/cds-dk' in deps))
+}
+
+module.exports = {
+  getProjectRootPath,
+  hasProjectRoots: () => globalCache.has(`roots:${globalCache.get('rootpath')}`),
+}

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,8 +5,8 @@
 const fs = require('node:fs')
 const path = require('node:path')
 
-const { Linter, RuleTester } = require('eslint')
-const Cache = require('./Cache')
+const { RuleTester } = require('eslint')
+const { globalCache } = require('./Cache')
 const isConfiguredFileType = require('./isConfiguredFileType')
 const { compileModelFromDict } = require('../parser')
 const rules = require('../rules')
@@ -29,7 +29,7 @@ function testRuleWrapper(rule) {
         _initModelRuleTester(filePath, rule.meta.model)
         const createValue = rule.create(context)
         const result = createValue.Program(node)
-        Cache.clear()
+        globalCache.clear()
         return result
       }
     }
@@ -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 = ''
@@ -114,18 +110,18 @@ module.exports = function runRuleTester(options) {
  * @param {string} flavor
  */
 function _initModelRuleTester(filePath, flavor) {
-  Cache.set('rules', rules)
-  Cache.set('test', true)
+  globalCache.set('rules', rules)
+  globalCache.set('test', true)
   const rootPath = path.dirname(filePath)
-  Cache.set('rootpath', rootPath)
+  globalCache.set('rootpath', rootPath)
   if (flavor !== 'none') { // not for env rules
     const files = fs.readdirSync(rootPath)
     const modelfiles = files.map(f => path.join(rootPath, f)).filter(fp => isConfiguredFileType(fp, 'MODEL_FILES'))
-    Cache.set(`modelfiles:${rootPath}`, modelfiles)
+    globalCache.set(`modelfiles:${rootPath}`, modelfiles)
     const dictFiles = _getDictFiles(rootPath, modelfiles)
-    Cache.set(`dictfiles:${rootPath}`, dictFiles)
+    globalCache.set(`dictfiles:${rootPath}`, dictFiles)
     const reflectedModel = compileModelFromDict(dictFiles, { flavor })
-    Cache.set(`model:${rootPath}`, reflectedModel)
+    globalCache.set(`model:${rootPath}`, reflectedModel)
   }
 }
 
@@ -139,18 +135,14 @@ function _initModelRuleTester(filePath, flavor) {
  */
 function _getDictFiles(input, filenames) {
   let dictFiles = {}
-  if (Cache.has(`dictfiles:${input}`)) {
-    dictFiles = Cache.get(`dictfiles:${input}`)
+  if (globalCache.has(`dictfiles:${input}`)) {
+    dictFiles = globalCache.get(`dictfiles:${input}`)
   } else {
     filenames.forEach(file => {
-      dictFiles[file] = Cache.has(`file:${file}`)
-        ? Cache.get(`file:${file}`)
+      dictFiles[file] = globalCache.has(`file:${file}`)
+        ? globalCache.get(`file:${file}`)
         : fs.readFileSync(file, 'utf8')
     })
   }
   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.1.2",
+  "version": "4.0.2",
   "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.3.4"
+    "semver": "^7.7.1"
   },
   "peerDependencies": {
-    "eslint": ">=8"
+    "@sap/cds": ">=9",
+    "eslint": "^9"
   },
   "engines": {
-    "node": ">=18"
+    "node": ">=20"
   }
 }