Type error in `RuleDocsInfo`

[Berger92]

Issue workflow progress

Progress of the issue based on the Contributor Workflow

• 1. The issue provides a reproduction available on GitHub, Stackblitz or CodeSandbox

Please make sure the graphql-eslint version under package.json matches yours.

• 2. A failing test has been provided
• 3. A local solution has been provided
• 4. A pull request is pending review

---

Describe the bug

Hi 👋
This is just a small thing that I discovered when I wanted to add urls to our rules and TS didn't like it with the strict flag on, because url wasn't part of RuleDocsInfo.

I took a closer look and discovered that the problem is caused by docs being optional, and therefore the type returned by Omit<Rule.RuleMetaData['docs'], 'category'> is {}.

export type RuleDocsInfo<T> = {
  docs: Omit<Rule.RuleMetaData['docs'], 'category'> & {   <<<<<
    category: CategoryType | CategoryType[];
    requiresSchema?: true;
    requiresSiblings?: true;
    ...
  };
};

To Reproduce

Expected behavior

I think you wanted to keep all the properties from docs except for category, so that should be happening.

Proposed solution

Adding Required solves it.

Environment:

• OS: MacOS Monterey
• @graphql-eslint/eslint-plugin: 3.10.7
• Node.js: 16

[Berger92]

Hey @B2o5T 👋
Any thought on this? 🙂

[dimaMachina]

Hi @Berger92 sorry for delay ! Will be fixed on next release!

[Berger92]

Hi @B2o5T, no worries. Thanks for taking a look. If you like the proposed solution I'm happy to put the PR together.

[dimaMachina]

Hi @Berger92 👋 and sorry for the long time fixing this issue (was too busy with another open source project 😄), I don't think Required<RuleMetaData['docs']> is the right way as:

1. it's requires always set recommended to true/false (setting false for me it's redundant)
2. it's requires always set suggestions field to true/false, but this field is marked as deprecated and should be omitted

Anyway I enhanced RuleDocsInfo type to always requires description and url fields

You can already test these changes and give your feedback with alpha version 3.11.0-alpha-20220923193910-c1bb619 that will be included in the next release 🚀

[Berger92]

@B2o5T Thanks for getting back to me. My proposal was based on not modifying the types, but I like your approach. However, I disagree with making description and url required. That's not the case in eslint.

[dimaMachina]

@Berger92 made description and url optional as well as meta.docs

Try 3.11.1-alpha-20220926112156-14d4be3

[Berger92]

Yeah, good idea Re meta.docs 👍 I'll take a look a bit later today.