@sap/eslint-plugin-cds 2.6.7 → 3.0.2

package/CHANGELOG.md

@@ -6,6 +6,51 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
+## [3.0.2] - 2024-04-29
+
+### Fixed
+
+- Internal parser call now handles `ESLint` version 8 and 9
+
+### Changed
+
+- requires `ESLint` version 8 or above
+
+## [3.0.1] - 2024-04-25
+
+### Fixed
+
+- Add namespace `@sap/cds` to plugin configuration
+
+## [3.0.0] - 2024-04-23
+
+### Added
+
+- Support ESLint flat configurations (`eslint@v9`) and make them available as *recommended*, *all*.
+
+### Changed
+
+- Plugin configurations (*recommended*, *all*) for `eslint@<v9` are now available with the `-legacy` suffix.
+
+### Fixed
+
+- In _latest-cds-version_, get output from `npm outdated` on exit code 1.
+
+## [2.7.0] - 2024-04-12
+
+### Added
+
+- Add `getRootPath()` method to `context` object to get the project rootPath.
+
+### Changed
+
+- Rule option "show" now allows inferred rules to rerun/recompile instead of just running once (as is the CLI behavior).
+- Removed `min-node-version` rule, as it is now covered by the cds CLI.
+
+### Fixed
+
+- In _no-db-keywords_, use `getRootPath()` instead of dirname, as wrong paths lead to missing db entries, disabling the rule.
+
 ## [2.6.7] - 2024-03-11
 
 ### Fixed

package/lib/conf/all.js

