feat: remove the need of #import comments in favor of parserOptions.operations (#832)

* feat: remove the need of `#import` comments in favor of `parserOptions.operations`

refactor `no-undefined-variables` and `no-unused-variables` rules

refactor `known-fragment-names`

refactor `no-unused-fragments`

add changeset

fix false positive `Unknown fragment` error

fix: should not throw an error on undefined fragment

* update snapshot with fixed `graphql-js` report location

Author: dimaMachina

.changeset/old-jeans-push.md

@@ -0,0 +1,5 @@
+---
+'@graphql-eslint/eslint-plugin': minor
+---
+
+feat: remove the need of `#import` comments in favor of `parserOptions.operations`

docs/rules/known-fragment-names.md

@@ -5,23 +5,23 @@
 - Category: `Operations`
 - Rule name: `@graphql-eslint/known-fragment-names`
 - Requires GraphQL Schema: `true` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
-- Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
+- Requires GraphQL Operations: `true` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
 
 A GraphQL document is only valid if all `...Fragment` fragment spreads refer to fragments defined in the same document.
 
 > This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/KnownFragmentNamesRule.ts).
 
 ## Usage Examples
 
-### Incorrect (fragment not defined in the document)
+### Incorrect
 
 ```graphql
 # eslint @graphql-eslint/known-fragment-names: 'error'
 
 query {
   user {
     id
-    ...UserFields
+    ...UserFields # fragment not defined in the document
   }
 }
 ```
@@ -44,44 +44,23 @@ query {
 }
 ```
 
-### Correct (existing import to UserFields fragment)
+### Correct (`UserFields` fragment located in a separate file)
 
 ```graphql
 # eslint @graphql-eslint/known-fragment-names: 'error'
 
-#import '../UserFields.gql'
-
+# user.gql
 query {
   user {
     id
     ...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}
-`
+# user-fields.gql
+fragment UserFields on User {
+  id
+}
 ```
 
 ## Resources

docs/rules/no-undefined-variables.md

@@ -5,7 +5,7 @@
 - Category: `Operations`
 - Rule name: `@graphql-eslint/no-undefined-variables`
 - Requires GraphQL Schema: `true` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
-- Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
+- Requires GraphQL Operations: `true` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
 
 A GraphQL operation is only valid if all variables encountered, both directly and via fragment spreads, are defined by that operation.
 

docs/rules/no-unused-variables.md

@@ -5,7 +5,7 @@
 - Category: `Operations`
 - Rule name: `@graphql-eslint/no-unused-variables`
 - Requires GraphQL Schema: `true` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
-- Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
+- Requires GraphQL Operations: `true` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
 
 A GraphQL operation is only valid if all variables defined by an operation are used, either directly or within a spread fragment.
 

packages/plugin/package.json

@@ -4,6 +4,13 @@
   "repository": "https://github.com/dotansimha/graphql-eslint",
   "author": "Dotan Simha <[email protected]>",
   "license": "MIT",
+  "description": "GraphQL plugin for ESLint",
+  "keywords": [
+    "eslint",
+    "eslintplugin",
+    "eslint-plugin",
+    "graphql"
+  ],
   "sideEffects": false,
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -30,7 +37,6 @@
     "@babel/code-frame": "7.16.0",
     "@graphql-tools/code-file-loader": "7.2.3",
     "@graphql-tools/graphql-tag-pluck": "7.1.4",
-    "@graphql-tools/import": "6.6.2",
     "@graphql-tools/utils": "8.5.4",
     "graphql-config": "4.1.0",
     "graphql-depth-limit": "1.1.0",