@sap/eslint-plugin-cds 2.3.0 → 2.3.4

package/lib/impl/rules/cds-compile-error.js

@@ -1,34 +0,0 @@
-module.exports = require("../../api").createRule({
-  meta: {
-    docs: {
-      description: `Checks whether the CDS model file can be compiled by the @sap/cds wihtout errors.`,
-      category: "Model Validation",
-      version: "1.0.0",
-    },
-    severity: "error",
-    type: "problem",
-  },
-  create: function (context) {
-    const m = context.cds.model;
-    if (m && m.err) {
-      // If any csn compile errors occur
-      m.err.messages.forEach((err) => {
-        const msg = err.message;
-        let file = "";
-        const loc = {
-          start: { line: 0, column: 0 },
-          end: { line: 1, column: 0 },
-        };
-        // Get its location if it exists
-        if (err.$location) {
-          loc.start.column = err.$location.col;
-          loc.start.line = err.$location.line;
-          loc.end.column = err.$location.endCol;
-          loc.end.line = err.$location.endLine;
-          file = err.$location.file;
-        }
-        context.report({ message: `${msg}`, loc, file });
-      });
-    }
-  }
-});

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

@@ -1,51 +0,0 @@
-const os = require("os");
-const cp = require("child_process");
-const semver = require("semver");
-
-const IS_WIN = os.platform() === "win32";
-
-module.exports = require("../../api").createRule({
-  meta: {
-    docs: {
-      description: "Checks whether the latest `@sap/cds` version is being used.",
-      category: "Environment",
-      version: "1.0.4",
-    },
-    type: "suggestion",
-    hasSuggestions: true,
-    messages: {
-      latestCDSVersion: `A newer CDS version is available!`,
-    },
-  },
-  create: function (context) {
-    let result;
-    let cdsVersions;
-    const e = context.cds.environment;
-    if (!e) {
-      try {
-        result = cp
-          .execSync(`npm outdated @sap/cds --json`, {
-            cwd: process.cwd(),
-            shell: IS_WIN,
-            stdio: "pipe",
-          })
-          .toString();
-        cdsVersions = JSON.parse(result)["@sap/cds"];
-      } catch (err) {
-        // Do not throw
-      }
-    } else {
-      cdsVersions = context.cds.environment["@sap/cds"];
-    }
-    // If current cds version is not the latest
-    if (
-      Object.keys(cdsVersions).length !== 0 &&
-      !semver.satisfies(cdsVersions.latest, cdsVersions.current)
-    ) {
-      // Add to ESLint report
-      context.report({
-        messageId: "latestCDSVersion",
-      });
-    }
-  },
-});

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

@@ -1,44 +0,0 @@
-const path = require("path");
-const semver = require("semver");
-
-module.exports = require("../../api").createRule({
-  meta: {
-    docs: {
-      description: `Checks whether the minimum Node.js version required by \`@sap/cds\` is achieved.`,
-      category: "Environment",
-      recommended: true,
-      version: "1.0.0",
-    },
-    severity: "error",
-    type: "problem",
-  },
-  create: function (context) {
-    const e = context.cds.environment;
-    let nodeVersion, nodeVersionCDS;
-    if (!e) {
-      // Get current and required node versions
-      try {
-        const CDSPath = require.resolve("@sap/cds/package.json", {
-          paths: [path.dirname(context.filePath)],
-        });
-        const jsonCDS = require(CDSPath);
-        nodeVersion = process.version;
-        nodeVersionCDS = jsonCDS.engines.node;
-      } catch (err) {
-        // Do not throw
-      }
-    } else {
-      nodeVersion = context.cds.environment.nodeVersion;
-      nodeVersionCDS = context.cds.environment.nodeVersionCDS;
-    }
-    if (
-      nodeVersion &&
-      nodeVersionCDS &&
-      !semver.satisfies(nodeVersion, nodeVersionCDS, { loose: true })
-    ) {
-      context.report({
-        message: `CDS minimum node version of ${nodeVersionCDS} required, found ${nodeVersion}!`,
-      });
-    }
-  },
-});

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

@@ -1,38 +0,0 @@
-module.exports = require("../../api").defineRule({
-  meta: {
-    docs: {
-      description: `Avoid using reserved SQL keywords.`,
-      category: "Model Validation",
-      recommended: true,
-      version: "2.1.0",
-    },
-    severity: "error"
-  },
-  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;
-
-        // Do blame
-        return `'${d.name}' is a reserved keyword in ${db.kind.toUpperCase()}`;
-      }
-    }
-    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,
-};

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

