@arrirpc/eslint-plugin 0.76.4 → 0.77.0

package/README.md

@@ -1,6 +1,8 @@
 # Arri-RPC Eslint Plugin and Configs
 
-This library provides some useful lint rules when building Arri RPC schemas.
+This library provides some useful lint rules when building schemas for Arri-RPC.
+
+If you are using Arri Schema standalone and are not using any of the codegen features the only lint rule you will probably need is `arri/prefer-modular-imports`.
 
 ## Installation
 
@@ -14,26 +16,33 @@ pnpm i --save-dev @arrirpc/eslint-plugin
 
 ## Usage
 
-### Ecosystem Note
-
-This library supports both [flat file config format](https://eslint.org/docs/latest/use/configure/configuration-files) and the [legacy config format](https://eslint.org/docs/latest/use/configure/configuration-files-deprecated). Right now, the legacy format is the default. When more of the ecosystem has moved to supporting the new format this library will swap defaults, and potentially drop support for the old format. When such a change happens, it will be marked as a breaking change.
-
 ### Flat File Config
 
-#### Using the default recommended configuration
+#### Use one of the premade configurations
 
-This turns all of the `@arrirpc/eslint` rules on.
+- **recommended**: turns on all of the lint rules related to schema building and codegen
+- **all**: the same as recommended but also includes the `prefer-modular-imports` rule
 
 ```js
 // eslint.config.js
 import arri from '@arrirpc/eslint-plugin/configs';
 
+// turn on lint rules related to schema building and codegen
 export default [
     arri.recommended,
     {
-        files: ['src/**/*.ts'], // you will still need to tell eslint which files to lint like so
+        files: ['src/**/*.ts'],
     },
 ];
+
+
+// turn on all arri lint rules
+export default [
+    arri.all,
+    {
+        files: ['src/**/*.ts']
+    }
+]
 ```
 
 #### Manual setup
@@ -58,6 +67,8 @@ export default [
             'arri/no-anonymous-discriminator': 2,
             // check to see if an ID has been assigned to a.recursive() schemas
             'arri/no-anonymous-recursive': 2,
+            // enforce using arri's tree-shakable imports instead of the non tree-shakable imports to keep bundle sizes lower
+            'arri/prefer-modular-imports': 2,
         },
     },
 ];
