@newmo/eslint-plugin-graphql-fake 0.17.0

package/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2025 newmo, Inc
+
+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,44 @@
+# @newmo/eslint-plugin-graphql-fake
+
+ESLint plugin for GraphQL Fake Server. This plugin provides rules to prevent common issues when creating mock servers with GraphQL Fake.
+
+## Installation
+
+```bash
+npm install --save-dev @newmo/eslint-plugin-graphql-fake
+```
+
+## Configuration
+
+Add the following to your `eslint.config.js`:
+
+```js
+import graphqlFake from "@newmo/eslint-plugin-graphql-fake";
+
+export default [
+  // Use all recommended rules
+  ...graphqlFake.configs.recommended,
+
+  // Or configure individual rules
+  {
+    plugins: {
+      "@newmo/graphql-fake": graphqlFake,
+    },
+    rules: {
+      "@newmo/graphql-fake/required-error-directive": "error",
+    },
+  },
+];
+```
+
+## Rules
+
+- [`required-error-directive`](./docs/rules/required-error-directive.md): Requires the `@error` directive on fields named `errors`
+
+## Resources
+
+- [ESLint Flat Config Migration Guide](https://eslint.org/docs/latest/use/configure/migration-guide)
+
+## License
+
+MIT

package/dist/esm/index.d.ts

@@ -0,0 +1,15 @@
+declare const _default: {
+    rules: {
+        "required-error-directive": import("@graphql-eslint/eslint-plugin").GraphQLESLintRule;
+    };
+    configs: {
+        recommended: {
+            plugins: string[];
+            rules: {
+                "@newmo/graphql-fake/required-error-directive": string;
+            };
+        };
+    };
+};
+export default _default;
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;AAEA,wBAYE"}

package/dist/esm/index.js

@@ -0,0 +1,15 @@
+import { requiredErrorDirectiveRule } from "./rules/required-error-directive.js";
+export default {
+    rules: {
+        "required-error-directive": requiredErrorDirectiveRule,
+    },
+    configs: {
+        recommended: {
+            plugins: ["@newmo/graphql-fake"],
+            rules: {
+                "@newmo/graphql-fake/required-error-directive": "error",
+            },
+        },
+    },
+};
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,0BAA0B,EAAE,MAAM,qCAAqC,CAAC;AAEjF,eAAe;IACX,KAAK,EAAE;QACH,0BAA0B,EAAE,0BAA0B;KACzD;IACD,OAAO,EAAE;QACL,WAAW,EAAE;YACT,OAAO,EAAE,CAAC,qBAAqB,CAAC;YAChC,KAAK,EAAE;gBACH,8CAA8C,EAAE,OAAO;aAC1D;SACJ;KACJ;CACJ,CAAC"}

package/dist/esm/rules/VitestESLintRuleTester.d.ts

@@ -0,0 +1,3 @@
+import { RuleTester } from "eslint";
+export { RuleTester as VitestESLintRuleTester };
+//# sourceMappingURL=VitestESLintRuleTester.d.ts.map

package/dist/esm/rules/VitestESLintRuleTester.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"VitestESLintRuleTester.d.ts","sourceRoot":"","sources":["../../../src/rules/VitestESLintRuleTester.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAOpC,OAAO,EAAE,UAAU,IAAI,sBAAsB,EAAE,CAAC"}

package/dist/esm/rules/VitestESLintRuleTester.js

@@ -0,0 +1,8 @@
+import { RuleTester } from "eslint";
+import { describe, it } from "vitest";
+// replace `describe` and `it` with `vitest`'s
+RuleTester.describe = describe;
+RuleTester.it = it;
+RuleTester.itOnly = it.only;
+export { RuleTester as VitestESLintRuleTester };
+//# sourceMappingURL=VitestESLintRuleTester.js.map

package/dist/esm/rules/VitestESLintRuleTester.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"VitestESLintRuleTester.js","sourceRoot":"","sources":["../../../src/rules/VitestESLintRuleTester.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AACpC,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAEtC,8CAA8C;AAC9C,UAAU,CAAC,QAAQ,GAAG,QAAQ,CAAC;AAC/B,UAAU,CAAC,EAAE,GAAG,EAAE,CAAC;AACnB,UAAU,CAAC,MAAM,GAAG,EAAE,CAAC,IAAI,CAAC;AAC5B,OAAO,EAAE,UAAU,IAAI,sBAAsB,EAAE,CAAC"}

package/dist/esm/rules/required-error-directive.d.ts

@@ -0,0 +1,3 @@
+import type { GraphQLESLintRule } from "@graphql-eslint/eslint-plugin";
+export declare const requiredErrorDirectiveRule: GraphQLESLintRule;
+//# sourceMappingURL=required-error-directive.d.ts.map

package/dist/esm/rules/required-error-directive.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"required-error-directive.d.ts","sourceRoot":"","sources":["../../../src/rules/required-error-directive.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAEvE,eAAO,MAAM,0BAA0B,EAAE,iBAwCxC,CAAC"}

package/dist/esm/rules/required-error-directive.js

@@ -0,0 +1,39 @@
+export const requiredErrorDirectiveRule = {
+    meta: {
+        type: "problem",
+        docs: {
+            category: "Operations",
+            // description: "Require @error directive on fields named errors",
+            // url: "https://github.com/newmo-oss/graphql-fake-server", // TODO: Add specific URL for the rule
+            // recommended: true,
+        },
+        messages: {
+            missingErrorDirective: "should have `@error` directive for `errors` field.",
+        },
+        schema: [], // no options
+    },
+    create(context) {
+        return {
+            // Detect ObjectTypeDefinition with fields named "errors"
+            ObjectTypeDefinition(node) {
+                const errorsField = node.fields?.find((field) => {
+                    return field.name?.value === "errors";
+                });
+                if (!errorsField) {
+                    return;
+                }
+                // Check if the errors field has @error directive
+                const hasErrorDirective = errorsField.directives?.some((directive) => {
+                    return directive.name.value === "error";
+                });
+                if (!hasErrorDirective) {
+                    context.report({
+                        node: errorsField,
+                        messageId: "missingErrorDirective",
+                    });
+                }
+            },
+        };
+    },
+};
+//# sourceMappingURL=required-error-directive.js.map

package/dist/esm/rules/required-error-directive.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"required-error-directive.js","sourceRoot":"","sources":["../../../src/rules/required-error-directive.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,0BAA0B,GAAsB;IACzD,IAAI,EAAE;QACF,IAAI,EAAE,SAAS;QACf,IAAI,EAAE;YACF,QAAQ,EAAE,YAAY;YACtB,kEAAkE;YAClE,kGAAkG;YAClG,qBAAqB;SACxB;QACD,QAAQ,EAAE;YACN,qBAAqB,EAAE,oDAAoD;SAC9E;QACD,MAAM,EAAE,EAAE,EAAE,aAAa;KAC5B;IACD,MAAM,CAAC,OAAO;QACV,OAAO;YACH,yDAAyD;YACzD,oBAAoB,CAAC,IAAI;gBACrB,MAAM,WAAW,GAAG,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE;oBAC5C,OAAO,KAAK,CAAC,IAAI,EAAE,KAAK,KAAK,QAAQ,CAAC;gBAC1C,CAAC,CAAC,CAAC;gBAEH,IAAI,CAAC,WAAW,EAAE,CAAC;oBACf,OAAO;gBACX,CAAC;gBAED,iDAAiD;gBACjD,MAAM,iBAAiB,GAAG,WAAW,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE;oBACjE,OAAO,SAAS,CAAC,IAAI,CAAC,KAAK,KAAK,OAAO,CAAC;gBAC5C,CAAC,CAAC,CAAC;gBAEH,IAAI,CAAC,iBAAiB,EAAE,CAAC;oBACrB,OAAO,CAAC,MAAM,CAAC;wBACX,IAAI,EAAE,WAAW;wBACjB,SAAS,EAAE,uBAAuB;qBACrC,CAAC,CAAC;gBACP,CAAC;YACL,CAAC;SACJ,CAAC;IACN,CAAC;CACJ,CAAC"}

package/package.json

@@ -0,0 +1,72 @@
+{
+  "name": "@newmo/eslint-plugin-graphql-fake",
+  "version": "0.17.0",
+  "private": false,
+  "description": "ESLint plugin for GraphQL fake",
+  "keywords": [
+    "eslint",
+    "eslintplugin",
+    "eslint-plugin",
+    "graphql",
+    "fake",
+    "testing",
+    "mock"
+  ],
+  "repository": "https://github.com/newmo-oss/graphql-fake-server.git",
+  "license": "MIT",
+  "author": "newmo, Inc.",
+  "sideEffects": false,
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/esm/index.d.ts",
+        "default": "./dist/esm/index.js"
+      }
+    }
+  },
+  "main": "./dist/esm/index.js",
+  "files": [
+    "src/",
+    "!src/test",
+    "!src/**/*.test.ts",
+    "!src/**/__snapshots__",
+    "dist/"
+  ],
+  "scripts": {
+    "prepare": "npm run build",
+    "build": "run-s -c build:*",
+    "build:esm": "tsc -p tsconfig.build.json",
+    "lint": "run-s -c lint:*",
+    "lint:tsc": "tsc",
+    "test": "vitest run",
+    "updateSnapshot": "vitest run -u"
+  },
+  "dependencies": {
+    "@graphql-eslint/eslint-plugin": "^4.3.0"
+  },
+  "devDependencies": {
+    "@tsconfig/node18": "^18.2.0",
+    "@tsconfig/strictest": "^2.0.1",
+    "@types/eslint": "^9.6.1",
+    "@types/node": "^22.13.1",
+    "eslint": "^9.23.0",
+    "graphql": "^16.10.0",
+    "npm-run-all2": "^7.0.2",
+    "typescript": "^5.8.2",
+    "vitest": "^3.0.9",
+    "vitest-github-actions-reporter": "^0.11.1"
+  },
+  "peerDependencies": {
+    "eslint": ">=9.0.0",
+    "graphql": "^16.8.1"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "gitHead": "4e53b3d209d6a339835c0ff42913fdb8d285e71d"
+}

