aa

Author: dimaMachina

.changeset/strong-otters-mate.md

@@ -0,0 +1,5 @@
+---
+'@graphql-eslint/eslint-plugin': patch
+---
+
+add an example with custom graphql rules

examples/custom-rule/eslint.config.js

@@ -0,0 +1,21 @@
+import graphqlPlugin from '@graphql-eslint/eslint-plugin';
+import { rule } from './my-rule.js'
+
+export default [
+  {
+    files: ['**/*.graphql'],
+    languageOptions: {
+      parser: graphqlPlugin.parser,
+    },
+    plugins: {
+      '@internal': {
+        rules: {
+          'my-rule': rule
+        }
+      },
+    },
+    rules: {
+      '@internal/my-rule': 'error',
+    },
+  },
+];

examples/custom-rule/my-rule.js

@@ -0,0 +1,14 @@
+export const rule = {
+  create(context) {
+    return {
+      OperationDefinition(node) {
+        if (!node.name?.value) {
+          context.report({
+            node,
+            message: 'Oops, name is required!'
+          })
+        }
+      }
+    }
+  }
+}

examples/custom-rule/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "@graphql-eslint/example-custom-rule",
+  "version": "0.0.0",
+  "type": "module",
+  "repository": "https://github.com/dimaMachina/graphql-eslint",
+  "author": "Dimitri POSTOLOV <[email protected]>",
+  "private": true,
+  "scripts": {
+    "lint": "eslint --cache ."
+  },
+  "dependencies": {
+    "graphql": "16.9.0"
+  },
+  "devDependencies": {
+    "@graphql-eslint/eslint-plugin": "4.1.0",
+    "eslint": "9.15.0"
+  }
+}

examples/custom-rule/test.graphql

@@ -0,0 +1 @@
+query { foo }