@arrirpc/eslint-plugin 0.45.4 → 0.45.6

package/README.md

@@ -18,46 +18,15 @@ pnpm i --save-dev @arrirpc/eslint-plugin
 
 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/legacy-config-recommended"],
-    "files": ["**/*.ts"],
-}
-```
-
-#### Manual Setup
-
-```jsonc
-{
-    "plugins": ["@arrirpc"],
-    "rules": {
-        // check to see if an ID has been assigned to root a.object() schemas
-        "@arrirpc/no-anonymous-object": 2,
-        // check to see if an ID has been assigned to a.enumerator() or a.stringEnum() schemas
-        "@arrirpc/no-anonymous-enumerator": 2,
-        // check to see if an ID has been assigned to a.discriminator() schemas
-        "@arrirpc/no-anonymous-discriminator": 2,
-        // check to see if an ID has been assigned to a.recursive() schemas
-        "@arrirpc/no-anonymous-recursive": 2,
-    },
-}
-```
-
 ### 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.
+This turns all of the `@arrirpc/eslint` rules on.
 
 ```js
 // eslint.config.js
-import arri from "@arrirpc/eslint-plugin/dist/configs.mjs";
+import arri from "@arrirpc/eslint-plugin/configs";
 
 export default [
     arri.recommended,
@@ -67,19 +36,9 @@ export default [
 ];
 ```
 
-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.
+The plugin can be enabled in flat file configs like so.
 
 ```js
 // eslint.config.js
@@ -103,3 +62,34 @@ export default [
     },
 ];
 ```
+
+### Legacy Eslint Config
+
+#### Using the default recommended configuration
+
+This turns all of the `@arrirpc/eslint` rules on
+
+```jsonc
+{
+    "extends": ["plugin:@arrirpc/legacy-config-recommended"],
+    "files": ["**/*.ts"],
+}
+```
+
+#### Manual Setup
+
+```jsonc
+{
+    "plugins": ["@arrirpc"],
+    "rules": {
+        // check to see if an ID has been assigned to root a.object() schemas
+        "@arrirpc/no-anonymous-object": 2,
+        // check to see if an ID has been assigned to a.enumerator() or a.stringEnum() schemas
+        "@arrirpc/no-anonymous-enumerator": 2,
+        // check to see if an ID has been assigned to a.discriminator() schemas
+        "@arrirpc/no-anonymous-discriminator": 2,
+        // check to see if an ID has been assigned to a.recursive() schemas
+        "@arrirpc/no-anonymous-recursive": 2,
+    },
+}
+```

package/dist/configs.cjs

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

package/dist/configs.mjs

@@ -1,4 +1,4 @@
-import { p as plugin, a as prefixedRuleMap } from './shared/eslint-plugin.aced4931.mjs';
+import { p as plugin, a as prefixedRuleMap } from './shared/eslint-plugin.558090f3.mjs';
 
 const flatConfigs = {
   recommended: {

package/dist/plugin.cjs

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

package/dist/plugin.mjs

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

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

@@ -13,19 +13,24 @@ function argHasIdKey(arg) {
   }
   return false;
 }
-function isNestedInSchema(schemaTypes, context, log = false) {
-  const ancestors = context.getAncestors();
+function isNestedInSchema(node, schemaTypes, context, log = false) {
+  const sourceCode = "sourceCode" in context ? context.sourceCode : (
+    // legacy method
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    context.getSourceCode()
+  );
+  const ancestors = sourceCode.getAncestors(node);
   if (log) {
     console.log(ancestors);
   }
-  for (const node of ancestors) {
-    if (node.type !== "CallExpression" || node.callee.type !== "MemberExpression" || node.callee.object.type !== "Identifier" || node.callee.object.name !== "a") {
+  for (const node2 of ancestors) {
+    if (node2.type !== "CallExpression" || node2.callee.type !== "MemberExpression" || node2.callee.object.type !== "Identifier" || node2.callee.object.name !== "a") {
       continue;
     }
-    if (node.callee.property.type !== "Identifier") {
+    if (node2.callee.property.type !== "Identifier") {
       continue;
     }
-    const nodeName = node.callee.property.name;
+    const nodeName = node2.callee.property.name;
     if (schemaTypes.includes(nodeName)) {
       return true;
     }
@@ -47,7 +52,7 @@ const noAnonymousDiscriminator = {
         if (propName !== "discriminator") {
           return;
         }
-        if (isNestedInSchema(["recursive"], context)) {
+        if (isNestedInSchema(node, ["recursive"], context)) {
           return;
         }
         if (node.arguments.length < 3) {
@@ -89,9 +94,16 @@ const noAnonymousEnumerator = {
         if (propName !== "enumerator" && propName !== "stringEnum") {
           return;
         }
+        if (isNestedInSchema(
+          node,
+          ["object", "discriminator", "recursive"],
+          context
+        )) {
+          return;
+        }
         if (node.arguments.length < 2) {
           context.report({
-            message: "enum schemas must specify an id",
+            message: "root enum schemas must specify an id",
             node
           });
           return;
@@ -105,7 +117,7 @@ const noAnonymousEnumerator = {
           return;
         }
         context.report({
-          message: "enum schemas must specify an id",
+          message: "root enum schemas must specify an id",
           node
         });
       }
@@ -147,7 +159,7 @@ const noAnonymousObject = {
   }
 };
 function handleObject(node, context) {
-  if (!isRootObjectSchema(context)) {
+  if (!isRootObjectSchema(node, context)) {
     return;
   }
   if (node.arguments.length < 2) {
@@ -171,7 +183,7 @@ function handleObject(node, context) {
   });
 }
 function handlePartial(node, context) {
-  if (!isRootObjectSchema(context)) {
+  if (!isRootObjectSchema(node, context)) {
     return;
   }
   if (node.arguments.length < 2) {
@@ -190,7 +202,7 @@ function handlePartial(node, context) {
   });
 }
 function handlePick(node, context) {
-  if (!isRootObjectSchema(context)) {
+  if (!isRootObjectSchema(node, context)) {
     return;
   }
   if (node.arguments.length < 3) {
@@ -208,27 +220,28 @@ function handlePick(node, context) {
     node
   });
 }
-function handleExtend(node, context) {
-  if (!isRootObjectSchema(context)) {
+function handleExtend(expression, context) {
+  if (!isRootObjectSchema(expression, context)) {
     return;
   }
-  if (node.arguments.length < 3) {
+  if (expression.arguments.length < 3) {
     context.report({
       message: defaultMessage,
-      node
+      node: expression
     });
     return;
   }
-  if (argHasIdKey(node.arguments[2])) {
+  if (argHasIdKey(expression.arguments[2])) {
     return;
   }
   context.report({
     message: defaultMessage,
-    node
+    node: expression
   });
 }
-function isRootObjectSchema(context, log = false) {
+function isRootObjectSchema(node, context, log = false) {
   return !isNestedInSchema(
+    node,
     [...guardedSchemaTypes, "discriminator", "recursive"],
     context,
     log

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

@@ -15,19 +15,24 @@ function argHasIdKey(arg) {
   }
   return false;
 }
-function isNestedInSchema(schemaTypes, context, log = false) {
-  const ancestors = context.getAncestors();
+function isNestedInSchema(node, schemaTypes, context, log = false) {
+  const sourceCode = "sourceCode" in context ? context.sourceCode : (
+    // legacy method
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    context.getSourceCode()
+  );
+  const ancestors = sourceCode.getAncestors(node);
   if (log) {
     console.log(ancestors);
   }
-  for (const node of ancestors) {
-    if (node.type !== "CallExpression" || node.callee.type !== "MemberExpression" || node.callee.object.type !== "Identifier" || node.callee.object.name !== "a") {
+  for (const node2 of ancestors) {
+    if (node2.type !== "CallExpression" || node2.callee.type !== "MemberExpression" || node2.callee.object.type !== "Identifier" || node2.callee.object.name !== "a") {
       continue;
     }
-    if (node.callee.property.type !== "Identifier") {
+    if (node2.callee.property.type !== "Identifier") {
       continue;
     }
-    const nodeName = node.callee.property.name;
+    const nodeName = node2.callee.property.name;
     if (schemaTypes.includes(nodeName)) {
       return true;
     }
@@ -49,7 +54,7 @@ const noAnonymousDiscriminator = {
         if (propName !== "discriminator") {
           return;
         }
-        if (isNestedInSchema(["recursive"], context)) {
+        if (isNestedInSchema(node, ["recursive"], context)) {
           return;
         }
         if (node.arguments.length < 3) {
@@ -91,9 +96,16 @@ const noAnonymousEnumerator = {
         if (propName !== "enumerator" && propName !== "stringEnum") {
           return;
         }
+        if (isNestedInSchema(
+          node,
+          ["object", "discriminator", "recursive"],
+          context
+        )) {
+          return;
+        }
         if (node.arguments.length < 2) {
           context.report({
-            message: "enum schemas must specify an id",
+            message: "root enum schemas must specify an id",
             node
           });
           return;
@@ -107,7 +119,7 @@ const noAnonymousEnumerator = {
           return;
         }
         context.report({
-          message: "enum schemas must specify an id",
+          message: "root enum schemas must specify an id",
           node
         });
       }
@@ -149,7 +161,7 @@ const noAnonymousObject = {
   }
 };
 function handleObject(node, context) {
-  if (!isRootObjectSchema(context)) {
+  if (!isRootObjectSchema(node, context)) {
     return;
   }
   if (node.arguments.length < 2) {
@@ -173,7 +185,7 @@ function handleObject(node, context) {
   });
 }
 function handlePartial(node, context) {
-  if (!isRootObjectSchema(context)) {
+  if (!isRootObjectSchema(node, context)) {
     return;
   }
   if (node.arguments.length < 2) {
@@ -192,7 +204,7 @@ function handlePartial(node, context) {
   });
 }
 function handlePick(node, context) {
-  if (!isRootObjectSchema(context)) {
+  if (!isRootObjectSchema(node, context)) {
     return;
   }
   if (node.arguments.length < 3) {
@@ -210,27 +222,28 @@ function handlePick(node, context) {
     node
   });
 }
-function handleExtend(node, context) {
-  if (!isRootObjectSchema(context)) {
+function handleExtend(expression, context) {
+  if (!isRootObjectSchema(expression, context)) {
     return;
   }
-  if (node.arguments.length < 3) {
+  if (expression.arguments.length < 3) {
     context.report({
       message: defaultMessage,
-      node
+      node: expression
     });
     return;
   }
-  if (argHasIdKey(node.arguments[2])) {
+  if (argHasIdKey(expression.arguments[2])) {
     return;
   }
   context.report({
     message: defaultMessage,
-    node
+    node: expression
   });
 }
-function isRootObjectSchema(context, log = false) {
+function isRootObjectSchema(node, context, log = false) {
   return !isNestedInSchema(
+    node,
     [...guardedSchemaTypes, "discriminator", "recursive"],
     context,
     log

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arrirpc/eslint-plugin",
-  "version": "0.45.4",
+  "version": "0.45.6",
   "license": "MIT",
   "author": {
     "name": "joshmossas",
@@ -16,6 +16,16 @@
   },
   "main": "./dist/plugin.cjs",
   "module": "./dist/plugin.mjs",
+  "exports": {
+    ".": {
+      "import": "./dist/plugin.mjs",
+      "require": "./dist/plugin.cjs"
+    },
+    "./configs": {
+      "import": "./dist/configs.mjs",
+      "require": "./dist/configs.cjs"
+    }
+  },
   "files": [
     "dist"
   ],