@graphql-eslint/eslint-plugin 3.0.0-alpha-2918431.0 → 3.0.0-alpha-4613dfe.0

package/README.md

@@ -187,7 +187,7 @@ You can find a complete list of [all available rules here](docs/README.md).
 |:-:|-|
 |[`schema-recommended`](packages/plugin/src/configs/schema-recommended.ts)|enables all recommended rules|
 |[`operations-recommended`](packages/plugin/src/configs/operations-recommended.ts) |enables all recommended rules|
-|[`schema-all`](packages/plugin/src/configs/schema-all.ts)|enables all rules (except for the rules that require `parserOptions.operations` option)|
+|[`schema-all`](packages/plugin/src/configs/schema-all.ts)|enables all rules, except for those that require `parserOptions.operations` option)|
 |[`operations-all`](packages/plugin/src/configs/operations-all.ts)|enables all rules|
 <!-- prettier-ignore-end -->
 

package/configs/index.d.ts

@@ -35,6 +35,10 @@ export declare const configs: {
             '@graphql-eslint/possible-type-extension': string;
             '@graphql-eslint/provided-required-arguments': string;
             '@graphql-eslint/require-deprecation-reason': string;
+            '@graphql-eslint/require-description': (string | {
+                types: boolean;
+                DirectiveDefinition: boolean;
+            })[];
             '@graphql-eslint/strict-id-in-types': string;
             '@graphql-eslint/unique-directive-names': string;
             '@graphql-eslint/unique-directive-names-per-location': string;
@@ -57,10 +61,6 @@ export declare const configs: {
             '@graphql-eslint/no-scalar-result-type-on-mutation': string;
             '@graphql-eslint/no-unused-fields': string;
             '@graphql-eslint/require-deprecation-date': string;
-            '@graphql-eslint/require-description': (string | {
-                types: boolean;
-                DirectiveDefinition: boolean;
-            })[];
             '@graphql-eslint/require-field-of-type-query-in-mutation-result': string;
         };
     };

package/configs/schema-all.d.ts

@@ -11,10 +11,6 @@ declare const _default: {
         '@graphql-eslint/no-scalar-result-type-on-mutation': string;
         '@graphql-eslint/no-unused-fields': string;
         '@graphql-eslint/require-deprecation-date': string;
-        '@graphql-eslint/require-description': (string | {
-            types: boolean;
-            DirectiveDefinition: boolean;
-        })[];
         '@graphql-eslint/require-field-of-type-query-in-mutation-result': string;
     };
 };

package/configs/schema-recommended.d.ts

