Fixes for graphql-config and processor (#192)

dotansimha · web-flow · commit 0707231d5efb · 2020-12-03T19:21:05.000+02:00
diff --git a/.changeset/config.json b/.changeset/config.json
@@ -6,5 +6,9 @@
   "access": "restricted",
   "baseBranch": "master",
   "updateInternalDependencies": "patch",
-  "ignore": ["@graphql-eslint/example"]
+  "ignore": [
+    "@graphql-eslint/example-code-file",
+    "@graphql-eslint/example-basic",
+    "@graphql-eslint/example-graphql-config"
+  ]
 }
diff --git a/.changeset/two-readers-exercise.md b/.changeset/two-readers-exercise.md
@@ -0,0 +1,5 @@
+---
+'@graphql-eslint/eslint-plugin': patch
+---
+
+fix(parser): better support for graphql-config intergration and project detection
diff --git a/.changeset/weak-worms-collect.md b/.changeset/weak-worms-collect.md
@@ -0,0 +1,5 @@
+---
+'@graphql-eslint/eslint-plugin': minor
+---
+
+feature(processor): apply processor automatically on code files
diff --git a/example/query.js b/example/query.js
diff --git a/examples/basic/.eslintrc.json b/examples/basic/.eslintrc.json
@@ -1,10 +1,10 @@
 {  
-  "processor": "@graphql-eslint/graphql",
   "overrides": [
     {
       "files": ["*.graphql"],
       "parser": "@graphql-eslint/eslint-plugin",
       "parserOptions": {
+        "operations": ["query.graphql"],
         "schema": "./**/schema.graphql"
       },
       "plugins": ["@graphql-eslint"],
diff --git a/examples/basic/package.json b/examples/basic/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "@graphql-eslint/example",
+  "name": "@graphql-eslint/example-basic",
   "private": true,
   "version": "0.0.1",
   "repository": "https://github.com/dotansimha/graphql-eslint",
diff --git a/examples/basic/query.graphql b/examples/basic/query.graphql
diff --git a/examples/basic/schema.graphql b/examples/basic/schema.graphql
diff --git a/examples/code-file/.eslintrc.json b/examples/code-file/.eslintrc.json
@@ -0,0 +1,17 @@
+{  
+  "processor": "@graphql-eslint/graphql",
+  "overrides": [
+    {
+      "files": ["*.graphql"],
+      "parser": "@graphql-eslint/eslint-plugin",
+      "parserOptions": {
+        "schema": "./**/schema.graphql"
+      },
+      "plugins": ["@graphql-eslint"],
+      "rules": {
+        "@graphql-eslint/no-anonymous-operations": "warn",
+        "@graphql-eslint/no-operation-name-suffix": "error"
+      }
+    }
+  ]
+}
diff --git a/examples/code-file/package.json b/examples/code-file/package.json
@@ -0,0 +1,17 @@
+{
+  "name": "@graphql-eslint/example-code-file",
+  "private": true,
+  "version": "0.0.1",
+  "repository": "https://github.com/dotansimha/graphql-eslint",
+  "author": "Dotan Simha <dotansimha@gmail.com>",
+  "license": "MIT",
+  "scripts": {
+    "lint": "eslint --ext graphql,js ."
+  },
+  "dependencies": {
+    "eslint": "7.14.0",
+    "@graphql-eslint/eslint-plugin": "0.4.4",
+    "graphql": "15.4.0",
+    "typescript": "4.1.2"
+  }
+}
diff --git a/examples/code-file/query.js b/examples/code-file/query.js
@@ -0,0 +1,7 @@
+const myQuery = gql`
+  query {
+    user {
+      name
+    }
+  }
+`;
diff --git a/examples/code-file/schema.graphql b/examples/code-file/schema.graphql
@@ -0,0 +1,8 @@
+type Query {
+  user: User!
+}
+
+type User {
+  id: ID!
+  name: String!
+}
diff --git a/examples/graphql-config/.eslintrc.json b/examples/graphql-config/.eslintrc.json
@@ -0,0 +1,17 @@
+{  
+  "overrides": [
+    {
+      "files": ["*.graphql"],
+      "parser": "@graphql-eslint/eslint-plugin",
+      "plugins": ["@graphql-eslint"],
+      "rules": {
+        "@graphql-eslint/require-id-when-available": [
+          "error",
+          {
+            "fieldName": "id"
+          }
+        ]
+      }
+    }
+  ]
+}
diff --git a/examples/graphql-config/.graphqlrc.yml b/examples/graphql-config/.graphqlrc.yml
@@ -0,0 +1,2 @@
+schema: schema.graphql
+documents: "operations/*.graphql"
diff --git a/examples/graphql-config/operations/query.graphql b/examples/graphql-config/operations/query.graphql
@@ -0,0 +1,6 @@
+query {
+  user {
+    name
+    ...UserFields
+  }
+}
diff --git a/examples/graphql-config/operations/user.fragment.graphql b/examples/graphql-config/operations/user.fragment.graphql
@@ -0,0 +1,4 @@
+fragment UserFields on User {
+  id
+  name
+}
diff --git a/examples/graphql-config/package.json b/examples/graphql-config/package.json
@@ -0,0 +1,18 @@
+{
+  "name": "@graphql-eslint/example-graphql-config",
+  "private": true,
+  "version": "0.0.1",
+  "repository": "https://github.com/dotansimha/graphql-eslint",
+  "author": "Dotan Simha <dotansimha@gmail.com>",
+  "license": "MIT",
+  "scripts": {
+    "lint": "eslint --ext graphql ."
+  },
+  "dependencies": {
+    "graphql-config": "3.2.0",
+    "eslint": "7.14.0",
+    "@graphql-eslint/eslint-plugin": "0.4.4",
+    "graphql": "15.4.0",
+    "typescript": "4.1.2"
+  }
+}
diff --git a/examples/graphql-config/schema.graphql b/examples/graphql-config/schema.graphql
@@ -0,0 +1,8 @@
+type Query {
+  user: User!
+}
+
+type User {
+  id: ID!
+  name: String!
+}
diff --git a/package.json b/package.json
@@ -5,9 +5,10 @@
   "license": "MIT",
   "workspaces": [
     "./packages/*",
-    "./example"
+    "./examples/*"
   ],
   "scripts": {
+    "postinstall": "patch-package",
     "lint": "eslint --config .eslintrc.json --ext .ts .",
     "prebuild": "rimraf packages/*/dist",
     "build": "tsc --project tsconfig.json && bob build",
@@ -19,6 +20,7 @@
     "prettier": "prettier --ignore-path .gitignore --write --list-different \"**/*.{ts,tsx,graphql,yml}\""
   },
   "devDependencies": {
+    "patch-package": "6.2.2",
     "@changesets/cli": "2.12.0",
     "@typescript-eslint/eslint-plugin": "4.9.0",
     "@typescript-eslint/parser": "4.9.0",
diff --git a/packages/plugin/src/processors/code-files.ts b/packages/plugin/src/processors/code-files.ts
@@ -1,8 +1,5 @@
-import { extname } from 'path';
 import { parseCode } from '@graphql-tools/graphql-tag-pluck';
-import {} from 'eslint';
 
-const EXTRACTABLE_FILES_EXTENSIONS = ['.js', '.jsx', '.ts', '.tsx'];
 const RELEVANT_KEYWORDS = ['gql', 'graphql', '/* GraphQL */'];
 
 type Block = {
@@ -22,12 +19,7 @@ export function createGraphqlProcessor() {
       const blocks: Block[] = [];
       blocksMap.set(filename, blocks);
 
-      if (
-        filename &&
-        text &&
-        EXTRACTABLE_FILES_EXTENSIONS.includes(extname(filename)) &&
-        RELEVANT_KEYWORDS.some(keyword => text.includes(keyword))
-      ) {
+      if (filename && text && RELEVANT_KEYWORDS.some(keyword => text.includes(keyword))) {
         const extractedDocuments = parseCode({
           code: text,
           filePath: filename,
diff --git a/packages/plugin/src/processors/index.ts b/packages/plugin/src/processors/index.ts
@@ -1,5 +1,6 @@
 import { createGraphqlProcessor } from './code-files';
 
-export const processors = {
-  graphql: createGraphqlProcessor(),
-};
+const EXTRACTABLE_FILES_EXTENSIONS = ['.js', '.jsx', '.ts', '.tsx', 'graphql'];
+const processor = createGraphqlProcessor();
+
+export const processors = EXTRACTABLE_FILES_EXTENSIONS.reduce((prev, ext) => ({ ...prev, [ext]: processor }), {});
diff --git a/packages/plugin/src/rules/require-id-when-available.ts b/packages/plugin/src/rules/require-id-when-available.ts
@@ -17,7 +17,7 @@ const rule: GraphQLESLintRule<RequireIdWhenAvailableRuleConfig, true> = {
       url: `https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/require-id-when-available.md`,
     },
     messages: {
-      [REQUIRE_ID_WHEN_AVAILABLE]: `Field "{{ fieldName }}" must be selected when it's available on a type. Please make sure to include it in your selection set!\nIf you are using fragments, make sure that all used fragments sepcifies the field "{{ fieldName }}".`,
+      [REQUIRE_ID_WHEN_AVAILABLE]: `Field "{{ fieldName }}" must be selected when it's available on a type. Please make sure to include it in your selection set!\nIf you are using fragments, make sure that all used fragments {{checkedFragments}} sepcifies the field "{{ fieldName }}".`,
     },
     schema: {
       type: 'array',
@@ -53,6 +53,7 @@ const rule: GraphQLESLintRule<RequireIdWhenAvailableRuleConfig, true> = {
           if (rawType instanceof GraphQLObjectType || rawType instanceof GraphQLInterfaceType) {
             const fields = rawType.getFields();
             const hasIdFieldInType = !!fields[fieldName];
+            const checkedFragmentSpreads: Set<string> = new Set();
 
             if (hasIdFieldInType) {
               let found = false;
@@ -68,6 +69,8 @@ const rule: GraphQLESLintRule<RequireIdWhenAvailableRuleConfig, true> = {
                   const foundSpread = siblings.getFragment(selection.name.value);
 
                   if (foundSpread[0]) {
+                    checkedFragmentSpreads.add(foundSpread[0].name.value);
+
                     found = !!(foundSpread[0].selectionSet?.selections || []).find(
                       s => s.kind === 'Field' && s.name.value === fieldName
                     );
@@ -93,6 +96,8 @@ const rule: GraphQLESLintRule<RequireIdWhenAvailableRuleConfig, true> = {
                   },
                   messageId: REQUIRE_ID_WHEN_AVAILABLE,
                   data: {
+                    checkedFragments:
+                      checkedFragmentSpreads.size === 0 ? '' : `(${Array.from(checkedFragmentSpreads).join(', ')})`,
                     fieldName,
                   },
                 });
diff --git a/packages/plugin/src/schema.ts b/packages/plugin/src/schema.ts
@@ -3,7 +3,7 @@ import { JsonFileLoader } from '@graphql-tools/json-file-loader';
 import { loadSchemaSync } from '@graphql-tools/load';
 import { UrlLoader } from '@graphql-tools/url-loader';
 import { buildSchema, GraphQLSchema } from 'graphql';
-import { GraphQLConfig, loadConfigSync } from 'graphql-config';
+import { GraphQLConfig } from 'graphql-config';
 import { dirname } from 'path';
 import { ParserOptions } from './types';
 
@@ -21,7 +21,7 @@ export function getSchema(options: ParserOptions, gqlConfig: GraphQLConfig): Gra
       schema = schemaCache.get(fileDir);
     } else {
       if (gqlConfig) {
-        const projectForFile = gqlConfig.getProject(options.filePath);
+        const projectForFile = gqlConfig.getProjectForFile(options.filePath);
 
         if (projectForFile) {
           schema = projectForFile.getSchemaSync();
diff --git a/packages/plugin/src/sibling-operations.ts b/packages/plugin/src/sibling-operations.ts
@@ -62,7 +62,7 @@ export function getSiblingOperations(options: ParserOptions, gqlConfig: GraphQLC
       siblings = operationsCache.get(fileDir);
     } else {
       if (gqlConfig) {
-        const projectForFile = gqlConfig.getProject(options.filePath);
+        const projectForFile = gqlConfig.getProjectForFile(options.filePath);
 
         if (projectForFile) {
           siblings = projectForFile.getDocumentsSync();
diff --git a/patches/@changesets+apply-release-plan+4.0.0.patch b/patches/@changesets+apply-release-plan+4.0.0.patch
@@ -0,0 +1,79 @@
+diff --git a/node_modules/@changesets/apply-release-plan/dist/apply-release-plan.cjs.dev.js b/node_modules/@changesets/apply-release-plan/dist/apply-release-plan.cjs.dev.js
+index 8ff4e32..a7ee2fb 100644
+--- a/node_modules/@changesets/apply-release-plan/dist/apply-release-plan.cjs.dev.js
++++ b/node_modules/@changesets/apply-release-plan/dist/apply-release-plan.cjs.dev.js
+@@ -62,7 +62,8 @@ function _defineProperty(obj, key, value) { if (key in obj) { Object.definePrope
+ const DEPENDENCY_TYPES = ["dependencies", "devDependencies", "peerDependencies", "optionalDependencies"];
+ function versionPackage(release, versionsToUpdate, {
+   updateInternalDependencies,
+-  onlyUpdatePeerDependentsWhenOutOfRange
++  onlyUpdatePeerDependentsWhenOutOfRange,
++  ignoreRange
+ }) {
+   let {
+     newVersion,
+@@ -102,7 +103,7 @@ function versionPackage(release, versionsToUpdate, {
+         // they probably want it to stay like that
+         new semver.Range(depCurrentVersion).range !== "") {
+           let rangeType = getVersionRangeType(depCurrentVersion);
+-          let newNewRange = `${rangeType}${version}`;
++          let newNewRange = ignoreRange ? version : `${rangeType}${version}`;
+           if (usesWorkspaceRange) newNewRange = `workspace:${newNewRange}`;
+           deps[name] = newNewRange;
+         }
+@@ -207,7 +208,7 @@ async function getCommitThatAddsChangeset(changesetId, cwd) {
+   }
+ }
+ 
+-async function applyReleasePlan(releasePlan, packages, config$1 = config.defaultConfig, snapshot) {
++async function applyReleasePlan(releasePlan, packages, config$1 = config.defaultConfig, snapshot, ignoreRange = false) {
+   let cwd = packages.root.dir;
+   let touchedFiles = [];
+   const packagesByName = new Map(packages.packages.map(x => [x.packageJson.name, x]));
+@@ -245,6 +246,7 @@ async function applyReleasePlan(releasePlan, packages, config$1 = config.default
+   let finalisedRelease = releaseWithChangelogs.map(release => {
+     return versionPackage(release, versionsToUpdate, {
+       updateInternalDependencies: config$1.updateInternalDependencies,
++      ignoreRange,
+       onlyUpdatePeerDependentsWhenOutOfRange: config$1.___experimentalUnsafeOptions_WILL_CHANGE_IN_PATCH.onlyUpdatePeerDependentsWhenOutOfRange
+     });
+   });
+diff --git a/node_modules/@changesets/apply-release-plan/dist/apply-release-plan.cjs.prod.js b/node_modules/@changesets/apply-release-plan/dist/apply-release-plan.cjs.prod.js
+index 772a26d..b1f5f4e 100644
+--- a/node_modules/@changesets/apply-release-plan/dist/apply-release-plan.cjs.prod.js
++++ b/node_modules/@changesets/apply-release-plan/dist/apply-release-plan.cjs.prod.js
+@@ -60,7 +60,7 @@ function _defineProperty(obj, key, value) {
+ 
+ const DEPENDENCY_TYPES = [ "dependencies", "devDependencies", "peerDependencies", "optionalDependencies" ];
+ 
+-function versionPackage(release, versionsToUpdate, {updateInternalDependencies: updateInternalDependencies, onlyUpdatePeerDependentsWhenOutOfRange: onlyUpdatePeerDependentsWhenOutOfRange}) {
++function versionPackage(release, versionsToUpdate, {ignoreRange, updateInternalDependencies: updateInternalDependencies, onlyUpdatePeerDependentsWhenOutOfRange: onlyUpdatePeerDependentsWhenOutOfRange}) {
+   let {newVersion: newVersion, packageJson: packageJson} = release;
+   packageJson.version = newVersion;
+   for (let depType of DEPENDENCY_TYPES) {
+@@ -79,7 +79,7 @@ function versionPackage(release, versionsToUpdate, {updateInternalDependencies:
+       })) continue;
+       const usesWorkspaceRange = depCurrentVersion.startsWith("workspace:");
+       if (usesWorkspaceRange && (depCurrentVersion = depCurrentVersion.substr(10)), "" !== new semver.Range(depCurrentVersion).range) {
+-        let newNewRange = `${getVersionRangeType(depCurrentVersion)}${version}`;
++        let newNewRange = ignoreRange ? version : `${getVersionRangeType(depCurrentVersion)}${version}`;
+         usesWorkspaceRange && (newNewRange = `workspace:${newNewRange}`), deps[name] = newNewRange;
+       }
+     }
+@@ -178,7 +178,7 @@ async function getCommitThatAddsChangeset(changesetId, cwd) {
+   return commitForOldChangeset || void 0;
+ }
+ 
+-async function applyReleasePlan(releasePlan, packages, config$1 = config.defaultConfig, snapshot) {
++async function applyReleasePlan(releasePlan, packages, config$1 = config.defaultConfig, snapshot, ignoreRange = false) {
+   let cwd = packages.root.dir, touchedFiles = [];
+   const packagesByName = new Map(packages.packages.map(x => [ x.packageJson.name, x ]));
+   let {releases: releases, changesets: changesets} = releasePlan;
+@@ -195,6 +195,7 @@ async function applyReleasePlan(releasePlan, packages, config$1 = config.default
+     type: type
+   })), finalisedRelease = releaseWithChangelogs.map(release => versionPackage(release, versionsToUpdate, {
+     updateInternalDependencies: config$1.updateInternalDependencies,
++    ignoreRange,
+     onlyUpdatePeerDependentsWhenOutOfRange: config$1.___experimentalUnsafeOptions_WILL_CHANGE_IN_PATCH.onlyUpdatePeerDependentsWhenOutOfRange
+   })), prettierConfig = await prettier.resolveConfig(cwd);
+   for (let release of finalisedRelease) {
diff --git a/patches/@changesets+cli+2.12.0.patch b/patches/@changesets+cli+2.12.0.patch
diff --git a/yarn.lock b/yarn.lock

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +'@graphql-eslint/eslint-plugin': patch
 +---
++
 +fix(parser): better support for graphql-config intergration and project detection
Original file line number	Diff line number	Diff line change
`@@ -1,10 +1,10 @@`
`1`	`1`	`{`
`2`		`- "processor": "@graphql-eslint/graphql",`
`3`	`2`	`"overrides": [`
`4`	`3`	`{`
`5`	`4`	`"files": ["*.graphql"],`
`6`	`5`	`"parser": "@graphql-eslint/eslint-plugin",`
`7`	`6`	`"parserOptions": {`
	`7`	`+ "operations": ["query.graphql"],`
`8`	`8`	`"schema": "./**/schema.graphql"`
`9`	`9`	`},`
`10`	`10`	`"plugins": ["@graphql-eslint"],`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		`- "name": "@graphql-eslint/example",`
	`2`	`+ "name": "@graphql-eslint/example-basic",`
`3`	`3`	`"private": true,`
`4`	`4`	`"version": "0.0.1",`
`5`	`5`	`"repository": "https://github.com/dotansimha/graphql-eslint",`