@@ -1,31 +0,0 @@
-module.exports = require("../../api").createRule({
-  meta: {
-    docs: {
-      description: `Foreign key information of a \`TO MANY\` relationship must be defined within the target and specified in an \`ON\` condition.`,
-      category: "Model Validation",
-      recommended: true,
-      version: "2.1.0",
-    },
-    severity: "error",
-    type: "problem",
-  },
-  create: function (context) {
-    const m = context.cds.model;  if (!m)  return
-    m.forall((d) => {
-      if (d.name) {
-        if (!d.elements) return;
-        for (const elementName in d.elements) {
-          const element = d.elements[elementName];
-          if (element.is2many && !element.on) {
-            const loc = context.cds.getLocation(elementName, element);
-            context.report({
-              message: `You must provide an \`ON\` condition for \`TO MANY\` relationship '${element.name}'.`,
-              loc,
-              file: d.$location.file,
-            });
-          }
-        }
-      }
-    });
-  },
-});

package/lib/impl/rules/rule.hbs

@@ -1,20 +0,0 @@
-// @ts-check
-module.exports = require("../../api").createRule({
-  meta: {
-    docs: {
-      description: "{{description}}",
-      version: "{{version}}"
-      },
-      type:"{{type}}",
-  },
-  create: function(context) {
-    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

@@ -1,52 +0,0 @@
-module.exports = require("../../api").createRule({
-  meta: {
-    docs: {
-      description: "Should make suggestions for possible missing SQL casts.",
-      category: "Model Validation",
-      recommended: true,
-      version: "1.0.8",
-    },
-    severity: "warn",
-    type: "suggestion",
-    hasSuggestions: true,
-    messages: {
-      missingSQLCast:
-        "Potential issue - Missing SQL cast for column expression?",
-    },
-  },
-  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 context.report;
-  },
-});

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

@@ -1,75 +0,0 @@
-module.exports = require("../../api").createRule({
-  meta: {
-    docs: {
-      description: "Regular element names should start with lowercase letters.",
-      category: "Model Validation",
-      version: "1.0.4",
-    },
-    type: "suggestion",
-    hasSuggestions: true,
-    messages: {
-      startLowercase:
-        "Element name '{{entityName}}.{{elementName}}' should start with a lowercase letter.",
-        fixLowercase:
-        "Start element name with a lowercase letter."
-    },
-    fixable: "code",
-  },
-  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 &&
-            !(
-              entityName.startsWith("localized") || entityName.endsWith("texts")
-            )
-          ) {
-            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,
-                  data: {
-                    entityName,
-                    elementName,
-                  },
-                  suggest: [
-                    {
-                      messageId: "fixLowercase",
-                      fix,
-                    },
-                  ],
-                });
-              }
-            }
-          }
-        }
-      });
-    }
-  },
-});

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

@@ -1,65 +0,0 @@
-module.exports = require("../../api").createRule({
-  meta: {
-    docs: {
-      description: "Regular entity names should start with uppercase letters.",
-      category: "Model Validation",
-      version: "1.0.4",
-    },
-    type: "suggestion",
-    hasSuggestions: true,
-    messages: {
-      startUppercase:
-        "Entity name '{{entityName}}' should start with an uppercase letter.",
-      fixUppercase: "Start entity name with an uppercase letter.",
-    },
-    fixable: "code",
-  },
-  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.charAt(0) !== entityName.charAt(0).toUpperCase()) {
-            if (e.$location && e.$location.file) {
-              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,
-                data: { entityName },
-                suggest: [
-                  {
-                    messageId: "fixUppercase",
-                    fix,
-                  },
-                ],
-              });
-            }
-          }
-        }
-      });
-    }
-  },
-});

package/lib/impl/types.d.ts

@@ -1,48 +0,0 @@
-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,68 +0,0 @@
-const { files, envFiles, modelFiles } = require("../constants");
-
-module.exports = {
-
-  /**
-   * Checks whether the given file path contains a file extension allowed by
-   * the plugin
-   * @param {string} filePath
-   * @returns boolean
-   */
-  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);
-    }
-  },
-
-  /**
-   * Checks whether the plugin is run via the VS Code ESLint extension (editor)
-   * @returns boolean
-   */
-  isEditor() {
-    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
-   * @param styles array of styles for apply
-   * @returns
-   */
-  styleText: function (msg, styles) {
-    const types = {
-      reset: "\x1b[0m", // Default
-      bold: "\x1b[1m", // Bold/Bright
-      link: "\x1b[4m", // underline
-      red: "\x1b[31m", // Foreground Red
-      green: "\x1b[32m", // Foreground Green
-      yellow: "\x1b[33m", // Foreground Yellow
-    };
-    let msgStyle = "";
-    styles.forEach((style) => {
-      msgStyle += types[style];
-    });
-    return `${msgStyle}${msg}${types.reset}`;
-  },
-};