@@ -30,6 +30,10 @@ declare const _default: {
         '@graphql-eslint/possible-type-extension': string;
         '@graphql-eslint/provided-required-arguments': string;
         '@graphql-eslint/require-deprecation-reason': string;
+        '@graphql-eslint/require-description': (string | {
+            types: boolean;
+            DirectiveDefinition: boolean;
+        })[];
         '@graphql-eslint/strict-id-in-types': string;
         '@graphql-eslint/unique-directive-names': string;
         '@graphql-eslint/unique-directive-names-per-location': string;

package/docs/README.md

@@ -46,7 +46,7 @@ Name            &nbs
 [provided-required-arguments](rules/provided-required-arguments.md)|A field or directive is only valid if all required (non-null without a default value) field arguments have been provided.|🔮||✅
 [require-deprecation-date](rules/require-deprecation-date.md)|Require deletion date on `@deprecated` directive. Suggest removing deprecated things after deprecated date.|🚀||
 [require-deprecation-reason](rules/require-deprecation-reason.md)|Require all deprecation directives to specify a reason.|🚀||✅
-[require-description](rules/require-description.md)|Enforce descriptions in your type definitions.|🚀||
+[require-description](rules/require-description.md)|Enforce descriptions in your type definitions.|🚀||✅
 [require-field-of-type-query-in-mutation-result](rules/require-field-of-type-query-in-mutation-result.md)|Allow the client in one round-trip not only to call mutation but also to get a wagon of data to update their application.|🚀||
 [require-id-when-available](rules/require-id-when-available.md)|Enforce selecting specific fields when they are available on the GraphQL type.|🚀||✅
 [scalar-leafs](rules/scalar-leafs.md)|A GraphQL document is valid only if all leaf fields (fields without sub selections) are of scalar or enum types.|🔮||✅

package/docs/rules/naming-convention.md

@@ -21,6 +21,26 @@ type user {
 }
 ```
 
+### Incorrect
+
+```graphql
+# eslint @graphql-eslint/naming-convention: ['error', { FragmentDefinition: { style: 'PascalCase', forbiddenSuffixes: ['Fragment'] } }]
+
+fragment UserFragment on User {
+  # ...
+}
+```
+
+### Incorrect
+
+```graphql
+# eslint @graphql-eslint/naming-convention: ['error', { 'FieldDefinition[parent.name.value=Query]': { forbiddenPrefixes: ['get'] } }]
+
+type Query {
+  getUsers: [User!]!
+}
+```
+
 ### Correct
 
 ```graphql
@@ -31,6 +51,26 @@ type User {
 }
 ```
 
+### Correct
+
+```graphql
+# eslint @graphql-eslint/naming-convention: ['error', { FragmentDefinition: { style: 'PascalCase', forbiddenSuffixes: ['Fragment'] } }]
+
+fragment UserFields on User {
+  # ...
+}
+```
+
+### Correct
+
+```graphql
+# eslint @graphql-eslint/naming-convention: ['error', { 'FieldDefinition[parent.name.value=Query]': { forbiddenPrefixes: ['get'] } }]
+
+type Query {
+  users: [User!]!
+}
+```
+
 ## Config Schema
 
 > It's possible to use a [`selector`](https://eslint.org/docs/developer-guide/selectors) that starts with allowed `ASTNode` names which are described below.
@@ -41,14 +81,6 @@ type User {
 
 The schema defines the following properties:
 
-### `allowLeadingUnderscore` (boolean)
-
-Default: `false`
-
-### `allowTrailingUnderscore` (boolean)
-
-Default: `false`
-
 ### `types`
 
 Includes:
@@ -205,6 +237,14 @@ The object must be one of the following types:
 * `asString`
 * `asObject`
 
+### `allowLeadingUnderscore` (boolean)
+
+Default: `false`
+
+### `allowTrailingUnderscore` (boolean)
+
+Default: `false`
+
 ---
 
 # Sub Schemas

package/docs/rules/require-description.md

@@ -1,5 +1,7 @@
 # `require-description`
 
+✅ The `"extends": "plugin:@graphql-eslint/schema-recommended"` property in a configuration file enables this rule.
+
 - Category: `Schema`
 - Rule name: `@graphql-eslint/require-description`
 - Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)

package/index.js

@@ -61,6 +61,7 @@ const schemaRecommendedConfig = {
         '@graphql-eslint/possible-type-extension': 'error',
         '@graphql-eslint/provided-required-arguments': 'error',
         '@graphql-eslint/require-deprecation-reason': 'error',
+        '@graphql-eslint/require-description': ['error', { types: true, DirectiveDefinition: true }],
         '@graphql-eslint/strict-id-in-types': 'error',
         '@graphql-eslint/unique-directive-names': 'error',
         '@graphql-eslint/unique-directive-names-per-location': 'error',
@@ -90,7 +91,6 @@ const schemaAllConfig = {
         '@graphql-eslint/no-scalar-result-type-on-mutation': 'error',
         '@graphql-eslint/no-unused-fields': 'off',
         '@graphql-eslint/require-deprecation-date': 'error',
-        '@graphql-eslint/require-description': ['error', { types: true, DirectiveDefinition: true }],
         '@graphql-eslint/require-field-of-type-query-in-mutation-result': 'error',
     },
 };
@@ -1295,6 +1295,24 @@ const rule$4 = {
             type user {
               first_name: String!
             }
+          `,
+                },
+                {
+                    title: 'Incorrect',
+                    usage: [{ FragmentDefinition: { style: 'PascalCase', forbiddenSuffixes: ['Fragment'] } }],
+                    code: /* GraphQL */ `
+            fragment UserFragment on User {
+              # ...
+            }
+          `,
+                },
+                {
+                    title: 'Incorrect',
+                    usage: [{ 'FieldDefinition[parent.name.value=Query]': { forbiddenPrefixes: ['get'] } }],
+                    code: /* GraphQL */ `
+            type Query {
+              getUsers: [User!]!
+            }
           `,
                 },
                 {
@@ -1304,6 +1322,24 @@ const rule$4 = {
             type User {
               firstName: String
             }
+          `,
+                },
+                {
+                    title: 'Correct',
+                    usage: [{ FragmentDefinition: { style: 'PascalCase', forbiddenSuffixes: ['Fragment'] } }],
+                    code: /* GraphQL */ `
+            fragment UserFields on User {
+              # ...
+            }
+          `,
+                },
+                {
+                    title: 'Correct',
+                    usage: [{ 'FieldDefinition[parent.name.value=Query]': { forbiddenPrefixes: ['get'] } }],
+                    code: /* GraphQL */ `
+            type Query {
+              users: [User!]!
+            }
           `,
                 },
             ],
@@ -1379,14 +1415,6 @@ const rule$4 = {
                 type: 'object',
                 additionalProperties: false,
                 properties: {
-                    allowLeadingUnderscore: {
-                        type: 'boolean',
-                        default: false,
-                    },
-                    allowTrailingUnderscore: {
-                        type: 'boolean',
-                        default: false,
-                    },
                     types: {
                         ...schemaOption$1,
                         description: `Includes:\n\n${TYPES_KINDS.map(kind => `- \`${kind}\``).join('\n')}`,
@@ -1402,6 +1430,14 @@ const rule$4 = {
                             description: `Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#${kind}).`,
                         },
                     ])),
