@valbuild/eslint-plugin 0.45.0 → 0.47.0

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

@@ -106,7 +106,7 @@ var noIllegalModuleIds = {
               if (rawArg) {
                 context.report({
                   node: firstArg,
-                  message: "Val: val.content path should match the filename. Expected: '".concat(expectedValue, "'. Found: '").concat(firstArg.value, "'"),
+                  message: "Val: val.content id 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));
                   }
@@ -122,49 +122,53 @@ var noIllegalModuleIds = {
 
 // @ts-check
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
+var noIllegalImports = {
+  meta: {
+    type: "problem",
+    docs: {
+      description: "Check that val files only has valid imports.",
+      category: "Best Practices",
+      recommended: true
+    },
+    fixable: "code",
+    schema: []
+  },
+  create: function create(context) {
+    return {
+      ImportDeclaration: function ImportDeclaration(node) {
+        var importSource = node.source.value;
+        var filename = context.filename || context.getFilename();
+        var isValFile = filename.endsWith(".val.ts") || filename.endsWith(".val.js");
+        // only allow: .val files, @valbuild packages, and val config
+        if (isValFile && typeof importSource === "string" && !importSource.match(/\.val(\.ts|\.js|)$/) && !importSource.match(/^@valbuild/) && !importSource.match(/val\.config(\.ts|\.js|)$/)) {
+          var message = "Val: import source should be a .val.ts file, a @valbuild package, or val.config.ts. Found: '".concat(importSource, "'");
+          context.report({
+            node: node.source,
+            message: message
+          });
+        }
+      }
+    };
+  }
+};
+
+// @ts-check
+
 /**
  * @type {Plugin["rules"]}
  */
 var rules = {
-  "no-illegal-module-ids": noIllegalModuleIds
+  "no-illegal-module-ids": noIllegalModuleIds,
+  "no-illegal-imports": noIllegalImports
 };
 
 /**
  * @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();
-    }
-  }
-};
+var processors = {};
 
 /**
  * @type {Plugin}

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

@@ -106,7 +106,7 @@ var noIllegalModuleIds = {
               if (rawArg) {
                 context.report({
                   node: firstArg,
-                  message: "Val: val.content path should match the filename. Expected: '".concat(expectedValue, "'. Found: '").concat(firstArg.value, "'"),
+                  message: "Val: val.content id 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));
                   }
@@ -122,49 +122,53 @@ var noIllegalModuleIds = {
 
 // @ts-check
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
+var noIllegalImports = {
+  meta: {
+    type: "problem",
+    docs: {
+      description: "Check that val files only has valid imports.",
+      category: "Best Practices",
+      recommended: true
+    },
+    fixable: "code",
+    schema: []
+  },
+  create: function create(context) {
+    return {
+      ImportDeclaration: function ImportDeclaration(node) {
+        var importSource = node.source.value;
+        var filename = context.filename || context.getFilename();
+        var isValFile = filename.endsWith(".val.ts") || filename.endsWith(".val.js");
+        // only allow: .val files, @valbuild packages, and val config
+        if (isValFile && typeof importSource === "string" && !importSource.match(/\.val(\.ts|\.js|)$/) && !importSource.match(/^@valbuild/) && !importSource.match(/val\.config(\.ts|\.js|)$/)) {
+          var message = "Val: import source should be a .val.ts file, a @valbuild package, or val.config.ts. Found: '".concat(importSource, "'");
+          context.report({
+            node: node.source,
+            message: message
+          });
+        }
+      }
+    };
+  }
+};
+
+// @ts-check
+
 /**
  * @type {Plugin["rules"]}
  */
 var rules = {
-  "no-illegal-module-ids": noIllegalModuleIds
+  "no-illegal-module-ids": noIllegalModuleIds,
+  "no-illegal-imports": noIllegalImports
 };
 
 /**
  * @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();
-    }
-  }
-};
+var processors = {};
 
 /**
  * @type {Plugin}

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

@@ -98,7 +98,7 @@ var noIllegalModuleIds = {
               if (rawArg) {
                 context.report({
                   node: firstArg,
-                  message: "Val: val.content path should match the filename. Expected: '".concat(expectedValue, "'. Found: '").concat(firstArg.value, "'"),
+                  message: "Val: val.content id 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));
                   }
@@ -114,49 +114,53 @@ var noIllegalModuleIds = {
 
 // @ts-check
 
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
+var noIllegalImports = {
+  meta: {
+    type: "problem",
+    docs: {
+      description: "Check that val files only has valid imports.",
+      category: "Best Practices",
+      recommended: true
+    },
+    fixable: "code",
+    schema: []
+  },
+  create: function create(context) {
+    return {
+      ImportDeclaration: function ImportDeclaration(node) {
+        var importSource = node.source.value;
+        var filename = context.filename || context.getFilename();
+        var isValFile = filename.endsWith(".val.ts") || filename.endsWith(".val.js");
+        // only allow: .val files, @valbuild packages, and val config
+        if (isValFile && typeof importSource === "string" && !importSource.match(/\.val(\.ts|\.js|)$/) && !importSource.match(/^@valbuild/) && !importSource.match(/val\.config(\.ts|\.js|)$/)) {
+          var message = "Val: import source should be a .val.ts file, a @valbuild package, or val.config.ts. Found: '".concat(importSource, "'");
+          context.report({
+            node: node.source,
+            message: message
+          });
+        }
+      }
+    };
+  }
+};
+
+// @ts-check
+
 /**
  * @type {Plugin["rules"]}
  */
 var rules = {
-  "no-illegal-module-ids": noIllegalModuleIds
+  "no-illegal-module-ids": noIllegalModuleIds,
+  "no-illegal-imports": noIllegalImports
 };
 
 /**
  * @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();
-    }
-  }
-};
+var processors = {};
 
 /**
  * @type {Plugin}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@valbuild/eslint-plugin",
-  "version": "0.45.0",
+  "version": "0.47.0",
   "description": "ESLint rules for val",
   "keywords": [
     "eslint",

package/src/index.js

@@ -7,41 +7,20 @@
  */
 
 import noIllegalModuleIds from "./rules/noIllegalModuleIds";
+import noIllegalImports from "./rules/noIllegalImports";
 
 /**
  * @type {Plugin["rules"]}
  */
 export let rules = {
   "no-illegal-module-ids": noIllegalModuleIds,
+  "no-illegal-imports": noIllegalImports,
 };
 
 /**
  * @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();
-    },
-  },
-};
+export const processors = {};
 
 /**
  * @type {Plugin}

package/src/rules/noIllegalImports.js

@@ -0,0 +1,42 @@
+// @ts-check
+
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
+export default {
+  meta: {
+    type: "problem",
+    docs: {
+      description: "Check that val files only has valid imports.",
+      category: "Best Practices",
+      recommended: true,
+    },
+    fixable: "code",
+    schema: [],
+  },
+  create: function (context) {
+    return {
+      ImportDeclaration(node) {
+        const importSource = node.source.value;
+        const filename = context.filename || context.getFilename();
+
+        const isValFile =
+          filename.endsWith(".val.ts") || filename.endsWith(".val.js");
+        // only allow: .val files, @valbuild packages, and val config
+        if (
+          isValFile &&
+          typeof importSource === "string" &&
+          !importSource.match(/\.val(\.ts|\.js|)$/) &&
+          !importSource.match(/^@valbuild/) &&
+          !importSource.match(/val\.config(\.ts|\.js|)$/)
+        ) {
+          const message = `Val: import source should be a .val.ts file, a @valbuild package, or val.config.ts. Found: '${importSource}'`;
+          context.report({
+            node: node.source,
+            message,
+          });
+        }
+      },
+    };
+  },
+};

package/src/rules/noIllegalModuleIds.js

@@ -92,7 +92,7 @@ export default {
               if (rawArg) {
                 context.report({
                   node: firstArg,
-                  message: `Val: val.content path should match the filename. Expected: '${expectedValue}'. Found: '${firstArg.value}'`,
+                  message: `Val: val.content id should match the filename. Expected: '${expectedValue}'. Found: '${firstArg.value}'`,
                   fix: (fixer) =>
                     fixer.replaceText(
                       firstArg,

package/test/rules/noIllegalImports.test.js

@@ -0,0 +1,65 @@
+import { RuleTester } from "eslint";
+import { rules as valRules } from "@valbuild/eslint-plugin";
+import path from "path";
+
+const rule = valRules["no-illegal-imports"];
+
+RuleTester.setDefaultConfig({
+  parserOptions: {
+    ecmaVersion: 2018,
+    sourceType: "module",
+    ecmaFeatures: {
+      jsx: true,
+    },
+  },
+});
+
+const ruleTester = new RuleTester();
+
+ruleTester.run("no-illegal-imports", rule, {
+  valid: [
+    {
+      filename: path.join(process.cwd(), "./foo/test.val.ts"),
+      code: `
+import { val, s } from '../val.config';
+import { eventSchema } from './event.val';
+
+export const schema = s.array(eventSchema);
+export default val.content('/foo/test', schema, [])`,
+    },
+    {
+      filename: path.join(process.cwd(), "./foo/test.val.ts"),
+      code: `
+import { val, s } from '../val.config.ts';
+import { eventSchema } from './event.val.ts';
+
+export const schema = s.array(eventSchema);
+export default val.content('/foo/test', schema, [])`,
+    },
+    {
+      filename: path.join(process.cwd(), "./foo/test.val.ts"),
+      code: `
+import { val, s } from '../val.config.ts';
+
+export const schema = s.string();
+export default val.content('/foo/test', schema, 'String')`,
+    },
+  ],
+  invalid: [
+    {
+      filename: path.join(process.cwd(), "./foo/test.val.ts"),
+      code: `
+import { val, s } from '../val.config';
+import { eventSchema } from './event';
+
+export const schema = s.array(eventSchema);
+export default val.content('/foo/test', schema, [])`,
+      errors: [
+        {
+          message:
+            "Val: import source should be a .val.ts file, a @valbuild package, or val.config.ts. Found: './event'",
+        },
+      ],
+    },
+  ],
+});

package/test/rules/noIllegalModuleIds.test.js

@@ -34,7 +34,7 @@ ruleTester.run("no-illegal-module-ids", rule, {
       errors: [
         {
           message:
-            "Val: val.content path should match the filename. Expected: '/foo/test'. Found: 'foo'",
+            "Val: val.content id should match the filename. Expected: '/foo/test'. Found: 'foo'",
         },
       ],
       output: `import { val, s } from '../val.config.ts';
@@ -49,7 +49,7 @@ ruleTester.run("no-illegal-module-ids", rule, {
       errors: [
         {
           message:
-            "Val: val.content path should match the filename. Expected: '/foo/test'. Found: 'foo'",
+            "Val: val.content id should match the filename. Expected: '/foo/test'. Found: 'foo'",
         },
       ],
       output: `import { val, s } from "../val.config.ts";