@sap/eslint-plugin-cds 2.2.1 → 2.2.2

package/lib/impl/rules/assoc2many-ambiguous-key.js

@@ -11,9 +11,13 @@ module.exports = require("../../api").createRule({
     let csnOdata;
     const m = context.cds.model;
     if (m && m.definitions) {
-      csnOdata = context.cds.compile.for.odata(m);
-      const csnOdataLinked = context.cds.linked(csnOdata);
-      associationCardinalityFlaw(csnOdataLinked, context);
+      try {
+        csnOdata = context.cds.compile.for.odata(m);
+        const csnOdataLinked = context.cds.linked(csnOdata);
+        associationCardinalityFlaw(csnOdataLinked, context);
+      } catch (err) {
+        // Don't continue with rule if model fails to compile
+      }
     }
   },
 });
@@ -32,7 +36,10 @@ function associationCardinalityFlaw(csn, context) {
         refPlainElement = false;
       },
       (refEntity, refElement) => {
-        if (refElement.type === "cds.Association" || refElement.type === "cds.Composition") {
+        if (
+          refElement.type === "cds.Association" ||
+          refElement.type === "cds.Composition"
+        ) {
           if (refElement.cardinality && refElement.cardinality.max === "*") {
             refCardinalityMult = true;
           }
@@ -80,16 +87,21 @@ function processEntity(csn, eachCallback) {
       const sourceAlias = [];
       if (definition.query.SELECT.from.ref) {
         // From
-        sourceEntity = csn.definitions[definition.query.SELECT.from.ref.join("_")];
+        sourceEntity =
+          csn.definitions[definition.query.SELECT.from.ref.join("_")];
         sourceAlias.push({
           from: sourceEntity.name,
           as:
             definition.query.SELECT.from.as ||
             definition.query.SELECT.from.ref.slice(-1)[0].split(".").pop(),
         });
-      } else if (definition.query.SELECT.from.args && definition.query.SELECT.from.args[0].ref) {
+      } else if (
+        definition.query.SELECT.from.args &&
+        definition.query.SELECT.from.args[0].ref
+      ) {
         // Join
-        sourceEntity = csn.definitions[definition.query.SELECT.from.args[0].ref.join("_")];
+        sourceEntity =
+          csn.definitions[definition.query.SELECT.from.args[0].ref.join("_")];
         definition.query.SELECT.from.args.forEach((arg) => {
           sourceAlias.push({
             from: arg.ref.join("_"),
@@ -136,12 +148,18 @@ function processElement(
             if (!refElement && definition.query.SELECT.mixin) {
               refElement = definition.query.SELECT.mixin[ref];
               if (!refElement && definition.query.SELECT.mixin[column.ref[0]]) {
-                refElement = definition.query.SELECT.mixin[column.ref[0]]._target.elements[ref];
+                refElement =
+                  definition.query.SELECT.mixin[column.ref[0]]._target.elements[
+                    ref
+                  ];
               }
             }
           }
           eachCallback(refEntity, refElement);
-          if (refElement.type === "cds.Association" || refElement.type === "cds.Composition") {
+          if (
+            refElement.type === "cds.Association" ||
+            refElement.type === "cds.Composition"
+          ) {
             refEntity = csn.definitions[refElement.target];
           }
         }

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

@@ -14,7 +14,7 @@ module.exports = require("../../api").createRule({
       latestCDSVersion: `A newer CDS version is available!`,
     },
   },
-  create: function(context) {
+  create: function (context) {
     let result;
     let cdsVersions;
     const e = context.cds.environment;
@@ -39,9 +39,8 @@ module.exports = require("../../api").createRule({
     ) {
       // Add to ESLint report
       context.report({
-        messageId: 'latestCDSVersion',
-        loc: { line: 0, column: 0 },
+        messageId: "latestCDSVersion",
       });
     }
-  }
-});
+  },
+});

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

@@ -36,7 +36,6 @@ module.exports = require("../../api").createRule({
     ) {
       context.report({
         message: `CDS minimum node version of ${nodeVersionCDS} required, found ${nodeVersion}!`,
-        loc: { line: 0, column: 1 },
       });
     }
   },

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

@@ -1,25 +1,35 @@
 module.exports = require("../../api").defineRule({
-  meta: { docs: { description: `Avoid using reserved SQL keywords.` }},
-  create (context) {
-    const { db = { kind: 'sql' } } = context.cds.env.requires
-    function _check (d) {
+  meta: {
+    docs: {
+      description: `Avoid using reserved SQL keywords.`,
+      category: "Model Validation",
+    },
+  },
+  create(context) {
+    const { db = { kind: "sql" } } = context.cds.env.requires;
+    function _check(d) {
       if (d.name in RESERVED) {
-
         // Do not blame in case of external services
-        let srv = d._service || d.parent && d.parent._service
-        if (srv && srv['@cds.external']) return
+        let srv = d._service || (d.parent && d.parent._service);
+        if (srv && srv["@cds.external"]) return;
 
         // Do blame
-        return `'${d.name}' is a reserved keyword in ${db.kind.toUpperCase()}`
+        return `'${d.name}' is a reserved keyword in ${db.kind.toUpperCase()}`;
       }
     }
-    return { entity: _check, element: _check }
-  }
-})
+    return { entity: _check, element: _check };
+  },
+});
 
 // REVISIT: Replace by compiler-provided check
 const RESERVED = {
-  ORDER: 1, Order: 1, order: 1,
-  GROUP: 1, Group: 1, group: 1,
-  LIMIT: 1, Limit: 1, limit: 1,
-}
+  ORDER: 1,
+  Order: 1,
+  order: 1,
+  GROUP: 1,
+  Group: 1,
+  group: 1,
+  LIMIT: 1,
+  Limit: 1,
+  limit: 1,
+};

package/lib/impl/rules/no-join-on-draft-enabled-entities.js

@@ -0,0 +1,35 @@
+module.exports = require("../../api").createRule({
+  meta: {
+    docs: {
+      description: `Draft-enabled entities shall not be used in views that make use of \`JOIN\`.`,
+      category: "Model Validation",
+      version: "2.2.1",
+    },
+    type: "suggestion",
+    messages: {
+      noJoinOnDraftEnabledEntities: `Do not use draft-enabled entities in views that make use of \`JOIN\`.`,
+    },
+  },
+  create: function (context) {
+    const m = context.cds.model;
+    m.foreach("entity", (entity) => {
+      if (entity["@odata.draft.enabled"]) {
+        if (entity.query.SELECT.from.join) {
+          const location = entity.query.$location;
+          if (context.sourcecode.lines[location.line - 1]) {
+            const endCol = context.sourcecode.lines[location.line - 1].length;
+            const loc = {
+              start: { line: location.line, column: location.col - 1 },
+              end: { line: location.line, column: endCol },
+            };
+            context.report({
+              messageId: "noJoinOnDraftEnabledEntities",
+              loc,
+              file: entity.$location.file,
+            });
+          }
+        }
+      }
+    });
+  },
+});

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

@@ -7,7 +7,7 @@ module.exports = require("../../api").createRule({
     },
     type: "problem",
   },
-  create: function(context) {
+  create: function (context) {
     const m = context.cds.model;
     m.forall((d) => {
       if (d.name) {

package/lib/impl/rules/rule.hbs

@@ -1,13 +1,20 @@
 // @ts-check
 module.exports = require("../../api").createRule({
-  meta: {docs: {
-    description: "{{description}}",
-    version: "{{version}}"
-  }},
+  meta: {
+    docs: {
+      description: "{{description}}",
+      version: "{{version}}"
+      },
+      type:"{{type}}",
+  },
   create: function(context) {
-    return [{
-      message: "{{messages}}",
-      loc: {{loc}}
-    }];
+    const m = cotext.cds.model;
+    m.forall((d)) => {
+      // Add cds logic here, for example
+      return [{
+        message: "{{messages}}",
+        loc: {{loc}}
+      }];
+    }
   }
 })

package/lib/impl/rules/sql-cast-suggestion.js

@@ -8,7 +8,8 @@ module.exports = require("../../api").createRule({
     type: "suggestion",
     hasSuggestions: true,
     messages: {
-      missingSQLCast: "Potential issue - Missing SQL cast for column expression?",
+      missingSQLCast:
+        "Potential issue - Missing SQL cast for column expression?",
     },
   },
   create: function (context) {
@@ -26,7 +27,8 @@ module.exports = require("../../api").createRule({
                   continue;
                 } else {
                   if (context.sourcecode.lines[location.line - 1]) {
-                    const endCol = context.sourcecode.lines[location.line - 1].length;
+                    const endCol =
+                      context.sourcecode.lines[location.line - 1].length;
                     const loc = {
                       start: { line: location.line, column: location.col - 1 },
                       end: { line: location.line, column: endCol },

package/lib/impl/rules/start-elements-lowercase.js

@@ -8,7 +8,8 @@ module.exports = require("../../api").createRule({
     type: "suggestion",
     hasSuggestions: true,
     messages: {
-      startLowercase: "Element name '{{entityName}}.{{elementName}}' should start with a lowercase letter.",
+      startLowercase:
+        "Element name '{{entityName}}.{{elementName}}' should start with a lowercase letter.",
     },
     fixable: "code",
   },
@@ -21,7 +22,9 @@ module.exports = require("../../api").createRule({
           const element = d.elements[elementName];
           if (
             elementName &&
-            !(entityName.startsWith("localized") || entityName.endsWith("texts"))
+            !(
+              entityName.startsWith("localized") || entityName.endsWith("texts")
+            )
           ) {
             if (
               elementName.charAt(0) !== elementName.charAt(0).toLowerCase() &&
@@ -37,8 +40,13 @@ module.exports = require("../../api").createRule({
                     line: loc.end.line,
                     column: loc.end.column,
                   });
-                  const rangeBeg = rangeEnd ? rangeEnd - elementNameSanitized.length : 0;
-                  return fixer.replaceTextRange([rangeBeg, rangeEnd], elementNameSanitized);
+                  const rangeBeg = rangeEnd
+                    ? rangeEnd - elementNameSanitized.length
+                    : 0;
+                  return fixer.replaceTextRange(
+                    [rangeBeg, rangeEnd],
+                    elementNameSanitized
+                  );
                 };
                 context.report({
                   messageId: "startLowercase",
@@ -47,7 +55,7 @@ module.exports = require("../../api").createRule({
                   fix,
                   data: {
                     entityName,
-                    elementName
+                    elementName,
                   },
                   suggest: [
                     {

package/lib/impl/rules/start-entities-uppercase.js

@@ -8,7 +8,8 @@ module.exports = require("../../api").createRule({
     type: "suggestion",
     hasSuggestions: true,
     messages: {
-      startUppercase: "Entity name '{{entityName}}' should start with an uppercase letter.",
+      startUppercase:
+        "Entity name '{{entityName}}' should start with an uppercase letter.",
     },
     fixable: "code",
   },
@@ -19,7 +20,10 @@ module.exports = require("../../api").createRule({
         let entityName = e.name;
         const names = entityName.split(".");
         entityName = names[names.length - 1];
-        if (entityName && !(entityName.startsWith("localized") || entityName.endsWith("texts"))) {
+        if (
+          entityName &&
+          !(entityName.startsWith("localized") || entityName.endsWith("texts"))
+        ) {
           if (entityName.charAt(0) !== entityName.charAt(0).toUpperCase()) {
             if (e.$location && e.$location.file) {
               const file = e.$location.file;
@@ -31,8 +35,13 @@ module.exports = require("../../api").createRule({
                   line: loc.end.line,
                   column: loc.end.column,
                 });
-                const rangeBeg = rangeEnd ? rangeEnd - entityNameSanitized.length : 0;
-                return fixer.replaceTextRange([rangeBeg, rangeEnd], entityNameSanitized);
+                const rangeBeg = rangeEnd
+                  ? rangeEnd - entityNameSanitized.length
+                  : 0;
+                return fixer.replaceTextRange(
+                  [rangeBeg, rangeEnd],
+                  entityNameSanitized
+                );
               };
               context.report({
                 messageId: "startUppercase",

package/lib/impl/utils/helpers.js

@@ -1,17 +1,6 @@
-const { files } = require("../constants");
+const { files, envFiles, modelFiles } = require("../constants");
 
 module.exports = {
-  /**
-   * Checks whether plugin is used in 'test' mode
-   * @returns boolean
-   */
-  isTest: function () {
-    let isTest = false;
-    if (process.argv[1].includes("jest") || process.argv[1].includes("mocha")) {
-      isTest = true;
-    }
-    return isTest;
-  },
 
   /**
    * Checks whether the given file path contains a file extension allowed by
@@ -19,15 +8,23 @@ module.exports = {
    * @param {string} filePath
    * @returns boolean
    */
-  isValidFile: function (filePath) {
-    const regex = new RegExp(
-      `${files
-        .map((file) => {
-          return file.replace("*", "");
-        })
-        .join("$|")}$`
-    );
-    return regex.test(filePath);
+  isValidFile: function (filePath, key = "") {
+    function genRegex(key) {
+      return new RegExp(
+        `${key
+          .map((file) => {
+            return file.replace("*", "");
+          })
+          .join("$|")}$`
+      );
+    }
+    if (key === "model") {
+      return genRegex(modelFiles).test(filePath);
+    } else if (key === "env") {
+      return genRegex(envFiles).test(filePath);
+    } else {
+      return genRegex(files).test(filePath);
+    }
   },
 
   /**
@@ -38,6 +35,15 @@ module.exports = {
     return process.argv.join(" ").includes("dbaeumer.vscode-eslint");
   },
 
+  /**
+   * Returns an array of allowed file extensions
+   * the plugin can parse of the form "*.ext"
+   * @returns {ConfigOverrideFiles} Array of file extensions
+   */
+  getFileExtensions: function () {
+    return files;
+  },
+
   /**
    * Prints a formatted message string according to the styles provided
    * @param msg message to print
@@ -59,31 +65,4 @@ module.exports = {
     });
     return `${msgStyle}${msg}${types.reset}`;
   },
-
-  /**
-   * Checks whether the compiled cds model contains compilation errors which
-   * should only be reported via the 'cds-compile-error' rule
-   * @param cds cds object
-   * @param ruleID rule name
-   * @returns
-   */
-  hasCompilationError: function (context) {
-    const cds = context.cds;
-    const ruleID = context.ruleID;
-    if (
-      cds &&
-      cds.model &&
-      cds.model.err &&
-      cds.model.err.message.startsWith("CDS compilation failed")
-    ) {
-      if (
-        ruleID === "@sap/cds/cds-compile-error" ||
-        ruleID === "cds-compile-error"
-      ) {
-        cds.model.err;
-        return true;
-      }
-    }
-    return false;
-  },
 };