+                    allowLeadingUnderscore: {
+                        type: 'boolean',
+                        default: false,
+                    },
+                    allowTrailingUnderscore: {
+                        type: 'boolean',
+                        default: false,
+                    },
                 },
                 patternProperties: {
                     [`^(${ALLOWED_KINDS.join('|')})(.+)?$`]: schemaOption$1,
@@ -2554,6 +2590,7 @@ const rule$h = {
                     [graphql.Kind.DIRECTIVE_DEFINITION]: true,
                 },
             ],
+            recommended: true,
         },
         type: 'suggestion',
         messages: {

package/index.mjs

@@ -55,6 +55,7 @@ const schemaRecommendedConfig = {
         '@graphql-eslint/possible-type-extension': 'error',
         '@graphql-eslint/provided-required-arguments': 'error',
         '@graphql-eslint/require-deprecation-reason': 'error',
+        '@graphql-eslint/require-description': ['error', { types: true, DirectiveDefinition: true }],
         '@graphql-eslint/strict-id-in-types': 'error',
         '@graphql-eslint/unique-directive-names': 'error',
         '@graphql-eslint/unique-directive-names-per-location': 'error',
@@ -84,7 +85,6 @@ const schemaAllConfig = {
         '@graphql-eslint/no-scalar-result-type-on-mutation': 'error',
         '@graphql-eslint/no-unused-fields': 'off',
         '@graphql-eslint/require-deprecation-date': 'error',
-        '@graphql-eslint/require-description': ['error', { types: true, DirectiveDefinition: true }],
         '@graphql-eslint/require-field-of-type-query-in-mutation-result': 'error',
     },
 };
@@ -1289,6 +1289,24 @@ const rule$4 = {
             type user {
               first_name: String!
             }
+          `,
+                },
+                {
+                    title: 'Incorrect',
+                    usage: [{ FragmentDefinition: { style: 'PascalCase', forbiddenSuffixes: ['Fragment'] } }],
+                    code: /* GraphQL */ `
+            fragment UserFragment on User {
+              # ...
+            }
+          `,
+                },
+                {
+                    title: 'Incorrect',
+                    usage: [{ 'FieldDefinition[parent.name.value=Query]': { forbiddenPrefixes: ['get'] } }],
+                    code: /* GraphQL */ `
+            type Query {
+              getUsers: [User!]!
+            }
           `,
                 },
                 {
@@ -1298,6 +1316,24 @@ const rule$4 = {
             type User {
               firstName: String
             }
+          `,
+                },
+                {
+                    title: 'Correct',
+                    usage: [{ FragmentDefinition: { style: 'PascalCase', forbiddenSuffixes: ['Fragment'] } }],
+                    code: /* GraphQL */ `
+            fragment UserFields on User {
+              # ...
+            }
+          `,
+                },
+                {
+                    title: 'Correct',
+                    usage: [{ 'FieldDefinition[parent.name.value=Query]': { forbiddenPrefixes: ['get'] } }],
+                    code: /* GraphQL */ `
+            type Query {
+              users: [User!]!
+            }
           `,
                 },
             ],
@@ -1373,14 +1409,6 @@ const rule$4 = {
                 type: 'object',
                 additionalProperties: false,
                 properties: {
-                    allowLeadingUnderscore: {
-                        type: 'boolean',
-                        default: false,
-                    },
-                    allowTrailingUnderscore: {
-                        type: 'boolean',
-                        default: false,
-                    },
                     types: {
                         ...schemaOption$1,
                         description: `Includes:\n\n${TYPES_KINDS.map(kind => `- \`${kind}\``).join('\n')}`,
@@ -1396,6 +1424,14 @@ const rule$4 = {
                             description: `Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#${kind}).`,
                         },
                     ])),
+                    allowLeadingUnderscore: {
+                        type: 'boolean',
+                        default: false,
+                    },
+                    allowTrailingUnderscore: {
+                        type: 'boolean',
+                        default: false,
+                    },
                 },
                 patternProperties: {
                     [`^(${ALLOWED_KINDS.join('|')})(.+)?$`]: schemaOption$1,
@@ -2548,6 +2584,7 @@ const rule$h = {
                     [Kind.DIRECTIVE_DEFINITION]: true,
                 },
             ],
+            recommended: true,
         },
         type: 'suggestion',
         messages: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-eslint/eslint-plugin",
-  "version": "3.0.0-alpha-2918431.0",
+  "version": "3.0.0-alpha-4613dfe.0",
   "sideEffects": false,
   "peerDependencies": {
     "graphql": "^0.8.0 || ^0.9.0 || ^0.10.0 || ^0.11.0 || ^0.12.0 || ^0.13.0 || ^14.0.0 || ^15.0.0 || ^16.0.0"