@arrirpc/eslint-plugin 0.43.2

package/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright 2024 Joshua Sosso
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,39 @@
+# Arri-RPC Eslint Plugin
+
+## Installation
+
+```bash
+# npm
+npm i --save-dev @arrirpc/eslint-plugin
+
+# pnpm
+pnpm i --save-dev @arrirpc/eslint-plugin
+```
+
+## Usage
+
+### Use the default recommended configuration
+
+```json
+{
+    "extends": ["plugin:@arrirpc/recommended"]
+}
+```
+
+### Access the rules directly
+
+```json
+{
+    "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/index.cjs

@@ -0,0 +1,305 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+function argHasIdKey(arg) {
+  if (arg.type === "ObjectExpression") {
+    for (const prop of arg.properties) {
+      if (prop.type === "Property") {
+        if (prop.key.type === "Identifier" && prop.key.name === "id") {
+          return true;
+        }
+        if (prop.key.type === "Literal" && prop.key.value?.toString() === "id") {
+          return true;
+        }
+      }
+    }
+  }
+  return false;
+}
+function isNestedInSchema(schemaTypes, context, log = false) {
+  const ancestors = context.getAncestors();
+  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") {
+      continue;
+    }
+    if (node.callee.property.type !== "Identifier") {
+      continue;
+    }
+    const nodeName = node.callee.property.name;
+    if (schemaTypes.includes(nodeName)) {
+      return true;
+    }
+  }
+  return false;
+}
+
+const noAnonymousDiscriminator = {
+  meta: {
+    type: "suggestion"
+  },
+  create(context) {
+    return {
+      CallExpression(node) {
+        if (node.callee.type !== "MemberExpression" || node.callee.object.type !== "Identifier" || node.callee.object.name !== "a" || node.callee.property.type !== "Identifier") {
+          return;
+        }
+        const propName = node.callee.property.name;
+        if (propName !== "discriminator") {
+          return;
+        }
+        if (isNestedInSchema(["recursive"], context)) {
+          return;
+        }
+        if (node.arguments.length < 3) {
+          context.report({
+            message: "discriminator schemas must specify an id",
+            node
+          });
+          return;
+        }
+        const arg1 = node.arguments[0];
+        const arg2 = node.arguments[1];
+        const arg3 = node.arguments[2];
+        if (arg1.type === "Literal" && (arg1.value?.toString().length ?? 0) > 0 && arg2.type === "Literal" && (arg2.value?.toString().length ?? 0) > 0) {
+          return;
+        }
+        if (argHasIdKey(arg3)) {
+          return;
+        }
+        context.report({
+          message: "discriminator schemas must specify an id",
+          node
+        });
+      }
+    };
+  }
+};
+
+const noAnonymousEnumerator = {
+  meta: {
+    type: "suggestion"
+  },
+  create(context) {
+    return {
+      CallExpression(node) {
+        if (node.callee.type !== "MemberExpression" || node.callee.object.type !== "Identifier" || node.callee.object.name !== "a" || node.callee.property.type !== "Identifier") {
+          return;
+        }
+        const propName = node.callee.property.name;
+        if (propName !== "enumerator" && propName !== "stringEnum") {
+          return;
+        }
+        if (node.arguments.length < 2) {
+          context.report({
+            message: "enum schemas must specify an id",
+            node
+          });
+          return;
+        }
+        const arg1 = node.arguments[0];
+        const arg2 = node.arguments[1];
+        if (arg1.type === "Literal" && (arg1.value?.toString().length ?? 0) > 0) {
+          return;
+        }
+        if (argHasIdKey(arg2)) {
+          return;
+        }
+        context.report({
+          message: "enum schemas must specify an id",
+          node
+        });
+      }
+    };
+  }
+};
+
+const guardedSchemaTypes = ["object", "partial", "pick", "extend"];
+const defaultMessage = "root object schemas should specify an id";
+const noAnonymousObject = {
+  meta: {
+    type: "suggestion"
+  },
+  create(context) {
+    return {
+      CallExpression: (node) => {
+        if (node.callee.type !== "MemberExpression" || node.callee.object.type !== "Identifier" || node.callee.object.name !== "a" || node.callee.property.type !== "Identifier") {
+          return;
+        }
+        const nodeName = node.callee.property.name;
+        if (!guardedSchemaTypes.includes(nodeName)) {
+          return;
+        }
+        switch (nodeName) {
+          case "pick":
+            handlePick(node, context);
+            return;
+          case "partial":
+            handlePartial(node, context);
+            return;
+          case "extend":
+            handleExtend(node, context);
+            return;
+          case "object":
+            handleObject(node, context);
+        }
+      }
+    };
+  }
+};
+function handleObject(node, context) {
+  if (!isRootObjectSchema(context)) {
+    return;
+  }
+  if (node.arguments.length < 2) {
+    context.report({
+      message: defaultMessage,
+      node
+    });
+    return;
+  }
+  const arg1 = node.arguments[0];
+  const arg2 = node.arguments[1];
+  if (arg1.type === "Literal" && (arg1.value?.toString().length ?? 0) > 0) {
+    return;
+  }
+  if (argHasIdKey(arg2)) {
+    return;
+  }
+  context.report({
+    message: defaultMessage,
+    node
+  });
+}
+function handlePartial(node, context) {
+  if (!isRootObjectSchema(context)) {
+    return;
+  }
+  if (node.arguments.length < 2) {
+    context.report({
+      message: defaultMessage,
+      node
+    });
+    return;
+  }
+  if (argHasIdKey(node.arguments[1])) {
+    return;
+  }
+  context.report({
+    message: defaultMessage,
+    node
+  });
+}
+function handlePick(node, context) {
+  if (!isRootObjectSchema(context)) {
+    return;
+  }
+  if (node.arguments.length < 3) {
+    context.report({
+      message: defaultMessage,
+      node
+    });
+    return;
+  }
+  if (argHasIdKey(node.arguments[2])) {
+    return;
+  }
+  context.report({
+    message: defaultMessage,
+    node
+  });
+}
+function handleExtend(node, context) {
+  if (!isRootObjectSchema(context)) {
+    return;
+  }
+  if (node.arguments.length < 3) {
+    context.report({
+      message: defaultMessage,
+      node
+    });
+    return;
+  }
+  if (argHasIdKey(node.arguments[2])) {
+    return;
+  }
+  context.report({
+    message: defaultMessage,
+    node
+  });
+}
+function isRootObjectSchema(context, log = false) {
+  return !isNestedInSchema(
+    [...guardedSchemaTypes, "discriminator", "recursive"],
+    context,
+    log
+  );
+}
+
+const noAnonymousRecursive = {
+  meta: {
+    type: "suggestion"
+  },
+  create(context) {
+    return {
+      CallExpression(node) {
+        if (node.callee.type !== "MemberExpression" || node.callee.object.type !== "Identifier" || node.callee.object.name !== "a" || node.callee.property.type !== "Identifier") {
+          return;
+        }
+        const propName = node.callee.property.name;
+        if (propName !== "recursive") {
+          return;
+        }
+        if (node.arguments.length < 2) {
+          context.report({
+            message: "recursive schemas must specify an id",
+            node
+          });
+          return;
+        }
+        const arg1 = node.arguments[0];
+        const arg2 = node.arguments[1];
+        if (arg1.type === "Literal" && (arg1.value?.toString().length ?? 0) > 0) {
+          return;
+        }
+        if (argHasIdKey(arg2)) {
+          return;
+        }
+        context.report({
+          message: "recursive schemas must specify an id",
+          node
+        });
+      }
+    };
+  }
+};
+
+const meta = {
+  name: "@arrirpc"
+};
+const configs = {
+  recommended: {
+    plugins: ["@arrirpc"],
+    rules: {
+      "@arrirpc/no-anonymous-object": "error",
+      "@arrirpc/no-anonymous-recursive": "error",
+      "@arrirpc/no-anonymous-discriminator": "error",
+      "@arrirpc/no-anonymous-enumerator": "error"
+    }
+  }
+};
+const rules = {
+  "no-anonymous-object": noAnonymousObject,
+  "no-anonymous-recursive": noAnonymousRecursive,
+  "no-anonymous-discriminator": noAnonymousDiscriminator,
+  "no-anonymous-enumerator": noAnonymousEnumerator
+};
+const index = { meta, configs, rules };
+
+exports.configs = configs;
+exports.default = index;
+exports.meta = meta;
+exports.rules = rules;

package/dist/index.mjs

@@ -0,0 +1,298 @@
+function argHasIdKey(arg) {
+  if (arg.type === "ObjectExpression") {
+    for (const prop of arg.properties) {
+      if (prop.type === "Property") {
+        if (prop.key.type === "Identifier" && prop.key.name === "id") {
+          return true;
+        }
+        if (prop.key.type === "Literal" && prop.key.value?.toString() === "id") {
+          return true;
+        }
+      }
+    }
+  }
+  return false;
+}
+function isNestedInSchema(schemaTypes, context, log = false) {
+  const ancestors = context.getAncestors();
+  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") {
+      continue;
+    }
+    if (node.callee.property.type !== "Identifier") {
+      continue;
+    }
+    const nodeName = node.callee.property.name;
+    if (schemaTypes.includes(nodeName)) {
+      return true;
+    }
+  }
+  return false;
+}
+
+const noAnonymousDiscriminator = {
+  meta: {
+    type: "suggestion"
+  },
+  create(context) {
+    return {
+      CallExpression(node) {
+        if (node.callee.type !== "MemberExpression" || node.callee.object.type !== "Identifier" || node.callee.object.name !== "a" || node.callee.property.type !== "Identifier") {
+          return;
+        }
+        const propName = node.callee.property.name;
+        if (propName !== "discriminator") {
+          return;
+        }
+        if (isNestedInSchema(["recursive"], context)) {
+          return;
+        }
+        if (node.arguments.length < 3) {
+          context.report({
+            message: "discriminator schemas must specify an id",
+            node
+          });
+          return;
+        }
+        const arg1 = node.arguments[0];
+        const arg2 = node.arguments[1];
+        const arg3 = node.arguments[2];
+        if (arg1.type === "Literal" && (arg1.value?.toString().length ?? 0) > 0 && arg2.type === "Literal" && (arg2.value?.toString().length ?? 0) > 0) {
+          return;
+        }
+        if (argHasIdKey(arg3)) {
+          return;
+        }
+        context.report({
+          message: "discriminator schemas must specify an id",
+          node
+        });
+      }
+    };
+  }
+};
+
+const noAnonymousEnumerator = {
+  meta: {
+    type: "suggestion"
+  },
+  create(context) {
+    return {
+      CallExpression(node) {
+        if (node.callee.type !== "MemberExpression" || node.callee.object.type !== "Identifier" || node.callee.object.name !== "a" || node.callee.property.type !== "Identifier") {
+          return;
+        }
+        const propName = node.callee.property.name;
+        if (propName !== "enumerator" && propName !== "stringEnum") {
+          return;
+        }
+        if (node.arguments.length < 2) {
+          context.report({
+            message: "enum schemas must specify an id",
+            node
+          });
+          return;
+        }
+        const arg1 = node.arguments[0];
+        const arg2 = node.arguments[1];
+        if (arg1.type === "Literal" && (arg1.value?.toString().length ?? 0) > 0) {
+          return;
+        }
+        if (argHasIdKey(arg2)) {
+          return;
+        }
+        context.report({
+          message: "enum schemas must specify an id",
+          node
+        });
+      }
+    };
+  }
+};
+
+const guardedSchemaTypes = ["object", "partial", "pick", "extend"];
+const defaultMessage = "root object schemas should specify an id";
+const noAnonymousObject = {
+  meta: {
+    type: "suggestion"
+  },
+  create(context) {
+    return {
+      CallExpression: (node) => {
+        if (node.callee.type !== "MemberExpression" || node.callee.object.type !== "Identifier" || node.callee.object.name !== "a" || node.callee.property.type !== "Identifier") {
+          return;
+        }
+        const nodeName = node.callee.property.name;
+        if (!guardedSchemaTypes.includes(nodeName)) {
+          return;
+        }
+        switch (nodeName) {
+          case "pick":
+            handlePick(node, context);
+            return;
+          case "partial":
+            handlePartial(node, context);
+            return;
+          case "extend":
+            handleExtend(node, context);
+            return;
+          case "object":
+            handleObject(node, context);
+        }
+      }
+    };
+  }
+};
+function handleObject(node, context) {
+  if (!isRootObjectSchema(context)) {
+    return;
+  }
+  if (node.arguments.length < 2) {
+    context.report({
+      message: defaultMessage,
+      node
+    });
+    return;
+  }
+  const arg1 = node.arguments[0];
+  const arg2 = node.arguments[1];
+  if (arg1.type === "Literal" && (arg1.value?.toString().length ?? 0) > 0) {
+    return;
+  }
+  if (argHasIdKey(arg2)) {
+    return;
+  }
+  context.report({
+    message: defaultMessage,
+    node
+  });
+}
+function handlePartial(node, context) {
+  if (!isRootObjectSchema(context)) {
+    return;
+  }
+  if (node.arguments.length < 2) {
+    context.report({
+      message: defaultMessage,
+      node
+    });
+    return;
+  }
+  if (argHasIdKey(node.arguments[1])) {
+    return;
+  }
+  context.report({
+    message: defaultMessage,
+    node
+  });
+}
+function handlePick(node, context) {
+  if (!isRootObjectSchema(context)) {
+    return;
+  }
+  if (node.arguments.length < 3) {
+    context.report({
+      message: defaultMessage,
+      node
+    });
+    return;
+  }
+  if (argHasIdKey(node.arguments[2])) {
+    return;
+  }
+  context.report({
+    message: defaultMessage,
+    node
+  });
+}
+function handleExtend(node, context) {
+  if (!isRootObjectSchema(context)) {
+    return;
+  }
+  if (node.arguments.length < 3) {
+    context.report({
+      message: defaultMessage,
+      node
+    });
+    return;
+  }
+  if (argHasIdKey(node.arguments[2])) {
+    return;
+  }
+  context.report({
+    message: defaultMessage,
+    node
+  });
+}
+function isRootObjectSchema(context, log = false) {
+  return !isNestedInSchema(
+    [...guardedSchemaTypes, "discriminator", "recursive"],
+    context,
+    log
+  );
+}
+
+const noAnonymousRecursive = {
+  meta: {
+    type: "suggestion"
+  },
+  create(context) {
+    return {
+      CallExpression(node) {
+        if (node.callee.type !== "MemberExpression" || node.callee.object.type !== "Identifier" || node.callee.object.name !== "a" || node.callee.property.type !== "Identifier") {
+          return;
+        }
+        const propName = node.callee.property.name;
+        if (propName !== "recursive") {
+          return;
+        }
+        if (node.arguments.length < 2) {
+          context.report({
+            message: "recursive schemas must specify an id",
+            node
+          });
+          return;
+        }
+        const arg1 = node.arguments[0];
+        const arg2 = node.arguments[1];
+        if (arg1.type === "Literal" && (arg1.value?.toString().length ?? 0) > 0) {
+          return;
+        }
+        if (argHasIdKey(arg2)) {
+          return;
+        }
+        context.report({
+          message: "recursive schemas must specify an id",
+          node
+        });
+      }
+    };
+  }
+};
+
+const meta = {
+  name: "@arrirpc"
+};
+const configs = {
+  recommended: {
+    plugins: ["@arrirpc"],
+    rules: {
+      "@arrirpc/no-anonymous-object": "error",
+      "@arrirpc/no-anonymous-recursive": "error",
+      "@arrirpc/no-anonymous-discriminator": "error",
+      "@arrirpc/no-anonymous-enumerator": "error"
+    }
+  }
+};
+const rules = {
+  "no-anonymous-object": noAnonymousObject,
+  "no-anonymous-recursive": noAnonymousRecursive,
+  "no-anonymous-discriminator": noAnonymousDiscriminator,
+  "no-anonymous-enumerator": noAnonymousEnumerator
+};
+const index = { meta, configs, rules };
+
+export { configs, index as default, meta, rules };

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@arrirpc/eslint-plugin",
+  "version": "0.43.2",
+  "license": "MIT",
+  "author": {
+    "name": "joshmossas",
+    "url": "https://github.com/joshmossas"
+  },
+  "bugs": {
+    "url": "https://github.com/modiimedia/arri/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/modiimedia/arri.git",
+    "directory": "packages/eslint-plugin"
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "files": [
+    "dist"
+  ],
+  "dependencies": {},
+  "devDependencies": {
+    "@types/eslint": "^8.56.10"
+  },
+  "peerDependencies": {
+    "eslint": ">=8.0.0"
+  }
+}