extend require-description lint with operation field definitions

[tshedor]

Description

This change extends the require-description lint to require a description of operations.

# Correct
type Query {
  "Fetch users"
  users: [User!]!
}

# Incorrect
type Mutation {
  createUser(user: UserInput!): User!
}

The field definition within the operation types is tricky to target. A description isn't required for every Kind.FIELD_DEFINITION so the existing feature would've involved excessive documentation. Since good code health could require documentation of usable operations, the lint was extended to target field definitions only within the scope of Mutation, Query, and Subscription.

This adds the boolean option operationFieldDefinition to require-description (default false).

Type of change

Please delete options that are not relevant.

• New feature (non-breaking change which adds functionality)
• This change requires a documentation update

How Has This Been Tested?

I added two valid unit tests and two invalid unit tests. They cover when an input is present and when an input is not present.

Both unit tests are within the require-description.spec.ts file

Test Environment:

• OS: Mac OS Monterrey
• @graphql-eslint/...: master?
• NodeJS: 18.3.0

Checklist:

• I have followed the
  CONTRIBUTING doc and the
  style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings (They add a new ESLint warning that's configurable and default disabled)
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests and linter rules pass locally with my changes
• Any dependent changes have been merged and published in downstream modules (N/A)

[changeset-bot]

🦋 Changeset detected

Latest commit: 379ace3

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@graphql-eslint/eslint-plugin	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[Josiassejod1]

Thanks for doing this

[dimaMachina]

Thanks for working on it! I definitely see the benefit of the new option, and will review it soon!

[dimaMachina]

this will not work for root types that are named differently.
example:

type MyQuery {
  user: User
}

schema {
  query: MyQuery
}

[dimaMachina]

example of fixing https://github.com/B2o5T/graphql-eslint/blob/3e8f71f7ef60dd6e8d5a4605e7ca0bdd2cec2f86/packages/plugin/src/rules/no-root-type.ts#L76

[tshedor]

These have been added, but they're hardcoded to avoid requiring the schema for the whole rule. If you'd rather these not be hardcoded and to match no-root-type's dynamic fetching of the names, I'd be happy to convert this rule so that the schema is exposed to it.

[dimaMachina]

Suggested change

	{
	code: 'type Query { users: [User!]! }',
	options: [{ operationFieldDefinition: true }],
	errors: [{ message: 'Description is required for `Query.users`.' }],
	},

one test for Query is enough, instead include 1 test with a root type that is named differently than Query/Mutation or Subscription

[tshedor]

@B2o5T I added a test case for a root type with a field as a Correct case. Is this what you had in mind? If I misread you I'd be happy to try again

[dimaMachina]

thanks, will be a part of next release