Multi projects example (#1201)

* add multi project example

* chore(dependencies): updated changesets for modified dependencies

* fix

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Author: dimaMachina

.changeset/@graphql-eslint_eslint-plugin-1201-dependencies.md

@@ -0,0 +1,5 @@
+---
+'@graphql-eslint/eslint-plugin': patch
+---
+dependencies updates:
+  - Updated dependency [`graphql-config@^4.3.6` ↗︎](https://www.npmjs.com/package/graphql-config/v/4.3.6) (from `^4.3.5`, in `dependencies`)

examples/multiple-projects-graphql-config/.eslintrc.cjs

@@ -0,0 +1,31 @@
+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'],
+      processor: '@graphql-eslint/graphql',
+      extends: ['eslint:recommended'],
+      parserOptions: {
+        sourceType: 'module',
+      },
+      env: {
+        es6: true,
+      },
+    },
+    {
+      files: ['schema.*.graphql'],
+      extends: ['plugin:@graphql-eslint/schema-recommended'],
+      rules: {
+        '@graphql-eslint/require-description': 'off',
+      },
+    },
+    {
+      files: ['*.js/*.graphql'],
+      extends: ['plugin:@graphql-eslint/operations-recommended'],
+    },
+  ],
+};

examples/multiple-projects-graphql-config/graphql.config.ts

@@ -0,0 +1,25 @@
+import { IGraphQLConfig } from 'graphql-config';
+import { GraphQLTagPluckOptions } from '@graphql-tools/graphql-tag-pluck';
+
+const config: IGraphQLConfig = {
+  projects: {
+    firstProject: {
+      schema: 'schema.first-project.graphql',
+      documents: 'query.first-project.js',
+    },
+    secondProject: {
+      schema: 'schema.second-project.graphql',
+      documents: 'query.second-project.js',
+      extensions: {
+        // in case you want to use different names for magic comment and module identifier
+        pluckConfig: <GraphQLTagPluckOptions>{
+          modules: [{ name: 'custom-graphql-tag', identifier: 'custom' }],
+          globalGqlIdentifierName: 'custom',
+          gqlMagicComment: 'MyGraphQL',
+        },
+      },
+    },
+  },
+};
+
+export default config;

examples/multiple-projects-graphql-config/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "@graphql-eslint/example-multiple-projects-graphql-config",
+  "version": "0.0.0",
+  "private": true,
+  "author": "Dimitri POSTOLOV",
+  "scripts": {
+    "lint": "eslint ."
+  },
+  "dependencies": {
+    "graphql": "16.6.0"
+  },
+  "devDependencies": {
+    "@graphql-eslint/eslint-plugin": "3.11.2",
+    "eslint": "8.24.0"
+  }
+}

examples/multiple-projects-graphql-config/query.first-project.js

@@ -0,0 +1,16 @@
+import { gql } from 'graphql-tag';
+
+/* GraphQL */ `
+  fragment UserFields on User {
+    firstname
+    lastname
+  }
+`;
+
+gql`
+  {
+    user {
+      ...UserFields
+    }
+  }
+`;

examples/multiple-projects-graphql-config/query.second-project.js

@@ -0,0 +1,16 @@
+import { custom } from 'custom-graphql-tag';
+
+/* MyGraphQL */ `
+  fragment UserFields on User {
+    firstName
+    lastName
+  }
+`;
+
+custom`
+  {
+    users {
+      ...UserFields
+    }
+  }
+`;

examples/multiple-projects-graphql-config/schema.first-project.graphql

@@ -0,0 +1,8 @@
+type User {
+  firstname: String
+  lastname: String
+}
+
+type Query {
+  user: User
+}

examples/multiple-projects-graphql-config/schema.second-project.graphql

@@ -0,0 +1,8 @@
+type User {
+  firstName: String
+  lastName: String
+}
+
+type Query {
+  users: [User]
+}

packages/plugin/package.json

@@ -41,7 +41,7 @@
     "chalk": "^4.1.2",
     "debug": "^4.3.4",
     "fast-glob": "^3.2.12",
-    "graphql-config": "^4.3.5",
+    "graphql-config": "^4.3.6",
     "graphql-depth-limit": "^1.1.0",
     "lodash.lowercase": "^4.3.0"
   },

packages/plugin/src/graphql-config.ts

@@ -1,33 +1,19 @@
 import { dirname } from 'path';
 import debugFactory from 'debug';
-import {
-  GraphQLConfig,
-  GraphQLExtensionDeclaration,
-  loadConfigSync,
-  SchemaPointer,
-} from 'graphql-config';
-import { GraphQLTagPluckOptions } from '@graphql-tools/graphql-tag-pluck';
+import { GraphQLConfig, loadConfigSync, SchemaPointer } from 'graphql-config';
 import { CodeFileLoader } from '@graphql-tools/code-file-loader';
 import { ParserOptions } from './types';
 
 const debug = debugFactory('graphql-eslint:graphql-config');
 let graphQLConfig: GraphQLConfig;
 
 export function loadOnDiskGraphQLConfig(filePath: string): GraphQLConfig {
-  const rootDir = dirname(filePath);
-  const config = loadConfigSync({
+  return loadConfigSync({
     // load config relative to the file being linted
-    rootDir,
+    rootDir: dirname(filePath),
     throwOnEmpty: false,
     throwOnMissing: false,
-  });
-  if (!config) {
-    return null;
-  }
-  const project = config.getProjectForFile(filePath);
-  return loadConfigSync({
-    rootDir,
-    extensions: [codeFileLoaderExtension(project.extensions.pluckConfig)],
+    extensions: [codeFileLoaderExtension],
   });
 }
 
@@ -62,17 +48,15 @@ export function loadGraphQLConfig(options: ParserOptions): GraphQLConfig {
         config: configOptions,
         filepath: 'virtual-config',
       },
-      [codeFileLoaderExtension(options.extensions?.pluckConfig)],
+      [codeFileLoaderExtension],
     );
 
   return graphQLConfig;
 }
 
-const codeFileLoaderExtension =
-  (pluckConfig: GraphQLTagPluckOptions): GraphQLExtensionDeclaration =>
-  api => {
-    const { schema, documents } = api.loaders;
-    schema.register(new CodeFileLoader({ pluckConfig }));
-    documents.register(new CodeFileLoader({ pluckConfig }));
-    return { name: 'graphql-eslint-loaders' };
-  };
+const codeFileLoaderExtension = api => {
+  const { schema, documents } = api.loaders;
+  schema.register(new CodeFileLoader());
+  documents.register(new CodeFileLoader());
+  return { name: 'graphql-eslint-loaders' };
+};