@sap/eslint-plugin-cds 2.4.1 → 2.5.0

package/lib/utils/ruleHelpers.js

@@ -1,199 +0,0 @@
-const SEP = "[,;\t]";
-const EOL = "\\r?\\n";
-
-const findFuzzy = require("./fuzzySearch");
-
-module.exports = {
-  /**
-   *
-   * @param {*} e
-   */
-  splitEntityName: function (e) {
-    // Entity names from CSN are of the form:
-    // <namespace>.<service>.<entity>.<'texts'|'localized'>|<composition value>
-    let prefix = "";
-    let suffix = "";
-    let entityName = e.name;
-    const names = entityName.split(".");
-    entityName = names[names.length - 1];
-
-    if (entityName) {
-      // Managed composition get compiler tag `_up`
-      let isManagedComposition = false;
-      if (e.elements) {
-        isManagedComposition = Object.keys(e.elements).some((k) => k === "up_");
-      }
-      // Check for compiler tags
-      let compilerTagsToExclude = ["texts", "localized"];
-      const isCompilerTag = compilerTagsToExclude.includes(entityName);
-
-      if (isManagedComposition || isCompilerTag) {
-        suffix = names[names.length - 1];
-        entityName = names[names.length - 2];
-      }
-      prefix = e.name.split(`.${entityName}`)[0];
-    }
-    return { prefix, entity: entityName, suffix };
-  },
-
-  /**
-   *
-   * @param {*} reports
-   * @param {*} context
-   * @param {*} items
-   * @param {*} validItems
-   * @param {*} severity
-   */
-  suggestItems: function (reports, context, items, validItems, severity, keepCase) {
-    const { code, sourcecode, filePath } = context;
-    let invalidItems = items.filter(
-      (e) => !validItems.includes(e) && !validItems.includes(e.toUpperCase() && !validItems.includes(e.toLowerCase()))
-    );
-    invalidItems.forEach((invalid) => {
-      const index = module.exports._findInCode(invalid, code);
-      // Safetey check that string exists in source code
-      if (index > 0) {
-        const loc = sourcecode.getLocFromIndex(index);
-        const candidates = findFuzzy(invalid, validItems.sort(), keepCase);
-        const suggest = candidates.map((cand) => {
-          return {
-            messageId: "ReplaceItemWith",
-            data: { invalid, candidates: cand },
-            fix: (fixer) => fixer.replaceTextRange([index, index + invalid.length], cand),
-          };
-        });
-        reports.push({
-          messageId: "InvalidItem",
-          data: { invalid, candidates },
-          loc: {
-            start: loc,
-            end: { line: loc.line, column: loc.column + invalid.length },
-          },
-          file: filePath,
-          suggest,
-          severity,
-        });
-      }
-    });
-    if (!invalidItems) {
-      reports.push(`Missing values!`);
-    }
-  },
-
-  _findInCode: function (miss, code) {
-    // middle
-    let match = new RegExp(SEP + miss + SEP).exec(code);
-    if (match) return match.index + 1;
-    // end of line
-    match = new RegExp(SEP + miss + EOL).exec(code);
-    if (match) return match.index + 1;
-    // start of doc
-    match = new RegExp("^" + miss + SEP).exec(code);
-    if (match) return match.index;
-    // somewhere (fallback)
-    return code.indexOf(miss);
-  },
-
-  validateString: function (reports, context, e, text, value, allowedValues, fuzzySearch = true, keepCase = true) {
-    const { key, name } = text;
-    if (typeof value !== "string") {
-      return;
-    }
-    if (!value) {
-      reports.push(`Missing ${name} on ${e.name} for @restrict \`${key}\`.`);
-    } else if (fuzzySearch) {
-      module.exports.suggestItems(reports, context, [value], allowedValues, keepCase);
-    }
-  },
-
-  validateObject: function (reports, context, e, text, values, allowedValues, fuzzySearch = true) {
-    const { key, name } = text;
-    if (typeof values !== "object") {
-      return;
-    }
-    if (values.length === 0) {
-      reports.push(`Missing ${name} on ${e.name} for @restrict \`${key}\`.`);
-    } else if (fuzzySearch) {
-      switch (key) {
-        case "to": {
-          if (values.includes("any")) {
-            module.exports.suggestRedundantItems(reports, context, "any", e);
-          }
-          break;
-        }
-        case "grant": {
-          let valuesForWrite = allowedValues.filter(function (item) {
-            return item !== "READ" && item !== "WRITE" && item !== "*";
-          });
-          let allValuesIncluded = (arr, target) => target.every((v) => arr.includes(v));
-          if (allValuesIncluded(values, valuesForWrite)) {
-            module.exports.suggestRedundantItems(reports, context, "WRITE", e);
-          }
-          if (values.includes("*")) {
-            module.exports.suggestRedundantItems(reports, context, "*", e);
-          }
-          break;
-        }
-      }
-      module.exports.suggestItems(reports, context, values, allowedValues);
-    }
-  },
-
-  suggestRedundantItems: function (reports, context, value, e) {
-    let invalid;
-    const loc = e.$location;
-    const lineToReplace = context.sourcecode.lines[loc.line];
-    var regExp = /\[([^)]+)\]/;
-    var matches = regExp.exec(lineToReplace);
-    if (matches && matches[0]) {
-      invalid = matches[0];
-    }
-    const startIndex = lineToReplace.indexOf(invalid);
-    const candidates = `['${value}']`;
-    const suggest = {
-      messageId: "ReplaceItemWith",
-      data: { invalid, candidates },
-      fix: (fixer) => fixer.replaceTextRange([startIndex, startIndex + invalid.length] + 1, candidates),
-    };
-    reports.push({
-      messageId: "InvalidItem",
-      data: { invalid, candidates },
-      loc: {
-        start: { line: loc.line + 1, column: startIndex },
-        end: { line: loc.line + 1, column: startIndex + invalid.length },
-      },
-      file: context.filePath,
-      suggest,
-      severity: "warn",
-    });
-  },
-
-  suggestReplacementsItems: function (reports, context, value, e) {
-    let invalid;
-    const loc = e.$location;
-    const lineToReplace = context.sourcecode.lines[loc.line];
-    var regExp = /\[([^)]+)\]/;
-    var matches = regExp.exec(lineToReplace);
-    if (matches && matches[0]) {
-      invalid = matches[0];
-    }
-    const startIndex = lineToReplace.indexOf(invalid);
-    const candidates = `['${value}']`;
-    const suggest = {
-      messageId: "ReplaceItemWith",
-      data: { invalid, candidates },
-      fix: (fixer) => fixer.replaceTextRange([startIndex, startIndex + invalid.length] + 1, candidates),
-    };
-    reports.push({
-      messageId: "InvalidItem",
-      data: { invalid, candidates },
-      loc: {
-        start: { line: loc.line + 1, column: startIndex },
-        end: { line: loc.line + 1, column: startIndex + invalid.length },
-      },
-      file: context.filePath,
-      suggest,
-      severity: "warn",
-    });
-  },
-};

