@valbuild/eslint-plugin 0.47.0 → 0.48.0

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

@@ -46,8 +46,7 @@ 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",
+      description: "Check that the first argument of export default declaration matches the string from val.config.{j,t}s file.",
       recommended: true
     },
     fixable: "code",
@@ -130,10 +129,8 @@ var noIllegalImports = {
     type: "problem",
     docs: {
       description: "Check that val files only has valid imports.",
-      category: "Best Practices",
       recommended: true
     },
-    fixable: "code",
     schema: []
   },
   create: function create(context) {
@@ -144,11 +141,49 @@ var noIllegalImports = {
         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
-          });
+          if ("importKind" in node && node["importKind"] !== "type" && !node.specifiers.every(function (s) {
+            return "importKind" in s && s["importKind"] === "type";
+          })) {
+            var message = "Val: can only 'import type' or import from source that is either: a .val.{j,t}s file, a @valbuild package, or val.config.{j,t}s.";
+            context.report({
+              node: node.source,
+              message: message
+            });
+          }
+        }
+      }
+    };
+  }
+};
+
+// @ts-check
+
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
+var exportContentMustBeValid = {
+  meta: {
+    type: "problem",
+    docs: {
+      description: "Export val.content should only happen in .val files.",
+      recommended: true
+    },
+    messages: {
+      "val/export-content-must-be-valid": "Val: val.content should only be exported from .val files"
+    },
+    schema: []
+  },
+  create: function create(context) {
+    return {
+      ExportDefaultDeclaration: function ExportDefaultDeclaration(node) {
+        if (node.declaration && node.declaration.type === "CallExpression" && node.declaration.callee.type === "MemberExpression" && node.declaration.callee.object.type === "Identifier" && node.declaration.callee.object.name === "val" && node.declaration.callee.property.type === "Identifier" && node.declaration.callee.property.name === "content") {
+          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"))) {
+            context.report({
+              node: node.declaration.callee,
+              messageId: "val/export-content-must-be-valid"
+            });
+          }
         }
       }
     };
@@ -162,7 +197,8 @@ var noIllegalImports = {
  */
 var rules = {
   "no-illegal-module-ids": noIllegalModuleIds,
-  "no-illegal-imports": noIllegalImports
+  "no-illegal-imports": noIllegalImports,
+  "export-content-must-be-valid": exportContentMustBeValid
 };
 
 /**

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

@@ -46,8 +46,7 @@ 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",
+      description: "Check that the first argument of export default declaration matches the string from val.config.{j,t}s file.",
       recommended: true
     },
     fixable: "code",
@@ -130,10 +129,8 @@ var noIllegalImports = {
     type: "problem",
     docs: {
       description: "Check that val files only has valid imports.",
-      category: "Best Practices",
       recommended: true
     },
-    fixable: "code",
     schema: []
   },
   create: function create(context) {
@@ -144,11 +141,49 @@ var noIllegalImports = {
         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
-          });
+          if ("importKind" in node && node["importKind"] !== "type" && !node.specifiers.every(function (s) {
+            return "importKind" in s && s["importKind"] === "type";
+          })) {
+            var message = "Val: can only 'import type' or import from source that is either: a .val.{j,t}s file, a @valbuild package, or val.config.{j,t}s.";
+            context.report({
+              node: node.source,
+              message: message
+            });
+          }
+        }
+      }
+    };
+  }
+};
+
+// @ts-check
+
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
+var exportContentMustBeValid = {
+  meta: {
+    type: "problem",
+    docs: {
+      description: "Export val.content should only happen in .val files.",
+      recommended: true
+    },
+    messages: {
+      "val/export-content-must-be-valid": "Val: val.content should only be exported from .val files"
+    },
+    schema: []
+  },
+  create: function create(context) {
+    return {
+      ExportDefaultDeclaration: function ExportDefaultDeclaration(node) {
+        if (node.declaration && node.declaration.type === "CallExpression" && node.declaration.callee.type === "MemberExpression" && node.declaration.callee.object.type === "Identifier" && node.declaration.callee.object.name === "val" && node.declaration.callee.property.type === "Identifier" && node.declaration.callee.property.name === "content") {
+          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"))) {
+            context.report({
+              node: node.declaration.callee,
+              messageId: "val/export-content-must-be-valid"
+            });
+          }
         }
       }
     };
@@ -162,7 +197,8 @@ var noIllegalImports = {
  */
 var rules = {
   "no-illegal-module-ids": noIllegalModuleIds,
-  "no-illegal-imports": noIllegalImports
+  "no-illegal-imports": noIllegalImports,
+  "export-content-must-be-valid": exportContentMustBeValid
 };
 
 /**

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

@@ -38,8 +38,7 @@ 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",
+      description: "Check that the first argument of export default declaration matches the string from val.config.{j,t}s file.",
       recommended: true
     },
     fixable: "code",
@@ -122,10 +121,8 @@ var noIllegalImports = {
     type: "problem",
     docs: {
       description: "Check that val files only has valid imports.",
-      category: "Best Practices",
       recommended: true
     },
-    fixable: "code",
     schema: []
   },
   create: function create(context) {
@@ -136,11 +133,49 @@ var noIllegalImports = {
         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
-          });
+          if ("importKind" in node && node["importKind"] !== "type" && !node.specifiers.every(function (s) {
+            return "importKind" in s && s["importKind"] === "type";
+          })) {
+            var message = "Val: can only 'import type' or import from source that is either: a .val.{j,t}s file, a @valbuild package, or val.config.{j,t}s.";
+            context.report({
+              node: node.source,
+              message: message
+            });
+          }
+        }
+      }
+    };
+  }
+};
+
+// @ts-check
+
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
+var exportContentMustBeValid = {
+  meta: {
+    type: "problem",
+    docs: {
+      description: "Export val.content should only happen in .val files.",
+      recommended: true
+    },
+    messages: {
+      "val/export-content-must-be-valid": "Val: val.content should only be exported from .val files"
+    },
+    schema: []
+  },
+  create: function create(context) {
+    return {
+      ExportDefaultDeclaration: function ExportDefaultDeclaration(node) {
+        if (node.declaration && node.declaration.type === "CallExpression" && node.declaration.callee.type === "MemberExpression" && node.declaration.callee.object.type === "Identifier" && node.declaration.callee.object.name === "val" && node.declaration.callee.property.type === "Identifier" && node.declaration.callee.property.name === "content") {
+          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"))) {
+            context.report({
+              node: node.declaration.callee,
+              messageId: "val/export-content-must-be-valid"
+            });
+          }
         }
       }
     };
@@ -154,7 +189,8 @@ var noIllegalImports = {
  */
 var rules = {
   "no-illegal-module-ids": noIllegalModuleIds,
-  "no-illegal-imports": noIllegalImports
+  "no-illegal-imports": noIllegalImports,
+  "export-content-must-be-valid": exportContentMustBeValid
 };
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@valbuild/eslint-plugin",
-  "version": "0.47.0",
+  "version": "0.48.0",
   "description": "ESLint rules for val",
   "keywords": [
     "eslint",
@@ -27,7 +27,8 @@
   },
   "devDependencies": {
     "@types/jest": "^29.5.11",
-    "eslint": "^7.10.0",
+    "@typescript-eslint/rule-tester": "^6.15.0",
+    "eslint": "^8.56.0",
     "jest": "^29.6"
   },
   "scripts": {

package/src/index.js

@@ -8,6 +8,7 @@
 
 import noIllegalModuleIds from "./rules/noIllegalModuleIds";
 import noIllegalImports from "./rules/noIllegalImports";
+import exportContentMustBeValid from "./rules/exportContentMustBeValid";
 
 /**
  * @type {Plugin["rules"]}
@@ -15,6 +16,7 @@ import noIllegalImports from "./rules/noIllegalImports";
 export let rules = {
   "no-illegal-module-ids": noIllegalModuleIds,
   "no-illegal-imports": noIllegalImports,
+  "export-content-must-be-valid": exportContentMustBeValid,
 };
 
 /**

package/src/rules/exportContentMustBeValid.js

@@ -0,0 +1,44 @@
+// @ts-check
+
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
+export default {
+  meta: {
+    type: "problem",
+    docs: {
+      description: "Export val.content should only happen in .val files.",
+      recommended: true,
+    },
+    messages: {
+      "val/export-content-must-be-valid":
+        "Val: val.content should only be exported from .val files",
+    },
+    schema: [],
+  },
+  create: function (context) {
+    return {
+      ExportDefaultDeclaration(node) {
+        if (
+          node.declaration &&
+          node.declaration.type === "CallExpression" &&
+          node.declaration.callee.type === "MemberExpression" &&
+          node.declaration.callee.object.type === "Identifier" &&
+          node.declaration.callee.object.name === "val" &&
+          node.declaration.callee.property.type === "Identifier" &&
+          node.declaration.callee.property.name === "content"
+        ) {
+          const filename = context.filename || context.getFilename();
+          if (
+            !(filename?.endsWith(".val.ts") || filename?.endsWith(".val.js"))
+          ) {
+            context.report({
+              node: node.declaration.callee,
+              messageId: "val/export-content-must-be-valid",
+            });
+          }
+        }
+      },
+    };
+  },
+};

package/src/rules/noIllegalImports.js

@@ -8,10 +8,8 @@ export default {
     type: "problem",
     docs: {
       description: "Check that val files only has valid imports.",
-      category: "Best Practices",
       recommended: true,
     },
-    fixable: "code",
     schema: [],
   },
   create: function (context) {
@@ -30,11 +28,19 @@ export default {
           !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,
-          });
+          if (
+            "importKind" in node &&
+            node["importKind"] !== "type" &&
+            !node.specifiers.every(
+              (s) => "importKind" in s && s["importKind"] === "type"
+            )
+          ) {
+            const message = `Val: can only 'import type' or import from source that is either: a .val.{j,t}s file, a @valbuild package, or val.config.{j,t}s.`;
+            context.report({
+              node: node.source,
+              message,
+            });
+          }
         }
       },
     };

package/src/rules/noIllegalModuleIds.js

@@ -9,8 +9,7 @@ export default {
     type: "problem",
     docs: {
       description:
-        "Check that the first argument of export default declaration matches the string from val.config.ts file.",
-      category: "Best Practices",
+        "Check that the first argument of export default declaration matches the string from val.config.{j,t}s file.",
       recommended: true,
     },
     fixable: "code",

package/test/rules/exportContentMustBeValid.test.js

@@ -0,0 +1,56 @@
+import { RuleTester } from "@typescript-eslint/rule-tester";
+import { rules as valRules } from "@valbuild/eslint-plugin";
+import path from "path";
+
+const rule = valRules["export-content-must-be-valid"];
+
+RuleTester.setDefaultConfig({
+  parserOptions: {
+    ecmaVersion: 2018,
+    sourceType: "module",
+    ecmaFeatures: {},
+  },
+});
+
+const ruleTester = new RuleTester();
+
+ruleTester.run("export-content-must-be-valid", rule, {
+  valid: [
+    {
+      filename: path.join(process.cwd(), "./foo/test.val.ts"),
+      code: `
+import { val, s } from '../val.config';
+
+export const schema = s.string();
+export default val.content('/foo/test', schema, '')`,
+    },
+  ],
+  invalid: [
+    {
+      filename: path.join(process.cwd(), "./foo/test.ts"),
+      code: `
+import { val, s } from '../val.config';
+
+export const schema = s.string();
+export default val.content('/foo/test', schema, '')`,
+      errors: [
+        {
+          message: "Val: val.content should only be exported from .val files",
+        },
+      ],
+    },
+    {
+      filename: path.join(process.cwd(), "./foo/test.js"),
+      code: `
+import { val, s } from '../val.config';
+
+export const schema = s.string();
+export default val.content('/foo/test', schema, '')`,
+      errors: [
+        {
+          message: "Val: val.content should only be exported from .val files",
+        },
+      ],
+    },
+  ],
+});

package/test/rules/noIllegalImports.test.js

@@ -1,4 +1,4 @@
-import { RuleTester } from "eslint";
+import { RuleTester } from "@typescript-eslint/rule-tester";
 import { rules as valRules } from "@valbuild/eslint-plugin";
 import path from "path";
 
@@ -8,9 +8,8 @@ RuleTester.setDefaultConfig({
   parserOptions: {
     ecmaVersion: 2018,
     sourceType: "module",
-    ecmaFeatures: {
-      jsx: true,
-    },
+
+    ecmaFeatures: {},
   },
 });
 
@@ -40,6 +39,26 @@ 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 type { Event } from './eventSchema';
+
+export const schema = s.array(s.string());
+type Test = Event;
+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 { type Event } from './eventSchema';
+
+export const schema = s.array(s.string());
+type Test = Event;
+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')`,
@@ -57,7 +76,23 @@ 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'",
+            "Val: can only 'import type' or import from source that is either: a .val.{j,t}s file, a @valbuild package, or val.config.{j,t}s.",
+        },
+      ],
+    },
+    {
+      filename: path.join(process.cwd(), "./foo/test.val.ts"),
+      code: `
+import { val, s } from '../val.config';
+import { eventSchema, type Unused } from './event';
+
+export const schema = s.array(eventSchema);
+type Event = Unused;
+export default val.content('/foo/test', schema, [])`,
+      errors: [
+        {
+          message:
+            "Val: can only 'import type' or import from source that is either: a .val.{j,t}s file, a @valbuild package, or val.config.{j,t}s.",
         },
       ],
     },