@sap/eslint-plugin-cds 2.3.3 → 2.4.1

package/lib/utils/model.js

@@ -2,6 +2,7 @@
  * @typedef { import("eslint").AST.SourceLocation } SourceLocation
  */
 
+
 const fs = require("fs");
 const path = require("path");
 const cds = require("@sap/cds");
@@ -23,11 +24,7 @@ module.exports = {
       return cache.set(key, [value, Date.now()]);
     },
     get(key) {
-      if (cache.get(key)) {
-        return cache.get(key)[0];
-      } else {
-        return;
-      }
+      return cache.get(key) ? cache.get(key)[0] : undefined
     },
     dump() {
       const dump = {};
@@ -41,11 +38,9 @@ module.exports = {
       if (cache.has(key)) {
         cache.delete(key);
       }
-      return;
     },
     clear() {
       cache.clear();
-      return;
     },
   },
 
@@ -56,11 +51,8 @@ module.exports = {
    * @returns boolean
    */
   isNewConfigPath: function (configPath) {
-    if (!module.exports.Cache.has("configpath") &&
-      (configPath !== module.exports.Cache.get("configpath"))) {
-      return true;
-    }
-    return false;
+    return !module.exports.Cache.has("configpath") 
+            && (configPath !== module.exports.Cache.get("configpath"))
   },
 
   /**
@@ -115,25 +107,12 @@ module.exports = {
    * @returns ESLint range
    */
   getRange: function (code, line, column) {
-    let lines;
-    if (typeof code === "string") {
-      lines = SourceCode.splitLines(code);
-    } else {
-      lines = code;
-    }
+    const lines = typeof code === "string" ? SourceCode.splitLines(code) : code
     const ranges = [0];
     lines.forEach((line, i) => {
-      if (i === 0) {
-        ranges[i + 1] = line.length + 1;
-      } else {
-        ranges[i + 1] = ranges[i] + line.length + 1;
-      }
+      ranges[i + 1] = i === 0 ? line.length + 1 : ranges[i] + line.length + 1
     });
-    if (line > 1) {
-      return ranges[line - 1] + column;
-    } else {
-      return column;
-    }
+    return line > 1 ? ranges[line - 1] + column : column
   },
 
   /**
@@ -145,12 +124,7 @@ module.exports = {
    * @returns Last line index
    */
   getLastLine: function (code) {
-    let lines;
-    if (typeof code === "string") {
-      lines = SourceCode.splitLines(code);
-    } else {
-      lines = code;
-    }
+    const lines = typeof code === "string" ? SourceCode.splitLines(code) : code
     return lines.length - 1;
   },
 
@@ -181,10 +155,8 @@ module.exports = {
         loc.start.line = nameloc.line;
         loc.end.column = nameloc.col - 1 + name.length;
         loc.end.line = nameloc.line;
-      } else {
-        if (obj.parent) {
+      } else if (obj.parent) {
           this.getLocation(name, obj.parent, model);
-        }
       }
     }
     // Empty locations default to line 0, column 0
@@ -232,17 +204,23 @@ module.exports = {
    * @returns reflected model
    */
   compileModelFromPath: function (configPath) {
+    let compiledModel;
     let reflectedModel;
     cds.resolve.cache = {};
     const roots = cds.resolve("*", { root: configPath });
     const messages = [];
     if (roots) {
-      const compiledModel = cds.load(roots, {
+      try {
+      compiledModel = cds.load(roots, {
         cwd: configPath,
         sync: true,
         locations: true,
         messages,
       });
+      module.exports.Cache.remove('errRootModel');
+      } catch (err) {
+        module.exports.Cache.set('errRootModel', err);
+      }
       if (compiledModel) {
         reflectedModel = cds.linked(compiledModel);
         if (messages) {
@@ -332,13 +310,8 @@ module.exports = {
     const configPath = path.dirname(filePath);
     module.exports.Cache.set('configpath', configPath);
     let files = fs.readdirSync(configPath);
-    const modelfiles = [];
-    files.forEach((file) => {
-      const filePath = path.join(configPath, file);
-      if (isValidFile(filePath, 'MODEL_FILES')) {
-        modelfiles.push(filePath);
-      }
-    });
+    const modelfiles = files.map(f => path.join(configPath, f))
+                            .filter(fp => isValidFile(fp, 'MODEL_FILES'))
     module.exports.Cache.set(`modelfiles:${configPath}`, modelfiles);
     const dictFiles = module.exports.getDictFiles(configPath, modelfiles);
     module.exports.Cache.set(`dictfiles:${configPath}`, dictFiles);
@@ -359,11 +332,9 @@ module.exports = {
       dictFiles = module.exports.Cache.get(`dictfiles:${input}`);
     } else {
       files.forEach((file) => {
-        if (module.exports.Cache.has(`file:${file}`)) {
-          dictFiles[file] = module.exports.Cache.get(`file:${file}`);
-        } else {
-          dictFiles[file] = fs.readFileSync(file, "utf8");
-        }
+        dictFiles[file] = module.exports.Cache.has(`file:${file}`)
+                          ? module.exports.Cache.get(`file:${file}`)
+                          : fs.readFileSync(file, "utf8")
       });
     }
     return dictFiles;
@@ -375,6 +346,7 @@ module.exports = {
    * @returns boolean
    */
   hasFileChanged: function (code, filePath, configPath) {
+    let result = false
     const files = module.exports.Cache.get(`modelfiles:${configPath}`);
     const dictFiles = module.exports.getDictFiles(configPath, files);
     const isFileInModel = module.exports.isFileInModel(filePath, configPath);
@@ -382,16 +354,12 @@ module.exports = {
     if (isFileInModel) {
       // Only update on detected changes
       if (dictFiles[filePath] !== code) {
-        dictFiles[filePath] = code;
-        module.exports.Cache.set(`dictfiles:${configPath}`, dictFiles);
-        return true;
-      }
-    } else {
-      if (dictFiles[filePath] !== code) {
-        return true;
+        result = true
       }
+    } else if (dictFiles[filePath] !== code) {
+        result = true
     }
-    return false;
+    return result;
   },
 
   /**
@@ -401,14 +369,8 @@ module.exports = {
    * @returns boolean
    */
   isFileInModel(filePath, configPath) {
-    let files = module.exports.Cache.get(`modelfiles:${configPath}`);
-    if (!files) {
-      files = [];
-    }
-    if (files && files.length > 0 && files.includes(filePath)) {
-      return true;
-    }
-    return false;
+    let files = module.exports.Cache.get(`modelfiles:${configPath}`) || [];
+    return files && files.length > 0 && files.includes(filePath)
   },
 
   /**
@@ -419,14 +381,11 @@ module.exports = {
    */
   updateModel: function (code, filePath, configPath) {
     let reflectedModel;
-    let files = module.exports.Cache.get(`modelfiles:${configPath}`);
-    if (!files) {
-      files = [];
-    }
     const dictFiles = module.exports.Cache.get(`dictfiles:${configPath}`);
     dictFiles[filePath] = code;
     module.exports.Cache.set(`dictfiles:${configPath}`, dictFiles);
     reflectedModel = module.exports.compileModelFromDict(dictFiles, { flavor: "inferred" });
+    if (reflectedModel) { module.exports.Cache.remove('errRootModel') }
     module.exports.Cache.set(`model:${configPath}`, reflectedModel);
     return reflectedModel;
   }

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), "../..");