@arrirpc/eslint-plugin 0.45.1 → 0.45.3

package/README.md

@@ -1,4 +1,6 @@
-# Arri-RPC Eslint Plugin
+# Arri-RPC Eslint Plugin and Configs
+
+This library provides some useful lint rules when building Arri RPC schemas.
 
 ## Installation
 
@@ -12,15 +14,24 @@ pnpm i --save-dev @arrirpc/eslint-plugin
 
 ## Usage
 
-### Use the default recommended configuration
+### 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.
+
+### Legacy Eslint Config
+
+#### Using the default recommended configuration
+
+This turns all of the `@arrirpc/eslint` rules on
 
 ```jsonc
 {
-    "extends": ["plugin:@arrirpc/recommended"],
+    "extends": ["plugin:@arrirpc/legacy-config-recommended"],
+    "files": ["**/*.ts"],
 }
 ```
 
-### Access the rules directly
+#### Manual Setup
 
 ```jsonc
 {
@@ -37,3 +48,58 @@ pnpm i --save-dev @arrirpc/eslint-plugin
     },
 }
 ```
+
+### Flat File Config
+
+#### Using the default recommended configuration
+
+This turns all of the `@arrirpc/eslint` rules on. Please note that the file extension is required to get it work properly.
+
+```js
+// eslint.config.js
+import arri from "@arrirpc/eslint-plugin/dist/configs.mjs";
+
+export default [
+    arri.recommended,
+    {
+        files: ["src/**/*.ts"], // you will still need to tell eslint which files to lint like so
+    },
+];
+```
+
+If you need commonjs support you can change the `.mjs` extension to `.cjs`
+
+```ts
+import arri from "@arrirpc/eslint-plugin/dist/configs.cjs";
+```
+
+##### Note
+
+When the flat file config format becomes the default these long imports with explicit `.mjs`/`.cjs` suffixes will not longer be required. This method is just a hacky way for us keep the old and new style configs in one package.
+
+#### Manual setup
+
+The plugin can be enabled in flat file configs like so. Fortunately this doesn't require the long ugly imports.
+
+```js
+// eslint.config.js
+import arri from "@arrirpc/eslint";
+
+export default [
+    {
+        plugins: {
+            arri,
+        },
+        rules: {
+            // check to see if an ID has been assigned to root a.object() schemas
+            "arri/no-anonymous-object": 2,
+            // check to see if an ID has been assigned to a.enumerator() or a.stringEnum() schemas
+            "arri/no-anonymous-enumerator": 2,
+            // check to see if an ID has been assigned to a.discriminator() schemas
+            "arri/no-anonymous-discriminator": 2,
+            // check to see if an ID has been assigned to a.recursive() schemas
+            "arri/no-anonymous-recursive": 2,
+        },
+    },
+];
+```

package/dist/configs.cjs

@@ -0,0 +1,22 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+const plugin = require('./shared/eslint-plugin.5adc55bc.cjs');
+
+const flatConfigs = {
+  recommended: {
+    plugins: {
+      arri: plugin.plugin
+    },
+    rules: plugin.prefixedRuleMap("arri", {
+      "no-anonymous-object": 2,
+      "no-anonymous-enumerator": 2,
+      "no-anonymous-discriminator": 2,
+      "no-anonymous-recursive": 2
+    })
+  }
+};
+
+exports.default = flatConfigs;
+exports.flatConfigs = flatConfigs;

package/dist/configs.d.cts

@@ -0,0 +1,25 @@
+import * as eslint from 'eslint';
+import { Linter } from 'eslint';
+
+declare const flatConfigs: {
+    readonly recommended: {
+        plugins: {
+            arri: {
+                meta: {
+                    name?: string | undefined;
+                    version?: string | undefined;
+                };
+                configs: Record<string, Linter.FlatConfig<Linter.RulesRecord> | eslint.ESLint.ConfigData<Linter.RulesRecord> | Linter.FlatConfig<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;
+                };
+            };
+        };
+        rules: Record<"arri/no-anonymous-discriminator" | "arri/no-anonymous-enumerator" | "arri/no-anonymous-object" | "arri/no-anonymous-recursive", Linter.RuleEntry<any[]>>;
+    };
+};
+
+export { flatConfigs as default, flatConfigs };

package/dist/configs.d.mts

