@valbuild/eslint-plugin 0.43.0 → 0.43.1

package/dist/valbuild-eslint-plugin.cjs.dev.js

@@ -8,43 +8,92 @@ function _interopDefault (e) { return e && e.__esModule ? e : { 'default': e };
 
 var path__default = /*#__PURE__*/_interopDefault(path);
 
-// @ts-check
-var getExpectedValModuleName = function getExpectedValModuleName( /** @type {{ report?: (arg0: { node: any; message: string; fix: ((fixer: any) => any) | ((fixer: any) => any); }) => void; getFilename?: any; cwd?: any; }} */context) {
-  var filename = context.getFilename();
-  if (filename.endsWith(".val.ts") || filename.endsWith(".val.js")) {
-    var root = context.cwd || process.cwd();
-    var relativePath = path__default["default"].relative(root, filename);
-    var expectedValue = relativePath.replace(/\.val\.(ts|js)$/, "");
-    return "/".concat(expectedValue);
-  }
-};
+function _arrayLikeToArray(arr, len) {
+  if (len == null || len > arr.length) len = arr.length;
+  for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i];
+  return arr2;
+}
+
+function _arrayWithoutHoles(arr) {
+  if (Array.isArray(arr)) return _arrayLikeToArray(arr);
+}
+
+function _iterableToArray(iter) {
+  if (typeof Symbol !== "undefined" && iter[Symbol.iterator] != null || iter["@@iterator"] != null) return Array.from(iter);
+}
+
+function _unsupportedIterableToArray(o, minLen) {
+  if (!o) return;
+  if (typeof o === "string") return _arrayLikeToArray(o, minLen);
+  var n = Object.prototype.toString.call(o).slice(8, -1);
+  if (n === "Object" && o.constructor) n = o.constructor.name;
+  if (n === "Map" || n === "Set") return Array.from(o);
+  if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen);
+}
+
+function _nonIterableSpread() {
+  throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");
+}
+
+function _toConsumableArray(arr) {
+  return _arrayWithoutHoles(arr) || _iterableToArray(arr) || _unsupportedIterableToArray(arr) || _nonIterableSpread();
+}
+
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 var noIllegalModuleIds = {
   meta: {
     type: "problem",
     docs: {
       description: "Check that the first argument of export default declaration matches the string from val.config.ts file.",
       category: "Best Practices",
-      recommended: "error"
+      recommended: true
     },
     fixable: "code",
     schema: []
   },
-  create: function create( /** @type {{ report: (arg0: { node: any; message: string; fix: ((fixer: any) => any) | ((fixer: any) => any); }) => void; }} */context) {
-    var expectedValue = getExpectedValModuleName(context);
+  create: function create(context) {
     return {
-      /**
-       * @param {{ declaration: { arguments: string | any[]; }; }} node
-       */
       ExportDefaultDeclaration: function ExportDefaultDeclaration(node) {
+        /**
+         * @type {string | undefined}
+         */
+        var expectedValue;
+        if (node.parent.type === "Program") {
+          var maybeValConfigImportDeclaration = node.parent.body.find(function (n) {
+            return n.type === "ImportDeclaration" && typeof n.source.value === "string" && (n.source.value.endsWith("val.config") || n.source.value.endsWith("val.config.ts") || n.source.value.endsWith("val.config.js")) ? n.source.value : false;
+          });
+          if ((maybeValConfigImportDeclaration === null || maybeValConfigImportDeclaration === void 0 ? void 0 : maybeValConfigImportDeclaration.type) === "ImportDeclaration" && typeof maybeValConfigImportDeclaration.source.value === "string") {
+            var valConfigImportSource = maybeValConfigImportDeclaration.source.value;
+            var filename = context.filename || context.getFilename();
+            if (filename !== null && filename !== void 0 && filename.endsWith(".val.ts") || filename !== null && filename !== void 0 && filename.endsWith(".val.js")) {
+              var root = context.cwd || process.cwd();
+              var relativePath = path__default["default"].relative(root, filename);
+              expectedValue = relativePath.replace(/\.val\.(ts|js)$/, "");
+              // TODO: this feels like a weird way to figure out the correct relative path,
+              // in a monorepo, the root dir will be the root of the monorepo, not the root of the package
+              // so we need to account for that
+              // Assume the import of the val.config is correct and that it is in the root folder
+              var numberOfDirsToRoot = valConfigImportSource.split("..").reduce(function (acc, curr) {
+                return curr === "" ? acc + 1 : acc;
+              }, 0);
+              var pathSegments = expectedValue.split(path__default["default"].sep);
+              expectedValue = "/".concat(path__default["default"].join.apply(path__default["default"], _toConsumableArray(pathSegments.slice(pathSegments.length - (numberOfDirsToRoot + 1), pathSegments.length))));
+            }
+          }
+        } else {
+          console.warn("Unexpected parent type", node.parent.type);
+        }
         if (!expectedValue) {
           return;
         }
-        if (node.declaration && node.declaration.arguments && node.declaration.arguments.length > 0) {
+        if (node.declaration && node.declaration.type === "CallExpression" && node.declaration.arguments && node.declaration.arguments.length > 0) {
           var firstArg = node.declaration.arguments[0];
           if (firstArg.type === "TemplateLiteral") {
             context.report({
               node: firstArg,
-              message: "val.content first argument should not be a template literal",
+              message: "Val: val.content id should not be a template literal",
               fix: function fix(fixer) {
                 return fixer.replaceText(firstArg, "\"".concat(expectedValue, "\""));
               }
@@ -52,13 +101,17 @@ var noIllegalModuleIds = {
           }
           if (firstArg.type === "Literal" && typeof firstArg.value === "string") {
             if (firstArg.value !== expectedValue) {
-              context.report({
-                node: firstArg,
-                message: "val.content first argument must match filename",
-                fix: function fix(fixer) {
-                  return fixer.replaceText(firstArg, "".concat(firstArg.raw[0]).concat(expectedValue).concat(firstArg.raw[0]));
-                }
-              });
+              var _firstArg$raw;
+              var rawArg = (_firstArg$raw = firstArg.raw) === null || _firstArg$raw === void 0 ? void 0 : _firstArg$raw[0];
+              if (rawArg) {
+                context.report({
+                  node: firstArg,
+                  message: "Val: val.content path should match the filename. Expected: '".concat(expectedValue, "'. Found: '").concat(firstArg.value, "'"),
+                  fix: function fix(fixer) {
+                    return fixer.replaceText(firstArg, "".concat(rawArg).concat(expectedValue).concat(rawArg));
+                  }
+                });
+              }
             }
           }
         }
@@ -68,8 +121,59 @@ var noIllegalModuleIds = {
 };
 
 // @ts-check
+
+/**
+ * @type {Plugin["rules"]}
+ */
 var rules = {
   "no-illegal-module-ids": noIllegalModuleIds
 };
 
+/**
+ * @type {Plugin["processors"]}
+ */
+var processors = {
+  val: {
+    /**
+     * @param {string} text
+     * @param {string} filename
+     *  @returns {{ filename: string, text: string }[]}
+     */
+    preprocess: function preprocess(text, filename) {
+      console.log("preprocess", {
+        text: text,
+        filename: filename
+      });
+      return [{
+        text: text,
+        filename: filename
+      }];
+    },
+    /**
+     * Transforms generated messages for output.
+     * @param {LintMessage[][]} messages An array containing one array of messages
+     *     for each code block returned from `preprocess`.
+     * @param {string} filename The filename of the file
+     * @returns {LintMessage[]} A flattened array of messages with mapped locations.
+     */
+    postprocess: function postprocess(messages, filename) {
+      console.log({
+        messages: messages,
+        filename: filename
+      });
+      return messages.flat();
+    }
+  }
+};
+
+/**
+ * @type {Plugin}
+ */
+var index = {
+  rules: rules,
+  processors: processors
+};
+
+exports["default"] = index;
+exports.processors = processors;
 exports.rules = rules;

package/dist/valbuild-eslint-plugin.cjs.prod.js

@@ -8,43 +8,92 @@ function _interopDefault (e) { return e && e.__esModule ? e : { 'default': e };
 
 var path__default = /*#__PURE__*/_interopDefault(path);
 
-// @ts-check
-var getExpectedValModuleName = function getExpectedValModuleName( /** @type {{ report?: (arg0: { node: any; message: string; fix: ((fixer: any) => any) | ((fixer: any) => any); }) => void; getFilename?: any; cwd?: any; }} */context) {
-  var filename = context.getFilename();
-  if (filename.endsWith(".val.ts") || filename.endsWith(".val.js")) {
-    var root = context.cwd || process.cwd();
-    var relativePath = path__default["default"].relative(root, filename);
-    var expectedValue = relativePath.replace(/\.val\.(ts|js)$/, "");
-    return "/".concat(expectedValue);
-  }
-};
+function _arrayLikeToArray(arr, len) {
+  if (len == null || len > arr.length) len = arr.length;
+  for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i];
+  return arr2;
+}
+
+function _arrayWithoutHoles(arr) {
+  if (Array.isArray(arr)) return _arrayLikeToArray(arr);
+}
+
+function _iterableToArray(iter) {
+  if (typeof Symbol !== "undefined" && iter[Symbol.iterator] != null || iter["@@iterator"] != null) return Array.from(iter);
+}
+
+function _unsupportedIterableToArray(o, minLen) {
+  if (!o) return;
+  if (typeof o === "string") return _arrayLikeToArray(o, minLen);
+  var n = Object.prototype.toString.call(o).slice(8, -1);
+  if (n === "Object" && o.constructor) n = o.constructor.name;
+  if (n === "Map" || n === "Set") return Array.from(o);
+  if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen);
+}
+
+function _nonIterableSpread() {
+  throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");
+}
+
+function _toConsumableArray(arr) {
+  return _arrayWithoutHoles(arr) || _iterableToArray(arr) || _unsupportedIterableToArray(arr) || _nonIterableSpread();
+}
+
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 var noIllegalModuleIds = {
   meta: {
     type: "problem",
     docs: {
       description: "Check that the first argument of export default declaration matches the string from val.config.ts file.",
       category: "Best Practices",
-      recommended: "error"
+      recommended: true
     },
     fixable: "code",
     schema: []
   },
-  create: function create( /** @type {{ report: (arg0: { node: any; message: string; fix: ((fixer: any) => any) | ((fixer: any) => any); }) => void; }} */context) {
-    var expectedValue = getExpectedValModuleName(context);
+  create: function create(context) {
     return {
-      /**
-       * @param {{ declaration: { arguments: string | any[]; }; }} node
-       */
       ExportDefaultDeclaration: function ExportDefaultDeclaration(node) {
+        /**
+         * @type {string | undefined}
+         */
+        var expectedValue;
+        if (node.parent.type === "Program") {
+          var maybeValConfigImportDeclaration = node.parent.body.find(function (n) {
+            return n.type === "ImportDeclaration" && typeof n.source.value === "string" && (n.source.value.endsWith("val.config") || n.source.value.endsWith("val.config.ts") || n.source.value.endsWith("val.config.js")) ? n.source.value : false;
+          });
+          if ((maybeValConfigImportDeclaration === null || maybeValConfigImportDeclaration === void 0 ? void 0 : maybeValConfigImportDeclaration.type) === "ImportDeclaration" && typeof maybeValConfigImportDeclaration.source.value === "string") {
+            var valConfigImportSource = maybeValConfigImportDeclaration.source.value;
+            var filename = context.filename || context.getFilename();
+            if (filename !== null && filename !== void 0 && filename.endsWith(".val.ts") || filename !== null && filename !== void 0 && filename.endsWith(".val.js")) {
+              var root = context.cwd || process.cwd();
+              var relativePath = path__default["default"].relative(root, filename);
+              expectedValue = relativePath.replace(/\.val\.(ts|js)$/, "");
+              // TODO: this feels like a weird way to figure out the correct relative path,
+              // in a monorepo, the root dir will be the root of the monorepo, not the root of the package
+              // so we need to account for that
+              // Assume the import of the val.config is correct and that it is in the root folder
+              var numberOfDirsToRoot = valConfigImportSource.split("..").reduce(function (acc, curr) {
+                return curr === "" ? acc + 1 : acc;
+              }, 0);
+              var pathSegments = expectedValue.split(path__default["default"].sep);
+              expectedValue = "/".concat(path__default["default"].join.apply(path__default["default"], _toConsumableArray(pathSegments.slice(pathSegments.length - (numberOfDirsToRoot + 1), pathSegments.length))));
+            }
+          }
+        } else {
+          console.warn("Unexpected parent type", node.parent.type);
+        }
         if (!expectedValue) {
           return;
         }
-        if (node.declaration && node.declaration.arguments && node.declaration.arguments.length > 0) {
+        if (node.declaration && node.declaration.type === "CallExpression" && node.declaration.arguments && node.declaration.arguments.length > 0) {
           var firstArg = node.declaration.arguments[0];
           if (firstArg.type === "TemplateLiteral") {
             context.report({
               node: firstArg,
-              message: "val.content first argument should not be a template literal",
+              message: "Val: val.content id should not be a template literal",
               fix: function fix(fixer) {
                 return fixer.replaceText(firstArg, "\"".concat(expectedValue, "\""));
               }
@@ -52,13 +101,17 @@ var noIllegalModuleIds = {
           }
           if (firstArg.type === "Literal" && typeof firstArg.value === "string") {
             if (firstArg.value !== expectedValue) {
-              context.report({
-                node: firstArg,
-                message: "val.content first argument must match filename",
-                fix: function fix(fixer) {
-                  return fixer.replaceText(firstArg, "".concat(firstArg.raw[0]).concat(expectedValue).concat(firstArg.raw[0]));
-                }
-              });
+              var _firstArg$raw;
+              var rawArg = (_firstArg$raw = firstArg.raw) === null || _firstArg$raw === void 0 ? void 0 : _firstArg$raw[0];
+              if (rawArg) {
+                context.report({
+                  node: firstArg,
+                  message: "Val: val.content path should match the filename. Expected: '".concat(expectedValue, "'. Found: '").concat(firstArg.value, "'"),
+                  fix: function fix(fixer) {
+                    return fixer.replaceText(firstArg, "".concat(rawArg).concat(expectedValue).concat(rawArg));
+                  }
+                });
+              }
             }
           }
         }
@@ -68,8 +121,59 @@ var noIllegalModuleIds = {
 };
 
 // @ts-check
+
+/**
+ * @type {Plugin["rules"]}
+ */
 var rules = {
   "no-illegal-module-ids": noIllegalModuleIds
 };
 
+/**
+ * @type {Plugin["processors"]}
+ */
+var processors = {
+  val: {
+    /**
+     * @param {string} text
+     * @param {string} filename
+     *  @returns {{ filename: string, text: string }[]}
+     */
+    preprocess: function preprocess(text, filename) {
+      console.log("preprocess", {
+        text: text,
+        filename: filename
+      });
+      return [{
+        text: text,
+        filename: filename
+      }];
+    },
+    /**
+     * Transforms generated messages for output.
+     * @param {LintMessage[][]} messages An array containing one array of messages
+     *     for each code block returned from `preprocess`.
+     * @param {string} filename The filename of the file
+     * @returns {LintMessage[]} A flattened array of messages with mapped locations.
+     */
+    postprocess: function postprocess(messages, filename) {
+      console.log({
+        messages: messages,
+        filename: filename
+      });
+      return messages.flat();
+    }
+  }
+};
+
+/**
+ * @type {Plugin}
+ */
+var index = {
+  rules: rules,
+  processors: processors
+};
+
+exports["default"] = index;
+exports.processors = processors;
 exports.rules = rules;

package/dist/valbuild-eslint-plugin.esm.js

@@ -1,42 +1,91 @@
 import path from 'path';
 
-// @ts-check
-var getExpectedValModuleName = function getExpectedValModuleName( /** @type {{ report?: (arg0: { node: any; message: string; fix: ((fixer: any) => any) | ((fixer: any) => any); }) => void; getFilename?: any; cwd?: any; }} */context) {
-  var filename = context.getFilename();
-  if (filename.endsWith(".val.ts") || filename.endsWith(".val.js")) {
-    var root = context.cwd || process.cwd();
-    var relativePath = path.relative(root, filename);
-    var expectedValue = relativePath.replace(/\.val\.(ts|js)$/, "");
-    return "/".concat(expectedValue);
-  }
-};
+function _arrayLikeToArray(arr, len) {
+  if (len == null || len > arr.length) len = arr.length;
+  for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i];
+  return arr2;
+}
+
+function _arrayWithoutHoles(arr) {
+  if (Array.isArray(arr)) return _arrayLikeToArray(arr);
+}
+
+function _iterableToArray(iter) {
+  if (typeof Symbol !== "undefined" && iter[Symbol.iterator] != null || iter["@@iterator"] != null) return Array.from(iter);
+}
+
+function _unsupportedIterableToArray(o, minLen) {
+  if (!o) return;
+  if (typeof o === "string") return _arrayLikeToArray(o, minLen);
+  var n = Object.prototype.toString.call(o).slice(8, -1);
+  if (n === "Object" && o.constructor) n = o.constructor.name;
+  if (n === "Map" || n === "Set") return Array.from(o);
+  if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen);
+}
+
+function _nonIterableSpread() {
+  throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");
+}
+
+function _toConsumableArray(arr) {
+  return _arrayWithoutHoles(arr) || _iterableToArray(arr) || _unsupportedIterableToArray(arr) || _nonIterableSpread();
+}
+
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 var noIllegalModuleIds = {
   meta: {
     type: "problem",
     docs: {
       description: "Check that the first argument of export default declaration matches the string from val.config.ts file.",
       category: "Best Practices",
-      recommended: "error"
+      recommended: true
     },
     fixable: "code",
     schema: []
   },
-  create: function create( /** @type {{ report: (arg0: { node: any; message: string; fix: ((fixer: any) => any) | ((fixer: any) => any); }) => void; }} */context) {
-    var expectedValue = getExpectedValModuleName(context);
+  create: function create(context) {
     return {
-      /**
-       * @param {{ declaration: { arguments: string | any[]; }; }} node
-       */
       ExportDefaultDeclaration: function ExportDefaultDeclaration(node) {
+        /**
+         * @type {string | undefined}
+         */
+        var expectedValue;
+        if (node.parent.type === "Program") {
+          var maybeValConfigImportDeclaration = node.parent.body.find(function (n) {
+            return n.type === "ImportDeclaration" && typeof n.source.value === "string" && (n.source.value.endsWith("val.config") || n.source.value.endsWith("val.config.ts") || n.source.value.endsWith("val.config.js")) ? n.source.value : false;
+          });
+          if ((maybeValConfigImportDeclaration === null || maybeValConfigImportDeclaration === void 0 ? void 0 : maybeValConfigImportDeclaration.type) === "ImportDeclaration" && typeof maybeValConfigImportDeclaration.source.value === "string") {
+            var valConfigImportSource = maybeValConfigImportDeclaration.source.value;
+            var filename = context.filename || context.getFilename();
+            if (filename !== null && filename !== void 0 && filename.endsWith(".val.ts") || filename !== null && filename !== void 0 && filename.endsWith(".val.js")) {
+              var root = context.cwd || process.cwd();
+              var relativePath = path.relative(root, filename);
+              expectedValue = relativePath.replace(/\.val\.(ts|js)$/, "");
+              // TODO: this feels like a weird way to figure out the correct relative path,
+              // in a monorepo, the root dir will be the root of the monorepo, not the root of the package
+              // so we need to account for that
+              // Assume the import of the val.config is correct and that it is in the root folder
+              var numberOfDirsToRoot = valConfigImportSource.split("..").reduce(function (acc, curr) {
+                return curr === "" ? acc + 1 : acc;
+              }, 0);
+              var pathSegments = expectedValue.split(path.sep);
+              expectedValue = "/".concat(path.join.apply(path, _toConsumableArray(pathSegments.slice(pathSegments.length - (numberOfDirsToRoot + 1), pathSegments.length))));
+            }
+          }
+        } else {
+          console.warn("Unexpected parent type", node.parent.type);
+        }
         if (!expectedValue) {
           return;
         }
-        if (node.declaration && node.declaration.arguments && node.declaration.arguments.length > 0) {
+        if (node.declaration && node.declaration.type === "CallExpression" && node.declaration.arguments && node.declaration.arguments.length > 0) {
           var firstArg = node.declaration.arguments[0];
           if (firstArg.type === "TemplateLiteral") {
             context.report({
               node: firstArg,
-              message: "val.content first argument should not be a template literal",
+              message: "Val: val.content id should not be a template literal",
               fix: function fix(fixer) {
                 return fixer.replaceText(firstArg, "\"".concat(expectedValue, "\""));
               }
@@ -44,13 +93,17 @@ var noIllegalModuleIds = {
           }
           if (firstArg.type === "Literal" && typeof firstArg.value === "string") {
             if (firstArg.value !== expectedValue) {
-              context.report({
-                node: firstArg,
-                message: "val.content first argument must match filename",
-                fix: function fix(fixer) {
-                  return fixer.replaceText(firstArg, "".concat(firstArg.raw[0]).concat(expectedValue).concat(firstArg.raw[0]));
-                }
-              });
+              var _firstArg$raw;
+              var rawArg = (_firstArg$raw = firstArg.raw) === null || _firstArg$raw === void 0 ? void 0 : _firstArg$raw[0];
+              if (rawArg) {
+                context.report({
+                  node: firstArg,
+                  message: "Val: val.content path should match the filename. Expected: '".concat(expectedValue, "'. Found: '").concat(firstArg.value, "'"),
+                  fix: function fix(fixer) {
+                    return fixer.replaceText(firstArg, "".concat(rawArg).concat(expectedValue).concat(rawArg));
+                  }
+                });
+              }
             }
           }
         }
@@ -60,8 +113,57 @@ var noIllegalModuleIds = {
 };
 
 // @ts-check
+
+/**
+ * @type {Plugin["rules"]}
+ */
 var rules = {
   "no-illegal-module-ids": noIllegalModuleIds
 };
 
-export { rules };
+/**
+ * @type {Plugin["processors"]}
+ */
+var processors = {
+  val: {
+    /**
+     * @param {string} text
+     * @param {string} filename
+     *  @returns {{ filename: string, text: string }[]}
+     */
+    preprocess: function preprocess(text, filename) {
+      console.log("preprocess", {
+        text: text,
+        filename: filename
+      });
+      return [{
+        text: text,
+        filename: filename
+      }];
+    },
+    /**
+     * Transforms generated messages for output.
+     * @param {LintMessage[][]} messages An array containing one array of messages
+     *     for each code block returned from `preprocess`.
+     * @param {string} filename The filename of the file
+     * @returns {LintMessage[]} A flattened array of messages with mapped locations.
+     */
+    postprocess: function postprocess(messages, filename) {
+      console.log({
+        messages: messages,
+        filename: filename
+      });
+      return messages.flat();
+    }
+  }
+};
+
+/**
+ * @type {Plugin}
+ */
+var index = {
+  rules: rules,
+  processors: processors
+};
+
+export { index as default, processors, rules };

package/fixtures/eslintrc.json

@@ -0,0 +1,6 @@
+{
+  "plugins": ["@valbuild"],
+  "rules": {
+    "@valbuild/no-illegal-module-ids": 2
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@valbuild/eslint-plugin",
-  "version": "0.43.0",
+  "version": "0.43.1",
   "description": "ESLint rules for val",
   "keywords": [
     "eslint",
@@ -26,7 +26,9 @@
     "eslint": "6 || 7 || 8"
   },
   "devDependencies": {
-    "eslint": "^7.10.0"
+    "@types/jest": "^29.5.11",
+    "eslint": "^7.10.0",
+    "jest": "^29.6"
   },
   "scripts": {
     "typecheck": "tsc -p jsconfig.json"

package/src/index.js

@@ -1,7 +1,49 @@
 // @ts-check
+/**
+ * @typedef {import('eslint').ESLint.Plugin} Plugin
+ * @typedef {import('eslint').Linter.LintMessage} LintMessage
+ * @typedef {import('eslint').Linter.Processor} Processor
+ * @typedef {import('eslint').Linter } RuleModule
+ */
 
 import noIllegalModuleIds from "./rules/noIllegalModuleIds";
 
+/**
+ * @type {Plugin["rules"]}
+ */
 export let rules = {
   "no-illegal-module-ids": noIllegalModuleIds,
 };
+
+/**
+ * @type {Plugin["processors"]}
+ */
+export const processors = {
+  val: {
+    /**
+     * @param {string} text
+     * @param {string} filename
+     *  @returns {{ filename: string, text: string }[]}
+     */
+    preprocess: (text, filename) => {
+      console.log("preprocess", { text, filename });
+      return [{ text, filename }];
+    },
+    /**
+     * Transforms generated messages for output.
+     * @param {LintMessage[][]} messages An array containing one array of messages
+     *     for each code block returned from `preprocess`.
+     * @param {string} filename The filename of the file
+     * @returns {LintMessage[]} A flattened array of messages with mapped locations.
+     */
+    postprocess: (messages, filename) => {
+      console.log({ messages, filename });
+      return messages.flat();
+    },
+  },
+};
+
+/**
+ * @type {Plugin}
+ */
+export default { rules, processors };

package/src/rules/noIllegalModuleIds.js

@@ -1,18 +1,9 @@
 // @ts-check
 import path from "path";
 
-const getExpectedValModuleName = (
-  /** @type {{ report?: (arg0: { node: any; message: string; fix: ((fixer: any) => any) | ((fixer: any) => any); }) => void; getFilename?: any; cwd?: any; }} */ context
-) => {
-  const filename = context.getFilename();
-  if (filename.endsWith(".val.ts") || filename.endsWith(".val.js")) {
-    const root = context.cwd || process.cwd();
-    const relativePath = path.relative(root, filename);
-    const expectedValue = relativePath.replace(/\.val\.(ts|js)$/, "");
-    return `/${expectedValue}`;
-  }
-};
-
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
 export default {
   meta: {
     type: "problem",
@@ -20,25 +11,67 @@ export default {
       description:
         "Check that the first argument of export default declaration matches the string from val.config.ts file.",
       category: "Best Practices",
-      recommended: "error",
+      recommended: true,
     },
     fixable: "code",
     schema: [],
   },
-  create: function (
-    /** @type {{ report: (arg0: { node: any; message: string; fix: ((fixer: any) => any) | ((fixer: any) => any); }) => void; }} */ context
-  ) {
-    const expectedValue = getExpectedValModuleName(context);
+  create: function (context) {
     return {
-      /**
-       * @param {{ declaration: { arguments: string | any[]; }; }} node
-       */
       ExportDefaultDeclaration(node) {
+        /**
+         * @type {string | undefined}
+         */
+        let expectedValue;
+        if (node.parent.type === "Program") {
+          const maybeValConfigImportDeclaration = node.parent.body.find((n) =>
+            n.type === "ImportDeclaration" &&
+            typeof n.source.value === "string" &&
+            (n.source.value.endsWith("val.config") ||
+              n.source.value.endsWith("val.config.ts") ||
+              n.source.value.endsWith("val.config.js"))
+              ? n.source.value
+              : false
+          );
+          if (
+            maybeValConfigImportDeclaration?.type === "ImportDeclaration" &&
+            typeof maybeValConfigImportDeclaration.source.value === "string"
+          ) {
+            const valConfigImportSource =
+              maybeValConfigImportDeclaration.source.value;
+            const filename = context.filename || context.getFilename();
+            if (
+              filename?.endsWith(".val.ts") ||
+              filename?.endsWith(".val.js")
+            ) {
+              const root = context.cwd || process.cwd();
+              const relativePath = path.relative(root, filename);
+              expectedValue = relativePath.replace(/\.val\.(ts|js)$/, "");
+              // TODO: this feels like a weird way to figure out the correct relative path,
+              // in a monorepo, the root dir will be the root of the monorepo, not the root of the package
+              // so we need to account for that
+              // Assume the import of the val.config is correct and that it is in the root folder
+              const numberOfDirsToRoot = valConfigImportSource
+                .split("..")
+                .reduce((acc, curr) => (curr === "" ? acc + 1 : acc), 0);
+              const pathSegments = expectedValue.split(path.sep);
+              expectedValue = `/${path.join(
+                ...pathSegments.slice(
+                  pathSegments.length - (numberOfDirsToRoot + 1),
+                  pathSegments.length
+                )
+              )}`;
+            }
+          }
+        } else {
+          console.warn("Unexpected parent type", node.parent.type);
+        }
         if (!expectedValue) {
           return;
         }
         if (
           node.declaration &&
+          node.declaration.type === "CallExpression" &&
           node.declaration.arguments &&
           node.declaration.arguments.length > 0
         ) {
@@ -46,8 +79,7 @@ export default {
           if (firstArg.type === "TemplateLiteral") {
             context.report({
               node: firstArg,
-              message:
-                "val.content first argument should not be a template literal",
+              message: "Val: val.content id should not be a template literal",
               fix: (fixer) => fixer.replaceText(firstArg, `"${expectedValue}"`),
             });
           }
@@ -56,15 +88,18 @@ export default {
             typeof firstArg.value === "string"
           ) {
             if (firstArg.value !== expectedValue) {
-              context.report({
-                node: firstArg,
-                message: "val.content first argument must match filename",
-                fix: (fixer) =>
-                  fixer.replaceText(
-                    firstArg,
-                    `${firstArg.raw[0]}${expectedValue}${firstArg.raw[0]}`
-                  ),
-              });
+              const rawArg = firstArg.raw?.[0];
+              if (rawArg) {
+                context.report({
+                  node: firstArg,
+                  message: `Val: val.content path should match the filename. Expected: '${expectedValue}'. Found: '${firstArg.value}'`,
+                  fix: (fixer) =>
+                    fixer.replaceText(
+                      firstArg,
+                      `${rawArg}${expectedValue}${rawArg}`
+                    ),
+                });
+              }
             }
           }
         }

package/test/plugin.test.js

@@ -0,0 +1,49 @@
+// @ts-check
+/* eslint-disable no-undef */
+import { ESLint } from "eslint";
+import path from "path";
+
+/**
+ * @param {string} fixtureConfigName ESLint JSON config fixture filename.
+ */
+function initESLint(fixtureConfigName) {
+  return new ESLint({
+    cwd: path.resolve(__dirname, "../fixtures/"),
+    ignore: false,
+    overrideConfigFile: path.resolve(
+      __dirname,
+      "../fixtures/",
+      fixtureConfigName
+    ),
+  });
+}
+
+describe("plugin", () => {
+  /**
+   * @type {ESLint}
+   */
+  let eslint;
+
+  beforeAll(() => {
+    eslint = initESLint("eslintrc.json");
+  });
+
+  test("no illegal modules for monorepos (projects that are not at root)", async () => {
+    const code = `import { s, val } from "../val.config";
+
+export const schema = s.string();
+
+export default val.content(
+  "/something",
+  schema,
+  "React Server components also works"
+);`;
+    const results = await eslint.lintText(code, {
+      filePath: "./app/test.val.ts",
+    });
+
+    expect(results).toHaveLength(1);
+    expect(results[0].messages).toHaveLength(1);
+    expect(results[0].messages[0].fix?.text).toEqual('"/app/test"');
+  });
+});

package/test/rules/noIllegalModuleIds.test.js

@@ -33,7 +33,8 @@ ruleTester.run("no-illegal-module-ids", rule, {
       export default val.content('foo', schema, 'String')`,
       errors: [
         {
-          message: "val.content first argument must match filename",
+          message:
+            "Val: val.content path should match the filename. Expected: '/foo/test'. Found: 'foo'",
         },
       ],
       output: `import { val, s } from '../val.config.ts';
@@ -47,7 +48,8 @@ ruleTester.run("no-illegal-module-ids", rule, {
       export default val.content("foo", schema, 'String')`,
       errors: [
         {
-          message: "val.content first argument must match filename",
+          message:
+            "Val: val.content path should match the filename. Expected: '/foo/test'. Found: 'foo'",
         },
       ],
       output: `import { val, s } from "../val.config.ts";
@@ -61,8 +63,7 @@ ruleTester.run("no-illegal-module-ids", rule, {
       export default val.content(\`foo\`, schema, 'String')`,
       errors: [
         {
-          message:
-            "val.content first argument should not be a template literal",
+          message: "Val: val.content id should not be a template literal",
         },
       ],
       output: `import { val, s } from "../val.config.ts";