chore: add monorepo example (#1084)

* chore: add monorepo example

* add helpful comment in examples eslintrc configs

Author: dimaMachina

README.md

@@ -192,7 +192,7 @@ See [docs/deprecated-rules.md](docs/deprecated-rules.md).
 
 > If you are in a project that develops GraphQL operations (query/mutation/subscription), you'll need `operations` rules.
 
-> If you are in a monorepo project, you probably need both sets of rules.
+> If you are in a monorepo project, you probably need both sets of rules, see [example of configuration](examples/monorepo/.eslintrc.cjs).
 
 ### Config usage
 

examples/basic/.eslintrc.cjs

@@ -1,5 +1,9 @@
 module.exports = {
   root: true,
+  // ❗️ It's very important that you don't have any rules configured at the top-level config,
+  // and to move all configurations into the overrides section. Since JavaScript rules
+  // can't run on GraphQL files and vice versa, if you have rules configured at the top level,
+  // they will try to also execute for all overrides, as ESLint's configs cascade
   overrides: [
     {
       files: ['*.js'],

examples/basic/package.json

@@ -13,6 +13,6 @@
   },
   "devDependencies": {
     "@graphql-eslint/eslint-plugin": "3.10.4",
-    "eslint": "8.14.0"
+    "eslint": "8.17.0"
   }
 }

examples/code-file/.eslintrc.cjs

@@ -1,5 +1,9 @@
 module.exports = {
   root: true,
+  // ❗️ It's very important that you don't have any rules configured at the top-level config,
+  // and to move all configurations into the overrides section. Since JavaScript rules
+  // can't run on GraphQL files and vice versa, if you have rules configured at the top level,
+  // they will try to also execute for all overrides, as ESLint's configs cascade
   overrides: [
     {
       files: ['*.js'],

examples/code-file/package.json

@@ -13,6 +13,6 @@
   },
   "devDependencies": {
     "@graphql-eslint/eslint-plugin": "3.10.4",
-    "eslint": "8.14.0"
+    "eslint": "8.17.0"
   }
 }

examples/graphql-config-code-file/.eslintrc.cjs

@@ -1,5 +1,9 @@
 module.exports = {
   root: true,
+  // ❗️ It's very important that you don't have any rules configured at the top-level config,
+  // and to move all configurations into the overrides section. Since JavaScript rules
+  // can't run on GraphQL files and vice versa, if you have rules configured at the top level,
+  // they will try to also execute for all overrides, as ESLint's configs cascade
   overrides: [
     {
       files: ['*.js'],

examples/graphql-config-code-file/package.json

@@ -14,6 +14,6 @@
   },
   "devDependencies": {
     "@graphql-eslint/eslint-plugin": "3.10.4",
-    "eslint": "8.14.0"
+    "eslint": "8.17.0"
   }
 }

examples/graphql-config/.eslintrc.cjs

@@ -1,5 +1,9 @@
 module.exports = {
   root: true,
+  // ❗️ It's very important that you don't have any rules configured at the top-level config,
+  // and to move all configurations into the overrides section. Since JavaScript rules
+  // can't run on GraphQL files and vice versa, if you have rules configured at the top level,
+  // they will try to also execute for all overrides, as ESLint's configs cascade
   overrides: [
     {
       files: ['*.js'],

examples/graphql-config/package.json

@@ -13,6 +13,6 @@
   },
   "devDependencies": {
     "@graphql-eslint/eslint-plugin": "3.10.4",
-    "eslint": "8.14.0"
+    "eslint": "8.17.0"
   }
 }

examples/monorepo/.eslintrc.cjs

@@ -0,0 +1,60 @@
+/* eslint-env node */
+const SCHEMA_PATH = 'server/**/*.gql';
+const OPERATIONS_PATH = 'client/**/*.{tsx,gql}';
+
+module.exports = {
+  root: true,
+  // ❗️ It's very important that you don't have any rules configured at the top-level config,
+  // and to move all configurations into the overrides section. Since JavaScript rules
+  // can't run on GraphQL files and vice versa, if you have rules configured at the top level,
+  // they will try to also execute for all overrides, as ESLint's configs cascade
+  overrides: [
+    {
+      files: '*.{cjs,tsx}',
+      extends: 'eslint:recommended',
+      env: {
+        es2022: true,
+      },
+    },
+    {
+      files: 'client/**/*.tsx',
+      parserOptions: {
+        sourceType: 'module',
+        ecmaFeatures: {
+          jsx: true,
+        },
+      },
+    },
+    {
+      // Setup GraphQL Parser
+      files: '*.{graphql,gql}',
+      parser: '@graphql-eslint/eslint-plugin',
+      plugins: ['@graphql-eslint'],
+      parserOptions: {
+        schema: SCHEMA_PATH,
+        operations: OPERATIONS_PATH,
+      },
+    },
+    {
+      // Setup processor for operations/fragments definitions on code-files
+      files: 'client/**/*.tsx',
+      processor: '@graphql-eslint/graphql',
+    },
+    {
+      // Setup recommended config for schema files
+      files: SCHEMA_PATH,
+      extends: 'plugin:@graphql-eslint/schema-recommended',
+      rules: {
+        // Override graphql-eslint rules for schema files
+      },
+    },
+    {
+      // Setup recommended config for operations files
+      files: 'client/**/*.{graphql,gql}',
+      extends: 'plugin:@graphql-eslint/operations-recommended',
+      rules: {
+        // Override graphql-eslint rules for operations files
+      },
+    },
+  ],
+};