@sap/eslint-plugin-cds 2.6.4 → 2.6.7

package/CHANGELOG.md

@@ -6,8 +6,25 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
+## [2.6.7] - 2024-03-11
 
-## [2.6.4] - 2023-11-02
+### 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
+
+### Fixed
+
+- Performance got improved significantly for projects with many non `.cds` files (like `.js` files)
+
+## [2.6.4] - 2023-10-31
 
 ### Added
 

package/lib/conf/all.js

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

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

@@ -15,7 +15,6 @@ const rules = {
   '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/utils/createRule.js

@@ -31,59 +31,69 @@ module.exports = (spec) => {
 
   return {
     meta,
-    create: (context) => ({
-      Program: (node) => {
-        try {
-          const file = context.getFilename()
-          if (file !== filePrev) {
-            LOG && LOG(`File: ${context.getFilename()}`)
-          }
-          const cdscontext = extendContext(node, context, meta)
-          Cache.set('context', cdscontext)
-          const { isTest, isValidFile, doEnvironmentChecks, doRootModelChecks } = checkEntryCriteria(meta, cdscontext)
-          switch (meta.model) {
-            case 'none':
-              if (doEnvironmentChecks) {
-                if (isTest || !Cache.has(`rule:${cdscontext.id}`)) {
-                  LOG && LOG(`  Model: "${meta.model}" Rule: ${context.id}`)
-                  Cache.set(`rule:${cdscontext.id}:${Cache.get('rootpath')}`, 'done')
-                  createReport(node, cdscontext, meta, create)
+    create: (context) => {
+      // do a fast check to exclude most cases, i.e. irrelevant files
+      const isRelevant =
+        context.getSourceCode().lines[0] === '' || // env. rules
+        isConfiguredFileType(context.getFilename(), 'FILES') // file rules
+      if (!isRelevant) {
+        return {}
+      }
+
+      return {
+        Program: (node) => {
+          try {
+            const file = context.getFilename()
+            if (file !== filePrev) {
+              LOG && LOG(`File: ${context.getFilename()}`)
+            }
+            const cdscontext = extendContext(node, context, meta)
+            Cache.set('context', cdscontext)
+            const { isTest, isValidFile, doEnvironmentChecks, doRootModelChecks } = checkEntryCriteria(meta, cdscontext)
+            switch (meta.model) {
+              case 'none':
+                if (doEnvironmentChecks) {
+                  if (isTest || !Cache.has(`rule:${cdscontext.id}`)) {
+                    LOG && LOG(`  Model: "${meta.model}" Rule: ${context.id}`)
+                    Cache.set(`rule:${cdscontext.id}:${Cache.get('rootpath')}`, 'done')
+                    createReport(node, cdscontext, meta, create)
+                  }
                 }
-              }
-              break
+                break
 
-            case 'inferred':
-              if (isValidFile && doRootModelChecks) {
-                if (isTest || !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')
-                  createReport(node, cdscontext, meta, create)
-                } else {
-                  if (Cache.has(`report:${context.getFilename()}:${context.id}`)) {
-                    const reports = Cache.get(`report:${context.getFilename()}:${context.id}`)
-                    for (const r of Array.from(reports)) {
-                      context.report(JSON.parse(r))
-                    }
-                    Cache.remove(`report:${context.getFilename()}:${context.id}`)
+              case 'inferred':
+                if (isValidFile && doRootModelChecks) {
+                  if (isTest || !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')
+                    createReport(node, cdscontext, meta, create)
+                  } else {
+                    if (Cache.has(`report:${context.getFilename()}:${context.id}`)) {
+                      const reports = Cache.get(`report:${context.getFilename()}:${context.id}`)
+                      for (const r of Array.from(reports)) {
+                        context.report(JSON.parse(r))
+                      }
+                      Cache.remove(`report:${context.getFilename()}:${context.id}`)
+                      Cache.set(`rule:${cdscontext.id}:${Cache.get('rootpath')}`, 'done')
+                    }
                   }
                 }
-              }
-              break
+                break
 
-            default:
-              if (isValidFile) {
-                LOG && LOG(`  Model: "${meta.model}" Rule: ${context.id}`)
-                createReport(node, cdscontext, meta, create)
-              }
-              break
+              default:
+                if (isValidFile) {
+                  LOG && LOG(`  Model: "${meta.model}" Rule: ${context.id}`)
+                  createReport(node, cdscontext, meta, create)
+                }
+                break
+            }
+            filePrev = file
+          } catch (err) {
+            console.error(err)
           }
-          filePrev = file
-        } catch (err) {
-          console.error(err)
         }
       }
-    })
+    }
   }
 }
 

package/lib/utils/isConfiguredFileType.js

@@ -1,20 +1,20 @@
 const { FILES, MODEL_FILES } = require('../constants')
 
+const regexByFileType = {
+  FILES: globArrayToRegex(FILES),
+  MODEL_FILES: globArrayToRegex(MODEL_FILES)
+}
+
 /**
  * Checks whether the given filePath matches a regex `files`
  * @param {string} filePath
  * @returns boolean
  */
 module.exports = (filePath, fileType) => {
-  const genRegex = (key) => new RegExp(`${key.map((file) => file.replace('*', '')).join('$|')}$`)
-  let isValid = false
-  switch (fileType) {
-    case 'MODEL_FILES':
-      isValid = genRegex(MODEL_FILES).test(filePath)
-      break
-    case 'FILES':
-      isValid = genRegex(FILES).test(filePath)
-      break
-  }
+  const isValid = regexByFileType[fileType].test(filePath)
   return isValid
 }
+
+function globArrayToRegex (arr) {
+  return new RegExp(`${arr.map((e) => e.replace('*', '')).join('$|')}$`)
+}

package/package.json

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

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