@@ -67,13 +78,18 @@ export default [
 
 #### Using the default recommended configuration
 
-This turns all of the `@arrirpc/eslint` rules on
-
 ```jsonc
+// Arri-RPC recommended
 {
     "extends": ["plugin:@arrirpc/legacy-config-recommended"],
     "files": ["**/*.ts"],
 }
+
+// all rules
+{
+    "extends": ["plugin:@arrirpc/legacy-config-all"],
+    "files": ["**/*.ts"]
+}
 ```
 
 #### Manual Setup
@@ -90,6 +106,8 @@ This turns all of the `@arrirpc/eslint` rules on
         "@arrirpc/no-anonymous-discriminator": 2,
         // check to see if an ID has been assigned to a.recursive() schemas
         "@arrirpc/no-anonymous-recursive": 2,
+        // enforce usage of modular imports to reduce bundle size
+        "@arrirpc/prefer-modular-imports": 2,
     },
 }
 ```

package/dist/configs.cjs

@@ -2,7 +2,7 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-const plugin = require('./shared/eslint-plugin.KTsOJsei.cjs');
+const plugin = require('./shared/eslint-plugin.OTGuyyTf.cjs');
 
 const flatConfigs = {
   recommended: {
@@ -13,7 +13,20 @@ const flatConfigs = {
       "no-anonymous-object": 2,
       "no-anonymous-enumerator": 2,
       "no-anonymous-discriminator": 2,
-      "no-anonymous-recursive": 2
+      "no-anonymous-recursive": 2,
+      "prefer-modular-imports": 0
+    })
+  },
+  all: {
+    plugins: {
+      arri: plugin.plugin
+    },
+    rules: plugin.prefixedRuleMap("arri", {
+      "no-anonymous-discriminator": 2,
+      "no-anonymous-enumerator": 2,
+      "no-anonymous-object": 2,
+      "no-anonymous-recursive": 2,
+      "prefer-modular-imports": 2
     })
   }
 };

package/dist/configs.d.cts

@@ -9,18 +9,39 @@ declare const flatConfigs: {
                     name?: string | undefined;
                     version?: string | undefined;
                 };
-                configs: Record<string, Linter.LegacyConfig<Linter.RulesRecord, Linter.RulesRecord> | Linter.Config<Linter.RulesRecord> | Linter.Config<Linter.RulesRecord>[]>;
+                configs: Record<string, Linter.Config<Linter.RulesRecord> | Linter.LegacyConfig<Linter.RulesRecord, Linter.RulesRecord> | Linter.Config<Linter.RulesRecord>[]>;
                 rules: {
                     readonly 'no-anonymous-discriminator': eslint.Rule.RuleModule;
                     readonly 'no-anonymous-enumerator': eslint.Rule.RuleModule;
                     readonly 'no-anonymous-object': eslint.Rule.RuleModule;
                     readonly 'no-anonymous-recursive': eslint.Rule.RuleModule;
+                    readonly 'prefer-modular-imports': eslint.Rule.RuleModule;
                 };
             };
         };
-        rules: Record<"arri/no-anonymous-discriminator" | "arri/no-anonymous-enumerator" | "arri/no-anonymous-object" | "arri/no-anonymous-recursive", Linter.RuleEntry<any[]>>;
+        rules: Record<"arri/no-anonymous-discriminator" | "arri/no-anonymous-enumerator" | "arri/no-anonymous-object" | "arri/no-anonymous-recursive" | "arri/prefer-modular-imports", Linter.RuleEntry<any[]>>;
+    };
+    readonly all: {
+        plugins: {
+            arri: {
+                meta: {
+                    name?: string | undefined;
+                    version?: string | undefined;
+                };
+                configs: Record<string, Linter.Config<Linter.RulesRecord> | Linter.LegacyConfig<Linter.RulesRecord, Linter.RulesRecord> | Linter.Config<Linter.RulesRecord>[]>;
+                rules: {
+                    readonly 'no-anonymous-discriminator': eslint.Rule.RuleModule;
+                    readonly 'no-anonymous-enumerator': eslint.Rule.RuleModule;
+                    readonly 'no-anonymous-object': eslint.Rule.RuleModule;
+                    readonly 'no-anonymous-recursive': eslint.Rule.RuleModule;
+                    readonly 'prefer-modular-imports': eslint.Rule.RuleModule;
+                };
+            };
+        };
+        rules: Record<"arri/no-anonymous-discriminator" | "arri/no-anonymous-enumerator" | "arri/no-anonymous-object" | "arri/no-anonymous-recursive" | "arri/prefer-modular-imports", Linter.RuleEntry<any[]>>;
     };
 };
 
+// @ts-ignore
 export = flatConfigs;
 export { flatConfigs };

package/dist/configs.d.mts

@@ -9,16 +9,36 @@ declare const flatConfigs: {
                     name?: string | undefined;
                     version?: string | undefined;
                 };
-                configs: Record<string, Linter.LegacyConfig<Linter.RulesRecord, Linter.RulesRecord> | Linter.Config<Linter.RulesRecord> | Linter.Config<Linter.RulesRecord>[]>;
+                configs: Record<string, Linter.Config<Linter.RulesRecord> | Linter.LegacyConfig<Linter.RulesRecord, Linter.RulesRecord> | Linter.Config<Linter.RulesRecord>[]>;
                 rules: {
                     readonly 'no-anonymous-discriminator': eslint.Rule.RuleModule;
                     readonly 'no-anonymous-enumerator': eslint.Rule.RuleModule;
                     readonly 'no-anonymous-object': eslint.Rule.RuleModule;
                     readonly 'no-anonymous-recursive': eslint.Rule.RuleModule;
+                    readonly 'prefer-modular-imports': eslint.Rule.RuleModule;
                 };
             };
         };
-        rules: Record<"arri/no-anonymous-discriminator" | "arri/no-anonymous-enumerator" | "arri/no-anonymous-object" | "arri/no-anonymous-recursive", Linter.RuleEntry<any[]>>;
+        rules: Record<"arri/no-anonymous-discriminator" | "arri/no-anonymous-enumerator" | "arri/no-anonymous-object" | "arri/no-anonymous-recursive" | "arri/prefer-modular-imports", Linter.RuleEntry<any[]>>;
+    };
+    readonly all: {
+        plugins: {
+            arri: {
+                meta: {
+                    name?: string | undefined;
+                    version?: string | undefined;
+                };
+                configs: Record<string, Linter.Config<Linter.RulesRecord> | Linter.LegacyConfig<Linter.RulesRecord, Linter.RulesRecord> | Linter.Config<Linter.RulesRecord>[]>;
+                rules: {
+                    readonly 'no-anonymous-discriminator': eslint.Rule.RuleModule;
+                    readonly 'no-anonymous-enumerator': eslint.Rule.RuleModule;
+                    readonly 'no-anonymous-object': eslint.Rule.RuleModule;
+                    readonly 'no-anonymous-recursive': eslint.Rule.RuleModule;
+                    readonly 'prefer-modular-imports': eslint.Rule.RuleModule;
+                };
+            };
+        };
+        rules: Record<"arri/no-anonymous-discriminator" | "arri/no-anonymous-enumerator" | "arri/no-anonymous-object" | "arri/no-anonymous-recursive" | "arri/prefer-modular-imports", Linter.RuleEntry<any[]>>;
     };
 };
 

package/dist/configs.d.ts

@@ -9,18 +9,39 @@ declare const flatConfigs: {
                     name?: string | undefined;
                     version?: string | undefined;
                 };
-                configs: Record<string, Linter.LegacyConfig<Linter.RulesRecord, Linter.RulesRecord> | Linter.Config<Linter.RulesRecord> | Linter.Config<Linter.RulesRecord>[]>;
+                configs: Record<string, Linter.Config<Linter.RulesRecord> | Linter.LegacyConfig<Linter.RulesRecord, Linter.RulesRecord> | Linter.Config<Linter.RulesRecord>[]>;
                 rules: {
                     readonly 'no-anonymous-discriminator': eslint.Rule.RuleModule;
                     readonly 'no-anonymous-enumerator': eslint.Rule.RuleModule;
                     readonly 'no-anonymous-object': eslint.Rule.RuleModule;
                     readonly 'no-anonymous-recursive': eslint.Rule.RuleModule;
+                    readonly 'prefer-modular-imports': eslint.Rule.RuleModule;
                 };
             };
         };
-        rules: Record<"arri/no-anonymous-discriminator" | "arri/no-anonymous-enumerator" | "arri/no-anonymous-object" | "arri/no-anonymous-recursive", Linter.RuleEntry<any[]>>;
+        rules: Record<"arri/no-anonymous-discriminator" | "arri/no-anonymous-enumerator" | "arri/no-anonymous-object" | "arri/no-anonymous-recursive" | "arri/prefer-modular-imports", Linter.RuleEntry<any[]>>;
+    };
+    readonly all: {
+        plugins: {
+            arri: {
+                meta: {
+                    name?: string | undefined;
+                    version?: string | undefined;
+                };
+                configs: Record<string, Linter.Config<Linter.RulesRecord> | Linter.LegacyConfig<Linter.RulesRecord, Linter.RulesRecord> | Linter.Config<Linter.RulesRecord>[]>;
+                rules: {
+                    readonly 'no-anonymous-discriminator': eslint.Rule.RuleModule;
+                    readonly 'no-anonymous-enumerator': eslint.Rule.RuleModule;
+                    readonly 'no-anonymous-object': eslint.Rule.RuleModule;
+                    readonly 'no-anonymous-recursive': eslint.Rule.RuleModule;
+                    readonly 'prefer-modular-imports': eslint.Rule.RuleModule;
+                };
+            };
+        };
+        rules: Record<"arri/no-anonymous-discriminator" | "arri/no-anonymous-enumerator" | "arri/no-anonymous-object" | "arri/no-anonymous-recursive" | "arri/prefer-modular-imports", Linter.RuleEntry<any[]>>;
     };
 };
 
+// @ts-ignore
 export = flatConfigs;
 export { flatConfigs };

package/dist/configs.mjs

@@ -1,4 +1,4 @@
-import { p as prefixedRuleMap, a as plugin } from './shared/eslint-plugin.B2xKduqu.mjs';
+import { p as prefixedRuleMap, a as plugin } from './shared/eslint-plugin.TPk3R2S0.mjs';
 
 const flatConfigs = {
   recommended: {
@@ -9,7 +9,20 @@ const flatConfigs = {
       "no-anonymous-object": 2,
       "no-anonymous-enumerator": 2,
       "no-anonymous-discriminator": 2,
-      "no-anonymous-recursive": 2
+      "no-anonymous-recursive": 2,
+      "prefer-modular-imports": 0
+    })
+  },
+  all: {
+    plugins: {
+      arri: plugin
+    },
+    rules: prefixedRuleMap("arri", {
+      "no-anonymous-discriminator": 2,
+      "no-anonymous-enumerator": 2,
+      "no-anonymous-object": 2,
+      "no-anonymous-recursive": 2,
+      "prefer-modular-imports": 2
     })
   }
 };

package/dist/plugin.cjs

@@ -2,7 +2,7 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-const plugin = require('./shared/eslint-plugin.KTsOJsei.cjs');
+const plugin = require('./shared/eslint-plugin.OTGuyyTf.cjs');
 
 
 

package/dist/plugin.d.cts

@@ -8,6 +8,7 @@ declare const rules: {
     readonly 'no-anonymous-enumerator': eslint.Rule.RuleModule;
     readonly 'no-anonymous-object': eslint.Rule.RuleModule;
     readonly 'no-anonymous-recursive': eslint.Rule.RuleModule;
+    readonly 'prefer-modular-imports': eslint.Rule.RuleModule;
 };
 declare const _default: {
     meta: {
@@ -20,8 +21,10 @@ declare const _default: {
         readonly 'no-anonymous-enumerator': eslint.Rule.RuleModule;
         readonly 'no-anonymous-object': eslint.Rule.RuleModule;
         readonly 'no-anonymous-recursive': eslint.Rule.RuleModule;
+        readonly 'prefer-modular-imports': eslint.Rule.RuleModule;
     };
 };
 
+// @ts-ignore
 export = _default;
 export { configs, meta, rules };

package/dist/plugin.d.mts

@@ -8,6 +8,7 @@ declare const rules: {
     readonly 'no-anonymous-enumerator': eslint.Rule.RuleModule;
     readonly 'no-anonymous-object': eslint.Rule.RuleModule;
     readonly 'no-anonymous-recursive': eslint.Rule.RuleModule;
+    readonly 'prefer-modular-imports': eslint.Rule.RuleModule;
 };
 declare const _default: {
     meta: {
@@ -20,6 +21,7 @@ declare const _default: {
         readonly 'no-anonymous-enumerator': eslint.Rule.RuleModule;
         readonly 'no-anonymous-object': eslint.Rule.RuleModule;
         readonly 'no-anonymous-recursive': eslint.Rule.RuleModule;
+        readonly 'prefer-modular-imports': eslint.Rule.RuleModule;
     };
 };
 

package/dist/plugin.d.ts

@@ -8,6 +8,7 @@ declare const rules: {
     readonly 'no-anonymous-enumerator': eslint.Rule.RuleModule;
     readonly 'no-anonymous-object': eslint.Rule.RuleModule;
     readonly 'no-anonymous-recursive': eslint.Rule.RuleModule;
+    readonly 'prefer-modular-imports': eslint.Rule.RuleModule;
 };
 declare const _default: {
     meta: {
@@ -20,8 +21,10 @@ declare const _default: {
         readonly 'no-anonymous-enumerator': eslint.Rule.RuleModule;
         readonly 'no-anonymous-object': eslint.Rule.RuleModule;
         readonly 'no-anonymous-recursive': eslint.Rule.RuleModule;
+        readonly 'prefer-modular-imports': eslint.Rule.RuleModule;
     };
 };
 
+// @ts-ignore
 export = _default;
 export { configs, meta, rules };

package/dist/plugin.mjs

@@ -1 +1 @@
-export { c as configs, a as default, m as meta, r as rules } from './shared/eslint-plugin.B2xKduqu.mjs';
+export { c as configs, a as default, m as meta, r as rules } from './shared/eslint-plugin.TPk3R2S0.mjs';

package/dist/shared/{eslint-plugin.KTsOJsei.cjs → eslint-plugin.OTGuyyTf.cjs}

@@ -287,11 +287,108 @@ const noAnonymousRecursive = {
   }
 };
 
+const preferModularImports = {
+  meta: {
+    type: "suggestion",
+    fixable: "code",
+    messages: {
+      arriModularImportError: "use Arri's modular import syntax instead"
+    }
+  },
+  create(context) {
+    return {
+      ImportDeclaration(node) {
+        if (node.source.value !== "@arrirpc/schema") return;
+        let targetNode;
+        let numIdentifiers = 0;
+        for (let i = 0; i < node.specifiers.length; i++) {
+          const specifier = node.specifiers[i];
+          if (specifier.type !== "ImportSpecifier") continue;
+          if (specifier.imported.type !== "Identifier") continue;
+          numIdentifiers++;
+          if (specifier.imported.name !== "a") continue;
+          targetNode = specifier;
+        }
+        if (!targetNode) return;
+        const fix = (fixer) => {
+          if (numIdentifiers === 1) {
+            return fixer.replaceText(
+              node,
+              "import * as a from '@arrirpc/schema';"
+            );
+          }
+          const parent = node.parent;
+          if (parent.type !== "Program")
+            return fixer.insertTextAfter(node, "");
+          const newStringParts = [];
+          let skipNext = false;
+          let importPart = "";
+          let shouldExitNext = false;
+          const loc = node.loc;
+          console.log("LOC", loc);
+          for (let i = 0; i < parent.tokens.length; i++) {
+            const token = parent.tokens[i];
+            if (shouldExitNext) {
+              if (token.value === ";") {
+                newStringParts.push(token.value);
+              }
+              break;
+            }
+            console.log("TOKEN", token.loc);
+            if (token.loc.start.line > (loc?.start.line ?? 0))
+              break;
+            if (token.loc.start.line !== loc?.start.line) continue;
+            if (skipNext && token.type == "Punctuator" && token.value === ",") {
+              skipNext = false;
+              continue;
+            }
+            skipNext = false;
+            if (token.type == "Identifier" && token.value === "a") {
+              skipNext = true;
+              continue;
+            }
+            switch (token.value) {
+              case "import":
+              case "from":
+              case "{":
+              case ",":
+                newStringParts.push(token.value + " ");
+                break;
+              case "}":
+                newStringParts.push(" " + token.value + " ");
+                break;
+              case "'@arrirpc/schema'":
+              case '"@arrirpc/schema"':
+                importPart = token.value;
+                newStringParts.push(token.value);
+                shouldExitNext = true;
+                break;
+              default:
+                newStringParts.push(token.value);
+            }
+          }
+          return fixer.replaceText(
+            node,
+            `import * as a from ${importPart};
+${newStringParts.join("")}`
+          );
+        };
+        context.report({
+          node: targetNode,
+          messageId: "arriModularImportError",
+          fix
+        });
+      }
+    };
+  }
+};
+
 const rules$1 = {
   "no-anonymous-discriminator": noAnonymousDiscriminator,
   "no-anonymous-enumerator": noAnonymousEnumerator,
   "no-anonymous-object": noAnonymousObject,
-  "no-anonymous-recursive": noAnonymousRecursive
+  "no-anonymous-recursive": noAnonymousRecursive,
+  "prefer-modular-imports": preferModularImports
 };
 function prefixedRuleMap(prefix, rules2) {
   const result = {};
@@ -311,7 +408,18 @@ const configs = {
       "no-anonymous-object": 2,
       "no-anonymous-recursive": 2,
       "no-anonymous-discriminator": 2,
-      "no-anonymous-enumerator": 2
+      "no-anonymous-enumerator": 2,
+      "prefer-modular-imports": 0
+    })
+  },
+  "legacy-config-all": {
+    plugins: ["@arrirpc"],
+    rules: prefixedRuleMap("@arrirpc", {
+      "no-anonymous-object": 2,
+      "no-anonymous-recursive": 2,
+      "no-anonymous-discriminator": 2,
+      "no-anonymous-enumerator": 2,
+      "prefer-modular-imports": 2
     })
   }
 };

package/dist/shared/{eslint-plugin.B2xKduqu.mjs → eslint-plugin.TPk3R2S0.mjs}

@@ -285,11 +285,108 @@ const noAnonymousRecursive = {
   }
 };
 
+const preferModularImports = {
+  meta: {
+    type: "suggestion",
+    fixable: "code",
+    messages: {
+      arriModularImportError: "use Arri's modular import syntax instead"
+    }
+  },
+  create(context) {
+    return {
+      ImportDeclaration(node) {
+        if (node.source.value !== "@arrirpc/schema") return;
+        let targetNode;
+        let numIdentifiers = 0;
+        for (let i = 0; i < node.specifiers.length; i++) {
+          const specifier = node.specifiers[i];
+          if (specifier.type !== "ImportSpecifier") continue;
+          if (specifier.imported.type !== "Identifier") continue;
+          numIdentifiers++;
+          if (specifier.imported.name !== "a") continue;
+          targetNode = specifier;
+        }
+        if (!targetNode) return;
+        const fix = (fixer) => {
+          if (numIdentifiers === 1) {
+            return fixer.replaceText(
+              node,
+              "import * as a from '@arrirpc/schema';"
+            );
+          }
+          const parent = node.parent;
+          if (parent.type !== "Program")
+            return fixer.insertTextAfter(node, "");
+          const newStringParts = [];
+          let skipNext = false;
+          let importPart = "";
+          let shouldExitNext = false;
+          const loc = node.loc;
+          console.log("LOC", loc);
+          for (let i = 0; i < parent.tokens.length; i++) {
+            const token = parent.tokens[i];
+            if (shouldExitNext) {
+              if (token.value === ";") {
+                newStringParts.push(token.value);
+              }
+              break;
+            }
+            console.log("TOKEN", token.loc);
+            if (token.loc.start.line > (loc?.start.line ?? 0))
+              break;
+            if (token.loc.start.line !== loc?.start.line) continue;
+            if (skipNext && token.type == "Punctuator" && token.value === ",") {
+              skipNext = false;
+              continue;
+            }
+            skipNext = false;
+            if (token.type == "Identifier" && token.value === "a") {
+              skipNext = true;
+              continue;
+            }
+            switch (token.value) {
+              case "import":
+              case "from":
+              case "{":
+              case ",":
+                newStringParts.push(token.value + " ");
+                break;
+              case "}":
+                newStringParts.push(" " + token.value + " ");
+                break;
+              case "'@arrirpc/schema'":
+              case '"@arrirpc/schema"':
+                importPart = token.value;
+                newStringParts.push(token.value);
+                shouldExitNext = true;
+                break;
+              default:
+                newStringParts.push(token.value);
+            }
+          }
+          return fixer.replaceText(
+            node,
+            `import * as a from ${importPart};
+${newStringParts.join("")}`
+          );
+        };
+        context.report({
+          node: targetNode,
+          messageId: "arriModularImportError",
+          fix
+        });
+      }
+    };
+  }
+};
+
 const rules$1 = {
   "no-anonymous-discriminator": noAnonymousDiscriminator,
   "no-anonymous-enumerator": noAnonymousEnumerator,
   "no-anonymous-object": noAnonymousObject,
-  "no-anonymous-recursive": noAnonymousRecursive
+  "no-anonymous-recursive": noAnonymousRecursive,
+  "prefer-modular-imports": preferModularImports
 };
 function prefixedRuleMap(prefix, rules2) {
   const result = {};
@@ -309,7 +406,18 @@ const configs = {
       "no-anonymous-object": 2,
       "no-anonymous-recursive": 2,
       "no-anonymous-discriminator": 2,
-      "no-anonymous-enumerator": 2
+      "no-anonymous-enumerator": 2,
+      "prefer-modular-imports": 0
+    })
+  },
+  "legacy-config-all": {
+    plugins: ["@arrirpc"],
+    rules: prefixedRuleMap("@arrirpc", {
+      "no-anonymous-object": 2,
+      "no-anonymous-recursive": 2,
+      "no-anonymous-discriminator": 2,
+      "no-anonymous-enumerator": 2,
+      "prefer-modular-imports": 2
     })
   }
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arrirpc/eslint-plugin",
-  "version": "0.76.4",
+  "version": "0.77.0",
   "license": "MIT",
   "type": "module",
   "author": {