@sap/eslint-plugin-cds 2.6.5 → 2.7.0

package/CHANGELOG.md

@@ -6,6 +6,32 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
+## [2.7.0] - 2024-04-09
+
+### 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
+
+- Removed loading of previously removed rule.
+
+## [2.6.6] - 2024-03-11
+
+### Changed
+
+- Removed `require-2many-oncond` rule, as it is now covered by the compiler.
 
 ## [2.6.5] - 2024-01-31
 

package/lib/conf/all.js

@@ -10,11 +10,9 @@ 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,
-  '@sap/cds/require-2many-oncond': 2,
   '@sap/cds/sql-cast-suggestion': 2,
   '@sap/cds/start-elements-lowercase': 2,
   '@sap/cds/start-entities-uppercase': 2,

package/lib/conf/recommended.js

@@ -9,11 +9,9 @@ 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,
-  '@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/rules/index.js

@@ -11,11 +11,9 @@ 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')),
-  'require-2many-oncond': () => createRule(require('./require-2many-oncond')),
   'sql-cast-suggestion': () => createRule(require('./sql-cast-suggestion')),
   'start-elements-lowercase': () => createRule(require('./start-elements-lowercase')),
   'start-entities-uppercase': () => createRule(require('./start-entities-uppercase')),

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) {
@@ -63,9 +63,12 @@ module.exports = (spec) => {
 
               case 'inferred':
                 if (isValidFile && doRootModelChecks) {
-                  if (isTest || !Cache.has(`rule:${cdscontext.id}:${Cache.get('rootpath')}`)) {
+                  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')
+                      Cache.remove(`report:${context.getFilename()}:${context.id}`)
+                    }
                     createReport(node, cdscontext, meta, create)
                   } else {
                     if (Cache.has(`report:${context.getFilename()}:${context.id}`)) {
@@ -107,13 +110,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) {
@@ -230,6 +234,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap/eslint-plugin-cds",
-  "version": "2.6.5",
+  "version": "2.7.0",
   "description": "ESLint plugin including recommended SAP Cloud Application Programming model and environment rules",
   "homepage": "https://cap.cloud.sap/",
   "keywords": [

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()
-        })
-      }
-    }
-  }
-}

package/lib/rules/require-2many-oncond.js

@@ -1,22 +0,0 @@
-module.exports = {
-  meta: {
-    schema: [{/* to avoid deprecation warning for ESLint 9 */}],
-    docs: {
-      description: 'Foreign key information of a `TO MANY` relationship must be defined within the target and specified in an `ON` condition.',
-      recommended: true
-    },
-    type: 'problem'
-  },
-  create: function (context) {
-    return { element: check2manyOncond }
-
-    function check2manyOncond (e) {
-      if (e.is2many && !e.on && typeof e.target === 'string') {
-        context.report({
-          message: `You must provide an \`ON\` condition for \`TO MANY\` relationship '${e.name}'.`,
-          node: context.getNode(e)
-        })
-      }
-    }
-  }
-}