@graphql-eslint/eslint-plugin 3.2.0-alpha-6aa2721.0 → 3.2.0

package/docs/rules/known-fragment-names.md

@@ -5,7 +5,7 @@
 - Category: `Operations`
 - Rule name: `@graphql-eslint/known-fragment-names`
 - Requires GraphQL Schema: `true` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
-- Requires GraphQL Operations: `true` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
+- Requires GraphQL Operations: `false` [ℹ️](../../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.
 
@@ -13,7 +13,7 @@ A GraphQL document is only valid if all `...Fragment` fragment spreads refer to
 
 ## Usage Examples
 
-### Incorrect
+### Incorrect (fragment not defined in the document)
 
 ```graphql
 # eslint @graphql-eslint/known-fragment-names: 'error'
@@ -21,7 +21,7 @@ A GraphQL document is only valid if all `...Fragment` fragment spreads refer to
 query {
   user {
     id
-    ...UserFields # fragment not defined in the document
+    ...UserFields
   }
 }
 ```
@@ -44,23 +44,44 @@ query {
 }
 ```
 
-### Correct (`UserFields` fragment located in a separate file)
+### Correct (existing import to UserFields fragment)
 
 ```graphql
 # eslint @graphql-eslint/known-fragment-names: 'error'
 
-# user.gql
+#import '../UserFields.gql'
+
 query {
   user {
     id
     ...UserFields
   }
 }
+```
 
-# user-fields.gql
-fragment UserFields on User {
-  id
-}
+### 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}
+`
 ```
 
 ## Resources

package/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: `true` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
+- Requires GraphQL Operations: `false` [ℹ️](../../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.
 

package/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: `true` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
+- Requires GraphQL Operations: `false` [ℹ️](../../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.
 

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

@@ -54,10 +54,25 @@ query user {
 
 The schema defines the following properties:
 
-### `fieldName` (string)
+### `fieldName`
+
+The object must be one of the following types:
+
+* `asString`
+* `asArray`
 
 Default: `"id"`
 
+---
+
+# Sub Schemas
+
+The schema defines the following additional types:
+
+## `asString` (string)
+
+## `asArray` (array)
+
 ## Resources
 
 - [Rule source](../../packages/plugin/src/rules/require-id-when-available.ts)