@@ -10,7 +10,6 @@ module.exports = {
   '@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,

package/lib/conf/index.js

@@ -1,22 +1,44 @@
+const path = require('path')
 const { FILES, GLOBALS, PLUGIN_NAME } = require('../constants')
 const { parserPath } = require('../api')
 
-function _createConfig (config) {
+function _createConfig (plugin, configName, legacy = false) {
+  const config = require(path.join(__dirname, configName))
+  if (legacy) {
+    return {
+      root: true,
+      globals: GLOBALS,
+      plugins: [PLUGIN_NAME],
+      overrides: [
+        {
+          files: FILES,
+          parser: parserPath
+        }
+      ],
+      rules: config
+    }
+  }
   return {
-    root: true,
-    globals: GLOBALS,
-    plugins: [PLUGIN_NAME],
-    overrides: [
-      {
-        files: FILES,
-        parser: parserPath
-      }
-    ],
+    languageOptions: {
+      globals: GLOBALS,
+      parser: require(parserPath)
+    },
+    plugins: {
+      '@sap/cds': plugin
+    },
+    files: FILES.map(file => file.replace('*.', '**/*.')),
     rules: config
   }
 }
 
-module.exports = {
-  all: _createConfig(require('./all')),
-  recommended: _createConfig(require('./recommended'))
+// Export both eslintrc and flat configs to ensure backwards compatibility (<eslint@v9):
+// https://eslint.org/docs/latest/extend/plugin-migration-flat-config#backwards-compatibility
+module.exports = function (plugin) {
+  return {
+    all: _createConfig(plugin, 'all'),
+    recommended: _createConfig(plugin, 'recommended'),
+    // Legacy configs (for backwards compatibility)
+    'all-legacy': _createConfig(plugin, 'all', true),
+    'recommended-legacy': _createConfig(plugin, 'recommended', true)
+  }
 }

package/lib/conf/recommended.js

@@ -9,7 +9,6 @@ module.exports = {
   '@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,

package/lib/index.js

@@ -15,15 +15,30 @@
  * - Expose any 'rules' for use in ESLint
  */
 
+const path = require('node:path')
+
 const api = require('./api')
+const getConfigs = require('./conf')
 const rules = Object.assign(
   {},
   ...Object.entries(require('./rules')).map(([k, v]) => ({ [k]: v() }))
 )
-const configs = require('./conf')
 
-module.exports = {
-  configs,
+const packageJson = require(path.join(__dirname, '../package.json'))
+
+const plugin = {
+  meta: {
+    name: packageJson.name,
+    version: packageJson.version
+  },
+  configs: {},
   rules,
   ...api
 }
+
+// Assign configs here so we can reference `plugin`
+Object.assign(plugin.configs, getConfigs(plugin))
+
+// Use commonJS entry point to ensure backwards compatibility (<eslint@v9):
+// https://eslint.org/docs/latest/extend/plugin-migration-flat-config#backwards-compatibility
+module.exports = plugin

package/lib/parser.js

@@ -28,7 +28,7 @@ module.exports = {
           const messages = []
           try {
             compiledModel = cds.parse(code)
-          } catch (err) {
+          } catch (_err) {
             // Do nothing
           }
           if (compiledModel) {

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

@@ -57,7 +57,7 @@ module.exports = {
           if (whereValues && typeof whereValues === 'string') {
             try {
               cds.parse.expr(entry.where)
-            } catch (err) {
+            } catch (_err) {
               context.report({
                 message: 'Invalid `where` expression, CDS compilation failed.',
                 node,

package/lib/rules/index.js

@@ -11,7 +11,6 @@ const rules = {
   'auth-valid-restrict-to': () => createRule(require('./auth-valid-restrict-to')),
   'auth-valid-restrict-where': () => createRule(require('./auth-valid-restrict-where')),
   'latest-cds-version': () => createRule(require('./latest-cds-version')),
-  'min-node-version': () => createRule(require('./min-node-version')),
   'no-db-keywords': () => createRule(require('./no-db-keywords')),
   'no-dollar-prefixed-names': () => createRule(require('./no-dollar-prefixed-names')),
   'no-join-on-draft': () => createRule(require('./no-join-on-draft')),

package/lib/rules/latest-cds-version.js

@@ -22,12 +22,14 @@ module.exports = {
       let cdsVersions
       let e = context.getEnvironment()
       if (!e) {
-        e = cp
-          .execSync('npm outdated @sap/cds --json', {
+        try {
+          cp.execSync('npm outdated @sap/cds --json', {
             cwd: process.cwd(),
             stdio: 'pipe'
-          })
-          .toString()
+          }).toString()
+        } catch (err) {
+          e = JSON.parse(err.stdout.toString())
+        }
       }
       if (e && e['@sap/cds']) {
         cdsVersions = e['@sap/cds']

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

@@ -1,5 +1,3 @@
-const { dirname } = require('path')
-
 const cds = require('@sap/cds')
 
 module.exports = {
@@ -13,9 +11,9 @@ module.exports = {
     model: 'inferred'
   },
   create (context) {
-    let dir = context.getFilename()
-    dir = dirname(dir)
-    const { requires } = cds.env.for('cds', dir)
+    const rootPath = context.getRootPath()
+    if (!rootPath) return
+    const { requires } = cds.env.for('cds', rootPath)
     if (requires.db?.kind !== 'sqlite') return
 
     return {

package/lib/utils/createRule.js

@@ -49,7 +49,7 @@ module.exports = (spec) => {
             }
             const cdscontext = extendContext(node, context, meta)
             Cache.set('context', cdscontext)
-            const { isTest, isValidFile, doEnvironmentChecks, doRootModelChecks } = checkEntryCriteria(meta, cdscontext)
+            const { isTest, isValidFile, doEnvironmentChecks, doRootModelChecks, showInEditor } = checkEntryCriteria(meta, cdscontext)
             switch (meta.model) {
               case 'none':
                 if (doEnvironmentChecks) {
@@ -62,10 +62,17 @@ module.exports = (spec) => {
                 break
 
               case 'inferred':
-                if (isValidFile && doRootModelChecks) {
-                  if (isTest || !Cache.has(`rule:${cdscontext.id}:${Cache.get('rootpath')}`)) {
+                if (isValidFile && (doRootModelChecks)) {
+                  if (showInEditor) {
+                    Cache.remove(`model:${Cache.get('rootpath')}`)
+                    Cache.remove(`rule:${cdscontext.id}:${Cache.get('rootpath')}`)
+                    Cache.remove(`report:${context.getFilename()}:${context.id}`)
+                  }
+                  if (isTest || showInEditor || Cache.has(`rule:${cdscontext.id}:${Cache.get('rootpath')}`)) {
                     LOG && LOG(`  Model: "${meta.model}" Rule: ${context.id}`)
-                    Cache.set(`rule:${cdscontext.id}:${Cache.get('rootpath')}`, 'done')
+                    if (!showInEditor) {
+                      Cache.set(`rule:${cdscontext.id}:${Cache.get('rootpath')}`, 'done')
+                    }
                     createReport(node, cdscontext, meta, create)
                   } else {
                     if (Cache.has(`report:${context.getFilename()}:${context.id}`)) {
@@ -107,13 +114,14 @@ function isRunningWithESLint () {
 
 function checkEntryCriteria (meta, cdscontext) {
   const isTest = Cache.has('test')
+  const showInEditor = cdscontext.options.includes('show')
   const hasProjectRoots = Cache.has(`roots:${Cache.get('rootpath')}`)
   const isValidFile = isConfiguredFileType(cdscontext.getFilename(), 'FILES')
-  const doRootModelChecks = isTest || (hasProjectRoots && (isRunningWithCDSLint() || isRunningWithESLint() || cdscontext.options.includes('show')))
-  // Also lint empty folders (i.e. lintText "" API)
+  const doRootModelChecks = isTest || (hasProjectRoots && (isRunningWithCDSLint() || isRunningWithESLint()) || showInEditor)
+  // Lint all env rules independent of any parsed file (i.e. 'cds lint' uses the lintText "" API)
   const doEnvironmentChecks =
-    isTest || (hasProjectRoots && isRunningWithCDSLint() && cdscontext.getSourceCode().lines[0] === '')
-  return { isTest, isValidFile, doRootModelChecks, doEnvironmentChecks }
+    isTest || (isRunningWithCDSLint() && cdscontext.getFilename() === '<text>')
+  return { isTest, isValidFile, doRootModelChecks, doEnvironmentChecks, showInEditor }
 }
 
 function setMetaDefaults (meta) {
@@ -158,8 +166,8 @@ function createReport (node, cdscontext, meta, create) {
             const isValidLocation = (meta.model === 'parsed' && d.$location) ||
               (meta.model === 'inferred' && d.$location?.file)
             Object.entries(handlers)
-              .filter(([type, lazy]) => d.is(type) && isValidLocation)
-              .forEach(([lazy, handler]) => {
+              .filter(([type, _lazy]) => d.is(type) && isValidLocation)
+              .forEach(([_lazy, handler]) => {
                 try {
                   handler(d)
                 } catch (err) {
@@ -230,6 +238,7 @@ function extendContext (node, context, meta) {
   }
   cdscontext.getLocation = parserServices.getLocation
   cdscontext.getNode = Object.keys(parserServices).length > 0 ? parserServices.getNode : () => node
+  cdscontext.getRootPath = () => Cache.get('rootpath')
   return cdscontext
 }
 

package/lib/utils/genDocs.js

@@ -166,7 +166,7 @@ function getPackageVersion (registry) {
         stdio: 'pipe'
       })
       .toString()
-  } catch (err) {
+  } catch (_err) {
     LOG?.(`Failed to connect to ${registry} - check your connection and try again.`)
     exit(0)
   }
@@ -231,7 +231,7 @@ function getRules (docsPath, rulePath, testPath, versionRequired = '0.0.0', rele
         }
         try {
           mdRule = getRuleExamples(rule, ruleTestPath, testPath, rulesEntry)
-        } catch (err) {
+        } catch (_err) {
           // Just continue
         }
         mdRuleContents = ''

package/lib/utils/getConfigPath.js

@@ -9,16 +9,23 @@
 const fs = require('fs')
 const path = require('path')
 
-module.exports = (currentDir = '.') => {
-  const configFiles = [
-    '.eslintrc.js',
-    '.eslintrc.cjs',
-    '.eslintrc.yaml',
-    '.eslintrc.yml',
-    '.eslintrc.json',
-    '.eslintrc',
-    'package.json'
+module.exports = (currentDir = '.', legacy=false) => {
+  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/runRuleTester.js

@@ -1,7 +1,7 @@
 const fs = require('fs')
 const path = require('path')
 
-const { RuleTester } = require('eslint')
+const { Linter, RuleTester } = require('eslint')
 const Cache = require('./Cache')
 const createRule = require('./createRule')
 const isConfiguredFileType = require('./isConfiguredFileType')
@@ -17,13 +17,13 @@ const { compileModelFromDict } = require('../parser')
  * @returns RuleTester results
  */
 module.exports = (options) => {
-  let parser
+  let parserPath
   let rule = {}
   Cache.set('rules', require(path.join(__dirname, '../rules')))
   const rulename = path.basename(options.root)
   if (options.root.startsWith(path.resolve(__dirname, '../..'))) {
     // For plugin's internal tests, resolve parser from here
-    parser = require.resolve('../parser')
+    parserPath = require.resolve('../parser')
     const pluginPath = path.join(path.dirname(options.root), '../..')
     rule = createRule(require(`../rules/${path.basename(options.root)}`))
     Cache.set('pluginpath', pluginPath)
@@ -32,15 +32,22 @@ module.exports = (options) => {
     const resolvedPlugin = require.resolve('@sap/eslint-plugin-cds', {
       paths: [options.root]
     })
-    parser = path.join(path.dirname(resolvedPlugin), 'parser')
+    parserPath = path.join(path.dirname(resolvedPlugin), 'parser')
     rule = require(path.join(options.root, `../../rules/${path.basename(options.root)}`))
     const pluginPath = path.join(path.dirname(options.root), '../../..')
     Cache.set('pluginpath', pluginPath)
   }
   let tester = new RuleTester({})
-  if (parser) {
-    tester = new RuleTester({ parser })
+  if (parserPath) {
+    let options
+    if (Number(Linter.version.split('.')[0]) >= 9) {
+      options = { languageOptions: { parser: require(parserPath) } }
+    } else {
+      options = { parser: parserPath }
+    }
+    tester = new RuleTester(options)
   }
+
   const testerCases = {};
   ['valid', 'invalid'].forEach((type) => {
     const filePath = path.join(options.root, `${type}/${options.filename}`)
@@ -79,7 +86,7 @@ module.exports = (options) => {
 /**
  * Creates a model for ESLint unit tests
  */
-function _initModelRuleTester (filePath, flavor) {
+function _initModelRuleTester(filePath, flavor) {
   Cache.set('test', true)
   const rootPath = path.dirname(filePath)
   Cache.set('rootpath', rootPath)
@@ -101,7 +108,7 @@ function _initModelRuleTester (filePath, flavor) {
    * @param files
    * @returns dictFiles
    */
-function _getDictFiles (input, files) {
+function _getDictFiles(input, files) {
   let dictFiles = {}
   if (Cache.has(`dictfiles:${input}`)) {
     dictFiles = Cache.get(`dictfiles:${input}`)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap/eslint-plugin-cds",
-  "version": "2.6.7",
+  "version": "3.0.2",
   "description": "ESLint plugin including recommended SAP Cloud Application Programming model and environment rules",
   "homepage": "https://cap.cloud.sap/",
   "keywords": [
@@ -23,14 +23,8 @@
     "@sap/cds": ">=5.6.0",
     "semver": "^7.3.4"
   },
-  "eslintConfig": {
-    "extends": [
-      "eslint:recommended",
-      "standard"
-    ]
-  },
   "peerDependencies": {
-    "eslint": ">=7"
+    "eslint": ">=8"
   },
   "engines": {
     "node": ">=18"

package/lib/rules/min-node-version.js

@@ -1,48 +0,0 @@
-const path = require('path')
-const semver = require('semver')
-
-module.exports = {
-  meta: {
-    schema: [{/* to avoid deprecation warning for ESLint 9 */}],
-    docs: {
-      description: 'Checks whether the minimum Node.js version required by `@sap/cds` is achieved.'
-    },
-    severity: 'off',
-    type: 'problem',
-    model: 'none'
-  },
-  create: function (context) {
-    return checkMinNodeVersion
-
-    function checkMinNodeVersion () {
-      const e = context.getEnvironment()
-      let nodeVersion, nodeVersionCDS
-      if (!e) {
-        // Get current and required node versions
-        try {
-          const CDSPath = require.resolve('@sap/cds/package.json', {
-            paths: [path.dirname('.')]
-          })
-          const jsonCDS = require(CDSPath)
-          nodeVersion = process.version
-          nodeVersionCDS = jsonCDS.engines.node
-        } catch (err) {
-          // Do not throw
-        }
-      } else {
-        nodeVersion = e.nodeVersion
-        nodeVersionCDS = e.nodeVersionCDS
-      }
-      if (
-        nodeVersion &&
-        nodeVersionCDS &&
-        !semver.satisfies(nodeVersion, nodeVersionCDS, { loose: true })
-      ) {
-        context.report({
-          message: `CDS minimum node version of ${nodeVersionCDS} required, found ${nodeVersion}!`,
-          node: context.getNode()
-        })
-      }
-    }
-  }
-}