@sap/eslint-plugin-cds 2.3.5 → 2.4.1

package/lib/utils/ruleHelpers.js

@@ -36,7 +36,49 @@ module.exports = {
     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
@@ -52,5 +94,106 @@ module.exports = {
     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

@@ -20,8 +20,7 @@ runRuleTester: function(options) {
     let parser;
     let rule = {};
     const rulename = path.basename(options.root);
-    const plugin = "eslint-plugin-cds";
-    if (options.root.includes(plugin)) {
+    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), "../..");