extend require-description lint with operation field definitions (#1303)

* require description for operation field definitions

* Update packages/plugin/tests/require-description.spec.ts

Co-authored-by: Victor Rojas <[email protected]>

* narrow query

* pr feedback

* format

* [require-description] add `rootField` option for only field definitions within `Query`, `Mutation`, and `Subscription` root types

Co-authored-by: Victor Rojas <[email protected]>
Co-authored-by: Dimitri POSTOLOV <[email protected]>

Author: 3 people

.changeset/good-baboons-bathe.md

@@ -0,0 +1,5 @@
+---
+'@graphql-eslint/eslint-plugin': minor
+---
+
+[require-description] add `rootField` option for only field definitions within `Query`, `Mutation`, and `Subscription` root types

docs/rules/require-description.md

@@ -50,6 +50,21 @@ mutation createUser {
 }
 ```
 
+### Correct
+
+```graphql
+# eslint @graphql-eslint/require-description: ['error', { rootField: true }]
+
+type Mutation {
+  "Create a new user"
+  createUser: User
+}
+
+type User {
+  name: String
+}
+```
+
 ## Config Schema
 
 The schema defines the following properties:
@@ -65,6 +80,10 @@ Includes:
 - `InputObjectTypeDefinition`
 - `UnionTypeDefinition`
 
+### `rootField` (boolean)
+
+Definitions within `Query`, `Mutation`, and `Subscription` root types
+
 ### `DirectiveDefinition` (boolean)
 
 Read more about this kind on

packages/plugin/src/rules/alphabetize.ts

@@ -57,7 +57,7 @@ export type AlphabetizeConfig = {
   definitions?: boolean;
 };
 
-const rule: GraphQLESLintRule<[AlphabetizeConfig]> = {
+export const rule: GraphQLESLintRule<[AlphabetizeConfig]> = {
   meta: {
     type: 'suggestion',
     fixable: 'code',
@@ -402,5 +402,3 @@ const rule: GraphQLESLintRule<[AlphabetizeConfig]> = {
     return listeners;
   },
 };
-
-export default rule;

packages/plugin/src/rules/description-style.ts

@@ -4,7 +4,7 @@ import { GraphQLESTreeNode } from '../estree-converter';
 
 type DescriptionStyleRuleConfig = { style: 'inline' | 'block' };
 
-const rule: GraphQLESLintRule<[DescriptionStyleRuleConfig]> = {
+export const rule: GraphQLESLintRule<[DescriptionStyleRuleConfig]> = {
   meta: {
     type: 'suggestion',
     hasSuggestions: true,
@@ -77,5 +77,3 @@ const rule: GraphQLESLintRule<[DescriptionStyleRuleConfig]> = {
     };
   },
 };
-
-export default rule;

packages/plugin/src/rules/graphql-js-validation.ts

@@ -186,7 +186,7 @@ const validationToRule = (
           ...docs,
           graphQLJSRuleName: ruleName,
           url: `https://github.com/B2o5T/graphql-eslint/blob/master/docs/rules/${ruleId}.md`,
-          description: `${docs.description}\n\n> This rule is a wrapper around a \`graphql-js\` validation function.`,
+          description: `${docs.description}\n> This rule is a wrapper around a \`graphql-js\` validation function.`,
         },
         schema,
         hasSuggestions: hasDidYouMeanSuggestions,

packages/plugin/src/rules/index.ts

@@ -3,34 +3,34 @@
  */
 
 import { GRAPHQL_JS_VALIDATIONS } from './graphql-js-validation';
