make RuleDocsInfo type optional (#1167)

* make `RuleDocsInfo` type optional

* fix lint

Author: dimaMachina

.changeset/tough-apes-deny.md

@@ -0,0 +1,5 @@
+---
+'@graphql-eslint/eslint-plugin': patch
+---
+
+make `RuleDocsInfo` type optional

.github/workflows/release.yml

@@ -11,5 +11,5 @@ jobs:
       releaseScript: release
       nodeVersion: 18
     secrets:
-      githubToken: ${{ secrets.GUILD_BOT_TOKEN }}
+      githubToken: ${{ secrets.GITHUB_TOKEN }}
       npmToken: ${{ secrets.NPM_TOKEN }}

.github/workflows/tests.yml

@@ -13,7 +13,7 @@ jobs:
     with:
       script: yarn ci:lint
     secrets:
-      githubToken: ${{ secrets.GUILD_BOT_TOKEN }}
+      githubToken: ${{ secrets.GITHUB_TOKEN }}
 
   typecheck:
     name: typecheck / graphql v${{matrix.graphql_version}}

packages/plugin/src/types.ts

@@ -52,11 +52,8 @@ export type GraphQLESLintRuleContext<Options = any[]> = Omit<
 
 export type CategoryType = 'Schema' | 'Operations';
 
-export type RuleDocsInfo<T> = {
-  description: string;
+export type RuleDocsInfo<T> = Omit<Rule.RuleMetaData['docs'], 'category' | 'suggestion'> & {
   category: CategoryType | CategoryType[];
-  recommended?: boolean;
-  url: string;
   requiresSchema?: true;
   requiresSiblings?: true;
   examples?: {
@@ -77,7 +74,7 @@ export type RuleDocsInfo<T> = {
 export type GraphQLESLintRule<Options = any[], WithTypeInfo extends boolean = false> = {
   create(context: GraphQLESLintRuleContext<Options>): GraphQLESLintRuleListener<WithTypeInfo>;
   meta: Omit<Rule.RuleMetaData, 'docs'> & {
-    docs: RuleDocsInfo<Options>;
+    docs?: RuleDocsInfo<Options>;
   };
 };