@sap/eslint-plugin-cds 2.1.1 → 2.2.1

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

@@ -1,55 +1,48 @@
-const cdsLint = require("../../api");
-
-module.exports = cdsLint.createRule(
-  /* Rule meta */
-  {
+module.exports = require("../../api").createRule({
+  meta: {
     docs: {
       description: "Should make suggestions for possible missing sql casts.",
       category: "Model Validation",
       version: "1.0.8",
     },
     type: "suggestion",
+    hasSuggestions: true,
     messages: {
-      missingSQLCast: "Missing SQL cast?",
+      missingSQLCast: "Potential issue - Missing SQL cast for column expression?",
     },
   },
-  /* Rule logic */
-  (report, cds, sourcecode) => {
-    return createReport(report, cds, sourcecode) || report;
-  }
-);
-
-const createReport = (report, cds, sourcecode) => {
-  const m = cds.model;
-  if (m) {
-    const view = (d) => d.query;
-    m.foreach(view, (v) => {
-      if (v.query.SET)
-        for (const { SELECT } of v.query.SET.args) {
-          // Only in UNION cases?
-          for (const each of SELECT.columns || []) {
-            const { xpr, cast, $location: location } = each;
-            if (cast && xpr) {
-              if (xpr[0].xpr && xpr[0].xpr && xpr[0].cast) {
-                continue;
-              } else {
-                if (sourcecode.lines[location.line - 1]) {
-                  const endCol = sourcecode.lines[location.line - 1].length;
-                  const loc = {
-                    start: { line: location.line, column: location.col - 1 },
-                    end: { line: location.line, column: endCol },
-                  };
-                  report.push({
-                    message: `Potential issue - Missing SQL cast for column expression?`,
-                    loc,
-                    file: location.file,
-                  });
+  create: function (context) {
+    const m = context.cds.model;
+    if (m) {
+      const view = (d) => d.query;
+      m.foreach(view, (v) => {
+        if (v.query.SET)
+          for (const { SELECT } of v.query.SET.args) {
+            // Only in UNION cases?
+            for (const each of SELECT.columns || []) {
+              const { xpr, cast, $location: location } = each;
+              if (cast && xpr) {
+                if (xpr[0].xpr && xpr[0].xpr && xpr[0].cast) {
+                  continue;
+                } else {
+                  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: "missingSQLCast",
+                      loc,
+                      file: location.file,
+                    });
+                  }
                 }
               }
             }
           }
-        }
-    });
-  }
-  return report;
-};
+      });
+    }
+    return context.report;
+  },
+});

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

@@ -1,69 +1,66 @@
-const cdsLint = require("../../api");
-
-module.exports = cdsLint.createRule(
-  /* Rule meta */
-  {
+module.exports = require("../../api").createRule({
+  meta: {
     docs: {
-      description: `Regular element names should all be in lowercase.`,
+      description: "Regular element names should start with lowercase letters.",
       category: "Model Validation",
       version: "1.0.4",
     },
     type: "suggestion",
+    hasSuggestions: true,
     messages: {
-      startLowercase: "Start elements with lowercase letters",
+      startLowercase: "Element name '{{entityName}}.{{elementName}}' should start with a lowercase letter.",
     },
     fixable: "code",
   },
-  /* Rule logic */
-  (report, cds, sourcecode) => {
-    return createReport(report, cds, sourcecode) || report;
-  }
-);
-
-const createReport = (report, cds, sourcecode) => {
-  const m = cds.model;
-  if (m && m.definitions) {
-    m.forall((d) => {
-      const entityName = d.name;
-      for (const elementName in d.elements) {
-        const element = d.elements[elementName];
-        if (
-          elementName &&
-          !(entityName.startsWith("localized") || entityName.endsWith("texts"))
-        ) {
+  create: function (context) {
+    const m = context.cds.model;
+    if (m && m.definitions) {
+      m.forall((d) => {
+        const entityName = d.name;
+        for (const elementName in d.elements) {
+          const element = d.elements[elementName];
           if (
-            elementName.charAt(0) !== elementName.charAt(0).toLowerCase() &&
-            !["ID"].includes(elementName)
+            elementName &&
+            !(entityName.startsWith("localized") || entityName.endsWith("texts"))
           ) {
-            if (element.$location && element.$location.file) {
-              const file = element.$location.file;
-              const loc = cds.getLocation(elementName, element);
-              const fix = (fixer) => {
-                const elementNameSanitized =
-                  elementName.charAt(0).toLowerCase() + elementName.slice(1);
-                const rangeEnd = sourcecode.getIndexFromLoc({
-                  line: loc.end.line,
-                  column: loc.end.column,
+            if (
+              elementName.charAt(0) !== elementName.charAt(0).toLowerCase() &&
+              !["ID"].includes(elementName)
+            ) {
+              if (element.$location && element.$location.file) {
+                const file = element.$location.file;
+                const loc = context.cds.getLocation(elementName, element);
+                const fix = (fixer) => {
+                  const elementNameSanitized =
+                    elementName.charAt(0).toLowerCase() + elementName.slice(1);
+                  const rangeEnd = context.sourcecode.getIndexFromLoc({
+                    line: loc.end.line,
+                    column: loc.end.column,
+                  });
+                  const rangeBeg = rangeEnd ? rangeEnd - elementNameSanitized.length : 0;
+                  return fixer.replaceTextRange([rangeBeg, rangeEnd], elementNameSanitized);
+                };
+                context.report({
+                  messageId: "startLowercase",
+                  loc,
+                  file,
+                  fix,
+                  data: {
+                    entityName,
+                    elementName
+                  },
+                  suggest: [
+                    {
+                      messageId: "startLowercase",
+                      fix,
+                    },
+                  ],
                 });
-                const rangeBeg = rangeEnd
-                  ? rangeEnd - elementNameSanitized.length
-                  : 0;
-                return fixer.replaceTextRange(
-                  [rangeBeg, rangeEnd],
-                  elementNameSanitized
-                );
-              };
-              report.push({
-                message: `Element '${entityName}.${elementName}' must be lowercase`,
-                loc,
-                fix,
-                file,
-              });
+              }
             }
           }
         }
-      }
-    });
-  }
-  return report;
-};
+      });
+    }
+  },
+});

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

@@ -1,75 +1,56 @@
-const cdsLint = require("../../api");
-
-module.exports = cdsLint.createRule(
-  /* Rule meta */
-  {
+module.exports = require("../../api").createRule({
+  meta: {
     docs: {
-      description: "Entity names should all be in uppercase.",
+      description: "Regular entity names should start with uppercase letters.",
       category: "Model Validation",
       version: "1.0.4",
     },
     type: "suggestion",
+    hasSuggestions: true,
     messages: {
-      startUppercase: "Start entity and type names with capital letters",
+      startUppercase: "Entity name '{{entityName}}' should start with an uppercase letter.",
     },
     fixable: "code",
   },
-  /* Rule logic */
-  (report, cds, sourcecode) => {
-    return createReport(report, cds, sourcecode) || report;
-  }
-);
-
-const createReport = (report, cds, sourcecode) => {
-  const m = cds.model;
-  if (m) {
-    m.foreach(
-      "entity",
-      (e) => {
+  create: function (context) {
+    const m = context.cds.model;
+    if (m) {
+      m.foreach("entity", (e) => {
         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;
-            const loc = cds.getLocation(entityName, e);
-            const fix = (fixer) => {
-              const entityNameSanitized =
-                entityName.charAt(0).toUpperCase() + entityName.slice(1);
-              const rangeEnd = sourcecode.getIndexFromLoc({
-                line: loc.end.line,
-                column: loc.end.column,
-              });
-              const rangeBeg = rangeEnd
-                ? rangeEnd - entityNameSanitized.length
-                : 0;
-              return fixer.replaceTextRange(
-                [rangeBeg, rangeEnd],
-                entityNameSanitized
-              );
-            };
-            const suggest = [
-              {
+              const file = e.$location.file;
+              const loc = context.cds.getLocation(entityName, e);
+              const fix = (fixer) => {
+                const entityNameSanitized =
+                  entityName.charAt(0).toUpperCase() + entityName.slice(1);
+                const rangeEnd = context.sourcecode.getIndexFromLoc({
+                  line: loc.end.line,
+                  column: loc.end.column,
+                });
+                const rangeBeg = rangeEnd ? rangeEnd - entityNameSanitized.length : 0;
+                return fixer.replaceTextRange([rangeBeg, rangeEnd], entityNameSanitized);
+              };
+              context.report({
                 messageId: "startUppercase",
+                loc,
+                file,
                 fix,
-              },
-            ];
-            report.push({
-              message: `Entity '${entityName}' must be uppercase`,
-              loc,
-              file,
-              fix,
-              suggest,
-            });
-          }
+                data: { entityName },
+                suggest: [
+                  {
+                    messageId: "startUppercase",
+                    fix,
+                  },
+                ],
+              });
+            }
           }
         }
-      }
-    );
-  }
-  return report;
-};
+      });
+    }
+  },
+});

package/lib/impl/types.d.ts

@@ -0,0 +1,48 @@
+import { Rule, RuleTester, SourceCode } from "eslint";
+
+export interface CDSRuleMetaData extends Rule.RuleMetaData {
+    docs: {
+        /** provides the short description of the rule in the [rules index](https://eslint.org/docs/rules/) */
+        description: Rule.RuleMetaData['docs']['description'];
+        /** specifies version of @sap/eslint-plugin-cds at which the rule was first implemented */
+        version: string;
+    };
+    messages?: Rule.RuleMetaData['messages'];
+    fixable?: Rule.RuleMetaData['fixable'];
+    schema?: Rule.RuleMetaData['schema'];
+    deprecated?: Rule.RuleMetaData['deprecated'];
+    type?: Rule.RuleMetaData['type'];
+}
+
+export type CDSReport = Rule.ReportDescriptor & { file?: string };
+
+export interface CDSRuleContext extends Rule.RuleContext {
+    cds: any;
+    configPath: string;
+    code: string;
+    filePath: string;
+    options: [];
+    ruleID: string;
+    sourcecode: SourceCode
+}
+export interface CDSRuleSpec {
+    meta: CDSRuleMetaData,
+    create: (arg0: CDSRuleContext) => Rule.ReportDescriptor;
+}
+
+export interface CDSTestCaseError extends RuleTester.TestCaseError {
+    message: string | RegExp;
+}
+
+export interface CDSRuleTestOpts {
+    /** specifies __dirname */
+    root: string;
+    /** requires your rule .js here */
+    rule?: string;
+    /** filename ('schema.cds' for model, 'package.json' for env) */
+    filename: string;
+    /** resolves cds parser path */
+    parser?: string;
+    /** List of warnings/errors from ESLint's [ruleTester](https://eslint.org/docs/developer-guide/nodejs-api#ruletester) */
+    errors: CDSTestCaseError[]
+}

package/lib/impl/utils/helpers.js

@@ -1,3 +1,5 @@
+const { files } = require("../constants");
+
 module.exports = {
   /**
    * Checks whether plugin is used in 'test' mode
@@ -11,6 +13,22 @@ module.exports = {
     return isTest;
   },
 
+  /**
+   * Checks whether the given file path contains a file extension allowed by
+   * the plugin
+   * @param {string} filePath
+   * @returns boolean
+   */
+  isValidFile: function (filePath) {
+    const regex = new RegExp(
+      `${files
+        .map((file) => {
+          return file.replace("*", "");
+        })
+        .join("$|")}$`
+    );
+    return regex.test(filePath);
+  },
 
   /**
    * Checks whether the plugin is run via the VS Code ESLint extension (editor)
@@ -21,7 +39,7 @@ module.exports = {
   },
 
   /**
-   * Prints a given message string in the styles provided
+   * Prints a formatted message string according to the styles provided
    * @param msg message to print
    * @param styles array of styles for apply
    * @returns
@@ -41,5 +59,31 @@ 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;
+  },
 };