fix: compare siblings with real filepath instead of virtual in unique-fragment-name and unique-operation-name (#527)

Author: Dimitri POSTOLOV

.changeset/hot-items-fry.md

@@ -0,0 +1,5 @@
+---
+'@graphql-eslint/eslint-plugin': patch
+---
+
+fix: code filepath in unique-fragment-name and unique-operation-name rules

docs/README.md

@@ -55,4 +55,29 @@ query {
     ...UserFields
   }
 }
+```
+
+### False positive case
+
+For extracting documents from code under the hood we use [graphql-tag-pluck](https://graphql-tools.com/docs/graphql-tag-pluck) that [don't support string interpolation](https://stackoverflow.com/questions/62749847/graphql-codegen-dynamic-fields-with-interpolation/62751311#62751311) for this moment.
+
+```js
+const USER_FIELDS = gql`
+  fragment UserFields on User {
+    id
+  }
+`
+
+const GET_USER = /* GraphQL */ `
+  # eslint @graphql-eslint/known-fragment-names: 'error'
+
+  query User {
+    user {
+      ...UserFields
+    }
+  }
+
+  # Will give false positive error 'Unknown fragment "UserFields"'
+  ${USER_FIELDS}
+`
 ```

docs/rules/known-fragment-names.md

@@ -5,7 +5,7 @@
 - Requires GraphQL Schema: `true` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
 - Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
 
-This rule allow you to enforce that deprecated fields or enum values are not in use by operations.
+Enforce that deprecated fields or enum values are not in use by operations.
 
 ## Usage Examples
 

docs/rules/no-deprecated.md

@@ -6,7 +6,7 @@
 - Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
 
 Requires to use `"""` or `"` for adding a GraphQL description instead of `#`.
-This rule allows you to use hashtag for comments, as long as it's not attached to a AST definition.
+Allows to use hashtag for comments, as long as it's not attached to an AST definition.
 
 ## Usage Examples
 

docs/rules/no-hashtag-description.md

@@ -5,7 +5,7 @@
 - Requires GraphQL Schema: `true` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
 - Requires GraphQL Operations: `true` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
 
-This rule allow you to enforce selecting specific fields when they are available on the GraphQL type.
+Enforce selecting specific fields when they are available on the GraphQL type.
 
 ## Usage Examples
 

docs/rules/require-id-when-available.md

@@ -5,7 +5,7 @@
 - Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
 - Requires GraphQL Operations: `true` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
 
-This rule allow you to enforce unique fragment name across your application.
+Enforce unique fragment names across your project.
 
 ## Usage Examples
 

docs/rules/unique-fragment-name.md

@@ -5,7 +5,7 @@
 - Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
 - Requires GraphQL Operations: `true` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
 
-This rule allow you to enforce unique operation names across your project.
+Enforce unique operation names across your project.
 
 ## Usage Examples
 

docs/rules/unique-operation-name.md

@@ -70,7 +70,7 @@ export function convertRange(gqlLocation: Location): [number, number] {
 }
 
 export function extractCommentsFromAst(node: ASTNode): Comment[] {
-  const loc = node.loc;
+  const { loc } = node;
 
   if (!loc) {
     return [];
@@ -81,19 +81,13 @@ export function extractCommentsFromAst(node: ASTNode): Comment[] {
 
   while (token !== null) {
     if (token.kind === TokenKind.COMMENT) {
-      const value = String(token.value);
+      const { line, column } = token;
       comments.push({
         type: 'Block',
-        value: ' ' + value + ' ',
+        value: ` ${token.value} `,
         loc: {
-          start: {
-            line: token.line,
-            column: token.column,
-          },
-          end: {
-            line: token.line,
-            column: token.column,
-          },
+          start: { line, column },
+          end: { line, column },
         },
         range: [token.start, token.end],
       });
@@ -122,7 +116,7 @@ export function convertLocation(gqlLocation: Location): SourceLocation {
 export function isNodeWithDescription<T extends ASTNode>(
   obj: T
 ): obj is T & { readonly description?: StringValueNode } {
-  return obj && (obj as any).description;
+  return (obj as any)?.description;
 }
 
 export function convertDescription<T extends ASTNode>(node: T): Comment[] {

packages/plugin/src/estree-parser/utils.ts

@@ -1,7 +1,6 @@
 export { rules } from './rules';
 export { processors } from './processors';
 export * from './parser';
-export * from './utils';
 export * from './types';
 export * from './estree-parser';
 export * from './testkit';