@sap/eslint-plugin-cds 2.3.4 → 2.3.5

package/CHANGELOG.md

@@ -6,6 +6,13 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
+## [2.3.5] - 2022-04-05
+
+### Changed
+
+- Catch root model compilation errors and do not try again on every file (-> long lint times for broken models)
+- Add to lint reports with rules marked with '!'
+
 ## [2.3.4] - 2022-03-31
 
 ### Changed

package/lib/utils/model.js

@@ -203,17 +203,23 @@ module.exports = {
    * @returns reflected model
    */
   compileModelFromPath: function (configPath) {
+    let compiledModel;
     let reflectedModel;
     cds.resolve.cache = {};
     const roots = cds.resolve("*", { root: configPath });
     const messages = [];
     if (roots) {
-      const compiledModel = cds.load(roots, {
+      try {
+      compiledModel = cds.load(roots, {
         cwd: configPath,
         sync: true,
         locations: true,
         messages,
       });
+      module.exports.Cache.remove('errRootModel');
+      } catch (err) {
+        module.exports.Cache.set('errRootModel', err);
+      }
       if (compiledModel) {
         reflectedModel = cds.linked(compiledModel);
         if (messages) {
@@ -380,6 +386,7 @@ module.exports = {
     dictFiles[filePath] = code;
     module.exports.Cache.set(`dictfiles:${configPath}`, dictFiles);
     reflectedModel = module.exports.compileModelFromDict(dictFiles, { flavor: "inferred" });
+    if (reflectedModel) { module.exports.Cache.remove('errRootModel') }
     module.exports.Cache.set(`model:${configPath}`, reflectedModel);
     return reflectedModel;
   }

package/lib/utils/rules.js

@@ -160,37 +160,43 @@ function createRule(spec) {
     create: (context) => ({
       Program: function (node) {
         const cdscontext = addCDSContext(context, node, meta);
-
-        try {
-          const { report, ...ruleDescriptors } = cdscontext;
-          const handlers = create({ ...ruleDescriptors, report: (r) => report(r) });
-
-          // Report descriptors with fake visitor 'all'
-          // Used for environment rules and rules which require another compiled model
-          // (i.e. sql or odata)
-          if (handlers.all) {
-            let reportDescriptor = handlers.all();
-            doReport(cdscontext, reportDescriptor);
-          } else {
-            // TODO: Use external address
-            // Report descriptors with visitors using using `any.is()`
-            // https://pages.github.tools.sap/cap/docs/node.js/cds-reflect
-            if (cdscontext.cds.model) {
-              cdscontext.cds.model.forall((d) =>
-                Object.entries(handlers)
-                  .filter(([type, lazy]) => d.is(type))
-                  .forEach(([lazy, handler]) => doReport(cdscontext, handler(d), d))
-              );
+        const lintWithCDSLinter = isValidFile(cdscontext.filePath, 'FILES');
+
+        if (lintWithCDSLinter || Cache.has("test") ) {
+          try {
+            const { report, ...ruleDescriptors } = cdscontext;
+            const handlers = create({ ...ruleDescriptors, report: (r) => report(r) });
+
+            // Report descriptors with fake visitor 'all'
+            // Used for environment rules and rules which require another compiled model
+            // (i.e. sql or odata)
+            if (handlers.all) {
+              let reportDescriptor = handlers.all();
+              doReport(cdscontext, reportDescriptor);
+            } else {
+              // TODO: Use external address
+              // Report descriptors with visitors using using `any.is()`
+              // https://pages.github.tools.sap/cap/docs/node.js/cds-reflect
+              if (cdscontext.cds.model) {
+                cdscontext.cds.model.forall((d) =>
+                  Object.entries(handlers)
+                    .filter(([type, lazy]) => d.is(type))
+                    .forEach(([lazy, handler]) => doReport(cdscontext, handler(d), d))
+                );
+              }
+            }
+            if (Cache.has(`errRootModel`)) {
+              reportCompilationErr(meta, node, cdscontext, Cache.get('errRootModel'));
+            }
+          } catch (err) {
+            // Report errors in ESLint style
+            if (err.messages) {
+              // Always show model compile errors
+              reportCompilationErr(meta, node, cdscontext, err);
+            } else {
+              // Thrown errors are only shown on console with --debug
+              reportErr(meta, node, cdscontext, err);
             }
-          }
-        } catch (err) {
-          // Report errors in ESLint style
-          if (err.messages) {
-            // Always show model compile errors
-            reportCompilationErr(meta, node, cdscontext, err);
-          } else {
-            // Thrown errors are only shown on console with --debug
-            reportErr(meta, node, cdscontext, err);
           }
         }
       },

package/package.json

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