package/lib/utils/ruleTester.js

@@ -1,78 +0,0 @@
-const fs = require("fs");
-const path = require("path");
-
-const { RuleTester } = require("eslint");
-const { Cache, initModelRuleTester } = require("./model");
-const { createRule, getRules } = require("./rules");
-const { isValidFile } = require("./helpers");
-
-module.exports = {
-/**
- * ESLint RuleTester (used by custom rule creator api)
- * Calls ESLint's RuleTester with custom cds parser and input for
- * valid/invalid checks:
- * Model checks require input 'code' entries
- * Env checks require input 'options' with selected parameters
- * @param {CDSRuleTestOpts} options RuleTester input options
- * @returns RuleTester results
- */
-runRuleTester: function(options) {
-    let parser;
-    let rule = {};
-    const rulename = path.basename(options.root);
-    if (options.root.startsWith(path.resolve(__dirname,'../..'))) {
-      // For plugin's internal tests, resolve parser from here
-      parser = require.resolve("../parser");
-      const pluginPath = path.join(path.dirname(options.root), "../..");
-      rule = createRule(require(`../rules/${path.basename(options.root)}`));
-      Cache.set(
-        "rulesInfo",
-        getRules(path.join(path.dirname(options.root), "../../lib/rules"), rulename)
-      );
-      Cache.set("pluginpath", pluginPath);
-    } else {
-      // Otherwise from project root
-      const resolvedPlugin = require.resolve("@sap/eslint-plugin-cds", {
-        paths: [options.root],
-      });
-      parser = path.join(path.dirname(resolvedPlugin), "parser");
-      rule = require(path.join(
-        options.root,
-        `../../rules/${path.basename(options.root)}`
-      ));
-      const pluginPath = path.join(path.dirname(options.root), "../../../..");
-      Cache.set("rulesInfo", getRules(path.join(options.root, "../../rules", rulename)));
-      Cache.set("pluginpath", pluginPath);
-    }
-    let tester = new RuleTester({});
-    if (parser) {
-      tester = new RuleTester({ parser });
-    }
-    const testerCases = {};
-    ["valid", "invalid"].forEach((type) => {
-      const filePath = path.join(options.root, `${type}/${options.filename}`);
-      const model = initModelRuleTester(filePath);
-      testerCases[type] = [
-        {
-          filename: filePath,
-        },
-      ];
-      if (!isValidFile(options.filename, 'FILES')) {
-        const fileContents = JSON.parse(fs.readFileSync(filePath, "utf8"));
-        testerCases[type][0].code = "";
-        testerCases[type][0].options = [{ environment: fileContents }];
-      } else {
-        testerCases[type][0].code = fs.readFileSync(filePath, "utf8");
-        testerCases[type][0].options = [{ model }];
-      }
-      if (type === "invalid") {
-        testerCases[type][0].errors = options.errors;
-        const fileFixed = path.join(options.root, `fixed/${options.filename}`);
-        if (fs.existsSync(fileFixed) && rule.meta.type !== "suggestion") {
-          testerCases[type][0].output = fs.readFileSync(fileFixed, "utf8");
-        }
-      }
-    });
-    return tester.run(rulename, rule, testerCases);
-  }
-}

package/lib/utils/validate.js

@@ -1,36 +0,0 @@
-/**
- * @typedef { import("eslint").Rule.RuleContext.options } ContextOptions
- */
-
-module.exports = {
-  /**
-   * Checks whether the rule name is valid (i.e. is contained within
-   * the plugin's or user's *custom* rules).
-   * @param context
-   * @param pluginRules
-   * @param customRules
-   * @returns
-   */
-  isValidRule: function (context, rules) {
-    if (rules.includes(context.id.replace("@sap/cds/", ""))) {
-      return true;
-    }
-    return false;
-  },
-
-  /**
-   * Checks whether a cds model is error-free
-   * @param context cds context object
-   * @returns
-   */
-  isValidModel: function (context) {
-    const cds = context.cds;
-    if (cds) {
-      if (cds.model) {
-        return !cds.model.err;
-      }
-      return true;  // allow no model
-    }
-    return false;
-  }
-};