added more rules

dotansimha · dotansimha · commit 36150de29652 · 2020-09-04T17:23:32.000+03:00
diff --git a/example/.eslintrc.json b/example/.eslintrc.json
@@ -8,6 +8,15 @@
     "@graphql-eslint/validate-against-schema": "error",
     "@graphql-eslint/no-anonymous-operations": "error",
     "@graphql-eslint/no-operation-name-suffix": "error",
-    "@graphql-eslint/deprecation-must-have-reason": "error"
+    "@graphql-eslint/deprecation-must-have-reason": "error",
+    "@graphql-eslint/avoid-operation-name-prefix": ["error", {
+      "keywords": ["get"]
+    }],
+    "@graphql-eslint/no-case-insensitive-enum-values-duplicates": [
+      "error"
+    ],
+    "@graphql-eslint/require-description": ["error", {
+      "on": ["SchemaDefinition", "FieldDefinition"]
+    }]
   }
 }
diff --git a/example/query.graphql b/example/query.graphql
@@ -1,3 +1,3 @@
-query myQuery {
+query my {
   hello
 }
diff --git a/example/schema.graphql b/example/schema.graphql
@@ -1,3 +1,3 @@
 type Query {
-  hello: String! @deprecated(test: "", reason: "!") 
+  hello: String
 }
diff --git a/packages/plugin/src/rules/avoid-operation-name-prefix.ts b/packages/plugin/src/rules/avoid-operation-name-prefix.ts
@@ -0,0 +1,95 @@
+import {
+  GraphQLESLintRule,
+  GraphQLESlintRuleContext,
+  GraphQLESTreeNode,
+} from "@graphql-eslint/types";
+import { OperationDefinitionNode, FragmentDefinitionNode } from "graphql";
+
+type AvoidOperationNamePrefixConfig = {
+  keywords: string[];
+  caseSensitive?: boolean;
+};
+
+const AVOID_OPERATION_NAME_PREFIX = "AVOID_OPERATION_NAME_PREFIX";
+
+function verifyRule(
+  context: GraphQLESlintRuleContext<AvoidOperationNamePrefixConfig>,
+  node:
+    | GraphQLESTreeNode<OperationDefinitionNode>
+    | GraphQLESTreeNode<FragmentDefinitionNode>
+) {
+  const caseSensitive = context.options[0].caseSensitive;
+
+  if (node && node.name && node.name.value !== "") {
+    for (const keyword of context.options[0].keywords) {
+      const testKeyword = caseSensitive ? keyword : keyword.toLowerCase();
+      const testName = caseSensitive
+        ? node.name.value
+        : node.name.value.toLowerCase();
+
+      if (testName.startsWith(testKeyword)) {
+        context.report({
+          loc: {
+            start: {
+              line: node.name.loc.start.line,
+              column: node.name.loc.start.column - 1,
+            },
+            end: {
+              line: node.name.loc.start.line,
+              column: node.name.loc.start.column + testKeyword.length - 1,
+            },
+          },
+          data: {
+            invalidPrefix: keyword,
+          },
+          messageId: AVOID_OPERATION_NAME_PREFIX,
+        });
+      }
+    }
+  }
+}
+
+const rule: GraphQLESLintRule<AvoidOperationNamePrefixConfig> = {
+  meta: {
+    messages: {
+      [AVOID_OPERATION_NAME_PREFIX]: `Forbidden operation name prefix: "{{ invalidPrefix }}"`,
+    },
+    schema: {
+      type: "array",
+      minItems: 1,
+      maxItems: 1,
+      additionalItems: false,
+      items: {
+        additionalProperties: false,
+        type: "object",
+        required: ["keywords"],
+        properties: {
+          caseSensitive: {
+            default: false,
+            type: "boolean",
+          },
+          keywords: {
+            additionalItems: false,
+            type: "array",
+            minItems: 1,
+            items: {
+              type: "string",
+            },
+          },
+        },
+      },
+    },
+  },
+  create(context) {
+    return {
+      OperationDefinition(node) {
+        verifyRule(context, node);
+      },
+      FragmentDefinition(node) {
+        verifyRule(context, node);
+      },
+    };
+  },
+};
+
+export default rule;
diff --git a/packages/plugin/src/rules/index.ts b/packages/plugin/src/rules/index.ts
@@ -2,11 +2,17 @@ import validate from "./validate-against-schema";
 import noAnonymousOperations  from "./no-anonymous-operations";
 import noOperationNameSuffix from "./no-operation-name-suffix";
 import deprecationMustHaveReason from "./deprecation-must-have-reason";
+import avoidOperationNamePrefix from "./avoid-operation-name-prefix";
+import noCaseInsensitiveEnumValuesDuplicates from "./no-case-insensitive-enum-values-duplicates";
+import requireDescription from "./require-description";
 
 export const rules = {
   'validate-against-schema': validate,
   'no-anonymous-operations': noAnonymousOperations,
   'no-operation-name-suffix': noOperationNameSuffix,
-  'deprecation-must-have-reason': deprecationMustHaveReason
+  'deprecation-must-have-reason': deprecationMustHaveReason,
+  'avoid-operation-name-prefix': avoidOperationNamePrefix,
+  'no-case-insensitive-enum-values-duplicates': noCaseInsensitiveEnumValuesDuplicates,
+  'require-description': requireDescription,
 };
  
diff --git a/packages/plugin/src/rules/no-anonymous-operations.ts b/packages/plugin/src/rules/no-anonymous-operations.ts
@@ -5,7 +5,7 @@ const NO_ANONYMOUS_OPERATIONS = 'NO_ANONYMOUS_OPERATIONS';
 const rule: GraphQLESLintRule = {
   meta: {
     messages: {
-      NO_ANONYMOUS_OPERATIONS: `Anonymous GraphQL operations are forbidden. Please make sure to name your {{ operation }}!`
+      [NO_ANONYMOUS_OPERATIONS]: `Anonymous GraphQL operations are forbidden. Please make sure to name your {{ operation }}!`
     }
   },
   create(context) {
diff --git a/packages/plugin/src/rules/no-case-insensitive-enum-values-duplicates.ts b/packages/plugin/src/rules/no-case-insensitive-enum-values-duplicates.ts
@@ -0,0 +1,35 @@
+import { GraphQLESLintRule } from "@graphql-eslint/types";
+import { OperationDefinitionNode, FragmentDefinitionNode, isTypeNode } from "graphql";
+
+const ERROR_MESSAGE_ID = "NO_CASE_INSENSITIVE_ENUM_VALUES_DUPLICATES";
+
+const rule: GraphQLESLintRule = {
+  meta: {
+    fixable: "code",
+    messages: {
+      [ERROR_MESSAGE_ID]: `Case-insensitive enum values duplicates are not allowed! Found: "{{ found }}"`,
+    },
+  },
+  create(context) {
+    return {
+      EnumTypeDefinition(node) {
+        const foundDuplicates = node.values.filter(
+          (item, index) =>
+            node.values.findIndex((v) => v.name.value.toLowerCase() === item.name.value.toLowerCase()) !== index
+        );
+
+        for (const dup of foundDuplicates) {
+          context.report({
+            node: dup.name,
+            data: {
+              found: dup.name.value,
+            },
+            messageId: ERROR_MESSAGE_ID
+          })
+        }
+      },
+    };
+  },
+};
+
+export default rule;
diff --git a/packages/plugin/src/rules/no-operation-name-suffix.ts b/packages/plugin/src/rules/no-operation-name-suffix.ts
@@ -24,7 +24,7 @@ const rule: GraphQLESLintRule = {
   meta: {
     fixable: "code",
     messages: {
-      NO_OPERATION_NAME_SUFFIX: `Unnecessary "{{ invalidSuffix }}" suffix in your operation name!`
+      [NO_OPERATION_NAME_SUFFIX]: `Unnecessary "{{ invalidSuffix }}" suffix in your operation name!`
     }
   },
   create(context) {
diff --git a/packages/plugin/src/rules/require-description.ts b/packages/plugin/src/rules/require-description.ts
@@ -0,0 +1,84 @@
+import {
+  GraphQLESLintRule,
+  GraphQLESlintRuleContext,
+  GraphQLESTreeNode,
+} from "@graphql-eslint/types";
+import { ASTNode, Kind, StringValueNode } from "graphql";
+
+const REQUIRE_DESCRIPTION_ERROR = "REQUIRE_DESCRIPTION_ERROR";
+const DESCRIBABLE_NODES = [
+  Kind.SCHEMA_DEFINITION,
+  Kind.OBJECT_TYPE_DEFINITION,
+  Kind.FIELD_DEFINITION,
+  Kind.INPUT_VALUE_DEFINITION,
+  Kind.INTERFACE_TYPE_DEFINITION,
+  Kind.UNION_TYPE_DEFINITION,
+  Kind.ENUM_TYPE_DEFINITION,
+  Kind.ENUM_VALUE_DEFINITION,
+  Kind.INPUT_OBJECT_TYPE_DEFINITION,
+  Kind.DIRECTIVE_DEFINITION,
+];
+type RequireDescriptionRuleConfig = { on: typeof DESCRIBABLE_NODES };
+
+function verifyRule(
+  context: GraphQLESlintRuleContext<RequireDescriptionRuleConfig>,
+  node: {
+    kind: string;
+    readonly description?: GraphQLESTreeNode<StringValueNode>;
+  }
+) {
+  if (node) {
+    if (
+      !node.description ||
+      !node.description.value ||
+      node.description.value.trim().length === 0
+    ) {
+      context.report({
+        node: node as GraphQLESTreeNode<ASTNode>,
+        messageId: REQUIRE_DESCRIPTION_ERROR,
+        data: {
+          nodeType: node.kind,
+        },
+      });
+    }
+  }
+}
+
+const rule: GraphQLESLintRule<RequireDescriptionRuleConfig> = {
+  meta: {
+    messages: {
+      [REQUIRE_DESCRIPTION_ERROR]: `Description is required for nodes of type {{ nodeType }}"`,
+    },
+    schema: {
+      type: "array",
+      additionalItems: false,
+      minItems: 1,
+      maxItems: 1,
+      items: {
+        type: "object",
+        require: ["on"],
+        properties: {
+          on: {
+            type: "array",
+            minItems: 1,
+            additionalItems: false,
+            items: {
+              type: "string",
+              enum: DESCRIBABLE_NODES,
+            },
+          },
+        },
+      },
+    },
+  },
+  create(context) {
+    return context.options[0].on.reduce((prev, optionKey) => {
+      return {
+        ...prev,
+        [optionKey]: (node) => verifyRule(context, node),
+      };
+    }, {});
+  },
+};
+
+export default rule;
diff --git a/packages/types/src/estree-ast.ts b/packages/types/src/estree-ast.ts
@@ -8,12 +8,23 @@ export type SafeGraphQLType<T extends ASTNode> = Omit<
   "loc"
 >;
 
-export type SingleESTreeNode<T extends any> = T extends ASTNode ? SafeGraphQLType<T> &
-  Pick<BaseNode, "leadingComments" | "trailingComments" | "loc" | "range"> & {
-    type: T["kind"];
-    gqlLocation: Location;
-  } : T;
+export type SingleESTreeNode<T extends any> = T extends ASTNode
+  ? SafeGraphQLType<T> &
+      Pick<
+        BaseNode,
+        "leadingComments" | "trailingComments" | "loc" | "range"
+      > & {
+        type: T["kind"];
+        gqlLocation: Location;
+      }
+  : T;
 
-export type GraphQLESTreeNode<T extends any> = {rawNode: T; } & {
-  [K in keyof SingleESTreeNode<T>]: SingleESTreeNode<T>[K] extends ASTNode ? GraphQLESTreeNode<SingleESTreeNode<T>[K]> : SingleESTreeNode<T>[K];
+export type GraphQLESTreeNode<T extends any> = { rawNode: T } & {
+  [K in keyof SingleESTreeNode<T>]: SingleESTreeNode<T>[K] extends ASTNode
+    ? GraphQLESTreeNode<SingleESTreeNode<T>[K]>
+    : SingleESTreeNode<T>[K] extends ReadonlyArray<infer Nested>
+    ? Nested extends ASTNode
+      ? ReadonlyArray<GraphQLESTreeNode<Nested>>
+      : SingleESTreeNode<T>[K]
+    : SingleESTreeNode<T>[K];
 };
diff --git a/packages/types/src/rule.ts b/packages/types/src/rule.ts
@@ -3,16 +3,17 @@ import { ParserServices } from "./parser-types";
 import { GraphQLESTreeNode } from "./estree-ast";
 import { ASTNode, ASTKindToNode } from "graphql";
 
-export type GraphQLESlintRuleContext = Omit<Rule.RuleContext, "parserServices" | "report"> & {
+export type GraphQLESlintRuleContext<Options = any[]> = Omit<Rule.RuleContext, "parserServices" | "report" | "options"> & {
+  options: Options[];
   report(
     descriptor: Rule.ReportDescriptorMessage &
       Rule.ReportDescriptorOptions & ({ node: GraphQLESTreeNode<ASTNode> } | { loc: AST.SourceLocation | { line: number; column: number } })
   ): void;
   parserServices?: ParserServices;
 };
 
-export type GraphQLESLintRule = {
-  create(context: GraphQLESlintRuleContext): GraphQLESlintRuleListener;
+export type GraphQLESLintRule<Options = any[]> = {
+  create(context: GraphQLESlintRuleContext<Options>): GraphQLESlintRuleListener;
   meta?: Rule.RuleMetaData;
 };
 
diff --git a/packages/types/src/utils.ts b/packages/types/src/utils.ts
@@ -1,6 +1,7 @@
 import { GraphQLESlintRuleContext } from "./rule";
-import { Kind, GraphQLSchema, Location, ValueNode, StringValueNode, ASTNode } from 'graphql';
+import { Kind, GraphQLSchema, Location, ValueNode, StringValueNode, ASTNode, IntValueNode, FloatValueNode, BooleanValueNode, ListValueNode, ObjectValueNode, VariableNode } from 'graphql';
 import { SourceLocation, Comment } from "estree";
+import { GraphQLESTreeNode } from './estree-ast';
 
 export function requireGraphQLSchemaFromContext(
   context: GraphQLESlintRuleContext
@@ -28,32 +29,32 @@ export default function keyValMap<T, V>(
 }
 
 export function valueFromNode(
-  valueNode: ValueNode,
+  valueNode: GraphQLESTreeNode<ValueNode>,
   variables?: Record<string, any>,
 ): any {
-  switch (valueNode.kind) {
+  switch (valueNode.type) {
     case Kind.NULL:
       return null;
     case Kind.INT:
-      return parseInt(valueNode.value, 10);
+      return parseInt((valueNode as GraphQLESTreeNode<IntValueNode>).value, 10);
     case Kind.FLOAT:
-      return parseFloat(valueNode.value);
+      return parseFloat((valueNode as GraphQLESTreeNode<FloatValueNode>).value);
     case Kind.STRING:
     case Kind.ENUM:
     case Kind.BOOLEAN:
-      return valueNode.value;
+      return (valueNode as GraphQLESTreeNode<BooleanValueNode>).value;
     case Kind.LIST:
-      return valueNode.values.map((node) =>
+      return ((valueNode as GraphQLESTreeNode<ListValueNode>).values as any).map((node) =>
         valueFromNode(node, variables),
       );
     case Kind.OBJECT:
       return keyValMap(
-        valueNode.fields,
+        (valueNode as GraphQLESTreeNode<ObjectValueNode>).fields,
         (field) => field.name.value,
         (field) => valueFromNode(field.value, variables),
       );
     case Kind.VARIABLE:
-      return variables?.[valueNode.name.value];
+      return variables?.[(valueNode as GraphQLESTreeNode<VariableNode>).name.value];
   }
 }
 

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`		`-query myQuery {`
	`1`	`+query my {`
`2`	`2`	`hello`
`3`	`3`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`type Query {`
`2`		`- hello: String! @deprecated(test: "", reason: "!")`
	`2`	`+ hello: String`
`3`	`3`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ const NO_ANONYMOUS_OPERATIONS = 'NO_ANONYMOUS_OPERATIONS';`
`5`	`5`	`const rule: GraphQLESLintRule = {`
`6`	`6`	`meta: {`
`7`	`7`	`messages: {`
`8`		- NO_ANONYMOUS_OPERATIONS: `Anonymous GraphQL operations are forbidden. Please make sure to name your {{ operation }}!`
	`8`	+ [NO_ANONYMOUS_OPERATIONS]: `Anonymous GraphQL operations are forbidden. Please make sure to name your {{ operation }}!`
`9`	`9`	`}`
`10`	`10`	`},`
`11`	`11`	`create(context) {`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ const rule: GraphQLESLintRule = {`
`24`	`24`	`meta: {`
`25`	`25`	`fixable: "code",`
`26`	`26`	`messages: {`
`27`		- NO_OPERATION_NAME_SUFFIX: `Unnecessary "{{ invalidSuffix }}" suffix in your operation name!`
	`27`	+ [NO_OPERATION_NAME_SUFFIX]: `Unnecessary "{{ invalidSuffix }}" suffix in your operation name!`
`28`	`28`	`}`
`29`	`29`	`},`
`30`	`30`	`create(context) {`