-import alphabetize from './alphabetize';
-import descriptionStyle from './description-style';
-import inputName from './input-name';
-import matchDocumentFilename from './match-document-filename';
-import namingConvention from './naming-convention';
-import noAnonymousOperations from './no-anonymous-operations';
-import noCaseInsensitiveEnumValuesDuplicates from './no-case-insensitive-enum-values-duplicates';
-import noDeprecated from './no-deprecated';
-import noDuplicateFields from './no-duplicate-fields';
-import noHashtagDescription from './no-hashtag-description';
-import noRootType from './no-root-type';
-import noScalarResultTypeOnMutation from './no-scalar-result-type-on-mutation';
-import noTypenamePrefix from './no-typename-prefix';
-import noUnreachableTypes from './no-unreachable-types';
-import noUnusedFields from './no-unused-fields';
-import relayArguments from './relay-arguments';
-import relayConnectionTypes from './relay-connection-types';
-import relayEdgeTypes from './relay-edge-types';
-import relayPageInfo from './relay-page-info';
-import requireDeprecationDate from './require-deprecation-date';
-import requireDeprecationReason from './require-deprecation-reason';
-import requireDescription from './require-description';
-import requireFieldOfTypeQueryInMutationResult from './require-field-of-type-query-in-mutation-result';
-import requireIdWhenAvailable from './require-id-when-available';
-import selectionSetDepth from './selection-set-depth';
-import strictIdInTypes from './strict-id-in-types';
-import uniqueFragmentName from './unique-fragment-name';
-import uniqueOperationName from './unique-operation-name';
+import { rule as alphabetize } from './alphabetize';
+import { rule as descriptionStyle } from './description-style';
+import { rule as inputName } from './input-name';
+import { rule as matchDocumentFilename } from './match-document-filename';
+import { rule as namingConvention } from './naming-convention';
+import { rule as noAnonymousOperations } from './no-anonymous-operations';
+import { rule as noCaseInsensitiveEnumValuesDuplicates } from './no-case-insensitive-enum-values-duplicates';
+import { rule as noDeprecated } from './no-deprecated';
+import { rule as noDuplicateFields } from './no-duplicate-fields';
+import { rule as noHashtagDescription } from './no-hashtag-description';
+import { rule as noRootType } from './no-root-type';
+import { rule as noScalarResultTypeOnMutation } from './no-scalar-result-type-on-mutation';
+import { rule as noTypenamePrefix } from './no-typename-prefix';
+import { rule as noUnreachableTypes } from './no-unreachable-types';
+import { rule as noUnusedFields } from './no-unused-fields';
+import { rule as relayArguments } from './relay-arguments';
+import { rule as relayConnectionTypes } from './relay-connection-types';
+import { rule as relayEdgeTypes } from './relay-edge-types';
+import { rule as relayPageInfo } from './relay-page-info';
+import { rule as requireDeprecationDate } from './require-deprecation-date';
+import { rule as requireDeprecationReason } from './require-deprecation-reason';
+import { rule as requireDescription } from './require-description';
+import { rule as requireFieldOfTypeQueryInMutationResult } from './require-field-of-type-query-in-mutation-result';
+import { rule as requireIdWhenAvailable } from './require-id-when-available';
+import { rule as selectionSetDepth } from './selection-set-depth';
+import { rule as strictIdInTypes } from './strict-id-in-types';
+import { rule as uniqueFragmentName } from './unique-fragment-name';
+import { rule as uniqueOperationName } from './unique-operation-name';
 
 export const rules = {
   ...GRAPHQL_JS_VALIDATIONS,

packages/plugin/src/rules/input-name.ts

@@ -25,7 +25,7 @@ const isQueryType = (node: ObjectTypeNode): boolean =>
 const isMutationType = (node: ObjectTypeNode): boolean =>
   isObjectType(node) && node.name.value === 'Mutation';
 
-const rule: GraphQLESLintRule<[InputNameRuleConfig]> = {
+export const rule: GraphQLESLintRule<[InputNameRuleConfig]> = {
   meta: {
     type: 'suggestion',
     hasSuggestions: true,
@@ -164,5 +164,3 @@ const rule: GraphQLESLintRule<[InputNameRuleConfig]> = {
     return listeners;
   },
 };
-
-export default rule;

packages/plugin/src/rules/match-document-filename.ts

@@ -37,7 +37,7 @@ const schemaOption = {
   oneOf: [{ $ref: '#/definitions/asString' }, { $ref: '#/definitions/asObject' }],
 };
 
-const rule: GraphQLESLintRule<[MatchDocumentFilenameRuleConfig]> = {
+export const rule: GraphQLESLintRule<[MatchDocumentFilenameRuleConfig]> = {
   meta: {
     type: 'suggestion',
     docs: {
@@ -244,5 +244,3 @@ const rule: GraphQLESLintRule<[MatchDocumentFilenameRuleConfig]> = {
     };
   },
 };
-
-export default rule;

packages/plugin/src/rules/naming-convention.ts

@@ -62,7 +62,7 @@ export type NamingConventionRuleConfig = {
 
 type AllowedKindToNode = Pick<ASTKindToNode, AllowedKind>;
 
-const rule: GraphQLESLintRule<[NamingConventionRuleConfig]> = {
+export const rule: GraphQLESLintRule<[NamingConventionRuleConfig]> = {
   meta: {
     type: 'suggestion',
     docs: {
@@ -208,7 +208,7 @@ const rule: GraphQLESLintRule<[NamingConventionRuleConfig]> = {
         properties: {
           types: {
             ...schemaOption,
-            description: `Includes:\n\n${TYPES_KINDS.map(kind => `- \`${kind}\``).join('\n')}`,
+            description: `Includes:\n${TYPES_KINDS.map(kind => `- \`${kind}\``).join('\n')}`,
           },
           ...Object.fromEntries(
             ALLOWED_KINDS.map(kind => [
@@ -365,5 +365,3 @@ const rule: GraphQLESLintRule<[NamingConventionRuleConfig]> = {
     return listeners;
   },
 };
-
-export default rule;

packages/plugin/src/rules/no-anonymous-operations.ts

@@ -5,7 +5,7 @@ import { GraphQLESTreeNode } from '../estree-converter';
 
 const RULE_ID = 'no-anonymous-operations';
 
-const rule: GraphQLESLintRule = {
+export const rule: GraphQLESLintRule = {
   meta: {
     type: 'suggestion',
     hasSuggestions: true,
@@ -75,5 +75,3 @@ const rule: GraphQLESLintRule = {
     };
   },
 };
-
-export default rule;