@@ -0,0 +1,25 @@
+import * as eslint from 'eslint';
+import { Linter } from 'eslint';
+
+declare const flatConfigs: {
+    readonly recommended: {
+        plugins: {
+            arri: {
+                meta: {
+                    name?: string | undefined;
+                    version?: string | undefined;
+                };
+                configs: Record<string, Linter.FlatConfig<Linter.RulesRecord> | eslint.ESLint.ConfigData<Linter.RulesRecord> | Linter.FlatConfig<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;
+                };
+            };
+        };
+        rules: Record<"arri/no-anonymous-discriminator" | "arri/no-anonymous-enumerator" | "arri/no-anonymous-object" | "arri/no-anonymous-recursive", Linter.RuleEntry<any[]>>;
+    };
+};
+
+export { flatConfigs as default, flatConfigs };

package/dist/configs.d.ts

@@ -0,0 +1,25 @@
+import * as eslint from 'eslint';
+import { Linter } from 'eslint';
+
+declare const flatConfigs: {
+    readonly recommended: {
+        plugins: {
+            arri: {
+                meta: {
+                    name?: string | undefined;
+                    version?: string | undefined;
+                };
+                configs: Record<string, Linter.FlatConfig<Linter.RulesRecord> | eslint.ESLint.ConfigData<Linter.RulesRecord> | Linter.FlatConfig<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;
+                };
+            };
+        };
+        rules: Record<"arri/no-anonymous-discriminator" | "arri/no-anonymous-enumerator" | "arri/no-anonymous-object" | "arri/no-anonymous-recursive", Linter.RuleEntry<any[]>>;
+    };
+};
+
+export { flatConfigs as default, flatConfigs };

package/dist/configs.mjs

@@ -0,0 +1,17 @@
+import { p as plugin, a as prefixedRuleMap } from './shared/eslint-plugin.aced4931.mjs';
+
+const flatConfigs = {
+  recommended: {
+    plugins: {
+      arri: plugin
+    },
+    rules: prefixedRuleMap("arri", {
+      "no-anonymous-object": 2,
+      "no-anonymous-enumerator": 2,
+      "no-anonymous-discriminator": 2,
+      "no-anonymous-recursive": 2
+    })
+  }
+};
+
+export { flatConfigs as default, flatConfigs };

package/dist/plugin.cjs

@@ -0,0 +1,12 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+const plugin = require('./shared/eslint-plugin.5adc55bc.cjs');
+
+
+
+exports.configs = plugin.configs;
+exports.default = plugin.plugin;
+exports.meta = plugin.meta;
+exports.rules = plugin.rules;

package/dist/plugin.d.cts

@@ -0,0 +1,26 @@
+import * as eslint from 'eslint';
+import { ESLint } from 'eslint';
+
+declare const meta: ESLint.Plugin["meta"];
+declare const configs: ESLint.Plugin["configs"];
+declare const 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;
+};
+declare const _default: {
+    meta: {
+        name?: string | undefined;
+        version?: string | undefined;
+    };
+    configs: Record<string, ESLint.ConfigData<eslint.Linter.RulesRecord> | eslint.Linter.FlatConfig<eslint.Linter.RulesRecord> | eslint.Linter.FlatConfig<eslint.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;
+    };
+};
+
+export { configs, _default as default, meta, rules };

package/dist/plugin.d.mts

@@ -0,0 +1,26 @@
+import * as eslint from 'eslint';
+import { ESLint } from 'eslint';
+
+declare const meta: ESLint.Plugin["meta"];
+declare const configs: ESLint.Plugin["configs"];
+declare const 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;
+};
+declare const _default: {
+    meta: {
+        name?: string | undefined;
+        version?: string | undefined;
+    };
+    configs: Record<string, ESLint.ConfigData<eslint.Linter.RulesRecord> | eslint.Linter.FlatConfig<eslint.Linter.RulesRecord> | eslint.Linter.FlatConfig<eslint.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;
+    };
+};
+
+export { configs, _default as default, meta, rules };

package/dist/plugin.d.ts

@@ -0,0 +1,26 @@
+import * as eslint from 'eslint';
+import { ESLint } from 'eslint';
+
+declare const meta: ESLint.Plugin["meta"];
+declare const configs: ESLint.Plugin["configs"];
+declare const 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;
+};
+declare const _default: {
+    meta: {
+        name?: string | undefined;
+        version?: string | undefined;
+    };
+    configs: Record<string, ESLint.ConfigData<eslint.Linter.RulesRecord> | eslint.Linter.FlatConfig<eslint.Linter.RulesRecord> | eslint.Linter.FlatConfig<eslint.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;
+    };
+};
+
+export { configs, _default as default, meta, rules };

package/dist/plugin.mjs

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

package/dist/{index.cjs → shared/eslint-plugin.5adc55bc.cjs}

@@ -1,7 +1,5 @@
 'use strict';
 