package/src/index.ts

@@ -0,0 +1,15 @@
+import { requiredErrorDirectiveRule } from "./rules/required-error-directive.js";
+
+export default {
+    rules: {
+        "required-error-directive": requiredErrorDirectiveRule,
+    },
+    configs: {
+        recommended: {
+            plugins: ["@newmo/graphql-fake"],
+            rules: {
+                "@newmo/graphql-fake/required-error-directive": "error",
+            },
+        },
+    },
+};

package/src/rules/VitestESLintRuleTester.ts

@@ -0,0 +1,8 @@
+import { RuleTester } from "eslint";
+import { describe, it } from "vitest";
+
+// replace `describe` and `it` with `vitest`'s
+RuleTester.describe = describe;
+RuleTester.it = it;
+RuleTester.itOnly = it.only;
+export { RuleTester as VitestESLintRuleTester };

package/src/rules/required-error-directive.ts

@@ -0,0 +1,43 @@
+import type { GraphQLESLintRule } from "@graphql-eslint/eslint-plugin";
+
+export const requiredErrorDirectiveRule: GraphQLESLintRule = {
+    meta: {
+        type: "problem",
+        docs: {
+            category: "Operations",
+            // description: "Require @error directive on fields named errors",
+            // url: "https://github.com/newmo-oss/graphql-fake-server", // TODO: Add specific URL for the rule
+            // recommended: true,
+        },
+        messages: {
+            missingErrorDirective: "should have `@error` directive for `errors` field.",
+        },
+        schema: [], // no options
+    },
+    create(context) {
+        return {
+            // Detect ObjectTypeDefinition with fields named "errors"
+            ObjectTypeDefinition(node) {
+                const errorsField = node.fields?.find((field) => {
+                    return field.name?.value === "errors";
+                });
+
+                if (!errorsField) {
+                    return;
+                }
+
+                // Check if the errors field has @error directive
+                const hasErrorDirective = errorsField.directives?.some((directive) => {
+                    return directive.name.value === "error";
+                });
+
+                if (!hasErrorDirective) {
+                    context.report({
+                        node: errorsField,
+                        messageId: "missingErrorDirective",
+                    });
+                }
+            },
+        };
+    },
+};