-Object.defineProperty(exports, '__esModule', { value: true });
-
 function argHasIdKey(arg) {
   if (arg.type === "ObjectExpression") {
     for (const prop of arg.properties) {
@@ -277,29 +275,39 @@ const noAnonymousRecursive = {
   }
 };
 
+const rules$1 = {
+  "no-anonymous-discriminator": noAnonymousDiscriminator,
+  "no-anonymous-enumerator": noAnonymousEnumerator,
+  "no-anonymous-object": noAnonymousObject,
+  "no-anonymous-recursive": noAnonymousRecursive
+};
+function prefixedRuleMap(prefix, rules2) {
+  const result = {};
+  for (const key of Object.keys(rules2)) {
+    result[`${prefix}/${key}`] = rules2[key];
+  }
+  return result;
+}
+
 const meta = {
   name: "@arrirpc"
 };
 const configs = {
-  recommended: {
+  "legacy-config-recommended": {
     plugins: ["@arrirpc"],
-    rules: {
-      "@arrirpc/no-anonymous-object": "error",
-      "@arrirpc/no-anonymous-recursive": "error",
-      "@arrirpc/no-anonymous-discriminator": "error",
-      "@arrirpc/no-anonymous-enumerator": "error"
-    }
+    rules: prefixedRuleMap("@arrirpc", {
+      "no-anonymous-object": 2,
+      "no-anonymous-recursive": 2,
+      "no-anonymous-discriminator": 2,
+      "no-anonymous-enumerator": 2
+    })
   }
 };
-const rules = {
-  "no-anonymous-object": noAnonymousObject,
-  "no-anonymous-recursive": noAnonymousRecursive,
-  "no-anonymous-discriminator": noAnonymousDiscriminator,
-  "no-anonymous-enumerator": noAnonymousEnumerator
-};
-const index = { meta, configs, rules };
+const rules = rules$1;
+const plugin = { meta, configs, rules: rules$1 };
 
 exports.configs = configs;
-exports.default = index;
 exports.meta = meta;
+exports.plugin = plugin;
+exports.prefixedRuleMap = prefixedRuleMap;
 exports.rules = rules;

package/dist/{index.mjs → shared/eslint-plugin.aced4931.mjs}

@@ -273,26 +273,35 @@ const noAnonymousRecursive = {
   }
 };
 
+const rules$1 = {
+  "no-anonymous-discriminator": noAnonymousDiscriminator,
+  "no-anonymous-enumerator": noAnonymousEnumerator,
+  "no-anonymous-object": noAnonymousObject,
+  "no-anonymous-recursive": noAnonymousRecursive
+};
+function prefixedRuleMap(prefix, rules2) {
+  const result = {};
+  for (const key of Object.keys(rules2)) {
+    result[`${prefix}/${key}`] = rules2[key];
+  }
+  return result;
+}
+
 const meta = {
   name: "@arrirpc"
 };
 const configs = {
-  recommended: {
+  "legacy-config-recommended": {
     plugins: ["@arrirpc"],
-    rules: {
-      "@arrirpc/no-anonymous-object": "error",
-      "@arrirpc/no-anonymous-recursive": "error",
-      "@arrirpc/no-anonymous-discriminator": "error",
-      "@arrirpc/no-anonymous-enumerator": "error"
-    }
+    rules: prefixedRuleMap("@arrirpc", {
+      "no-anonymous-object": 2,
+      "no-anonymous-recursive": 2,
+      "no-anonymous-discriminator": 2,
+      "no-anonymous-enumerator": 2
+    })
   }
 };
-const rules = {
-  "no-anonymous-object": noAnonymousObject,
-  "no-anonymous-recursive": noAnonymousRecursive,
-  "no-anonymous-discriminator": noAnonymousDiscriminator,
-  "no-anonymous-enumerator": noAnonymousEnumerator
-};
-const index = { meta, configs, rules };
+const rules = rules$1;
+const plugin = { meta, configs, rules: rules$1 };
 
-export { configs, index as default, meta, rules };
+export { prefixedRuleMap as a, configs as c, meta as m, plugin as p, rules as r };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arrirpc/eslint-plugin",
-  "version": "0.45.1",
+  "version": "0.45.3",
   "license": "MIT",
   "author": {
     "name": "joshmossas",
@@ -14,8 +14,8 @@
     "url": "https://github.com/modiimedia/arri.git",
     "directory": "tooling/eslint-plugin"
   },
-  "main": "./dist/index.cjs",
-  "module": "./dist/index.mjs",
+  "main": "./dist/plugin.cjs",
+  "module": "./dist/plugin.mjs",
   "files": [
     "dist"
   ],