added new rule for unique-fragment-name and added self-documenting rules (#229)

Author: dotansimha

.changeset/tidy-hornets-flash.md

@@ -0,0 +1,5 @@
+---
+'@graphql-eslint/eslint-plugin': minor
+---
+
+New rule: unique-fragment-name

README.md

@@ -56,8 +56,6 @@ To get started, create an override configuration for your ESLint, while applying
       "parser": "@graphql-eslint/eslint-plugin",
       "plugins": ["@graphql-eslint"],
       "rules": {
-        "eol-last": "off",
-        "prettier/prettier": "off"
         ...
       }
     }
@@ -79,16 +77,13 @@ If you are using code files to store your GraphQL schema or your GraphQL operati
       "parser": "@graphql-eslint/eslint-plugin",
       "plugins": ["@graphql-eslint"],
       "rules": {
-        "eol-last": "off",
-        "prettier/prettier": "off"
+        ...
       }
     }
   ]
 }
 ```
 
-> Note: Make sure to disable `eol-last` and `prettier/prettier` - otherwise, you might get an error (see https://github.com/dotansimha/graphql-eslint/issues/88).
-
 #### Extended linting rules with GraphQL Schema
 
 If you are using [`graphql-config`](https://graphql-config.com/) - you are good to go. This package integrates with it automatically, and will use it to load your schema!

docs/rules/avoid-operation-name-prefix.md

@@ -1,32 +1,50 @@
-## Avoid Prefix in GraphQL operation name
+# `avoid-operation-name-prefix`
 
-- Name: `avoid-operation-name-prefix`
+- Category: `Stylistic Issues`
+- Rule name: `@graphql-eslint/avoid-operation-name-prefix`
 - Requires GraphQL Schema: `false`
+- Requires GraphQL Operations: `false`
 
-Allow you to enforce and avoid operation name prefix, useful if you wish to avoid prefix in your root fields,like `getSomething`.
+Enforce/avoid operation name prefix, useful if you wish to avoid prefix in your root fields, or avoid using REST terminology in your schema
 
-### Usage Example
+## Usage Examples
 
-Examples of **incorrect** code for this rule:
+### Incorrect
 
 ```graphql
-# eslint @graphql-eslint/avoid-operation-name-prefix: ["error", { keywords: ["get"] }]
+# eslint @graphql-eslint/avoid-operation-name-prefix: ["error", [{"keywords":["get"]}]]
 
 query getUserDetails {
   # ...
 }
 ```
 
-Examples of **correct** code for this rule:
+### Correct
 
 ```graphql
-# eslint @graphql-eslint/avoid-operation-name-prefix: ["error", { keywords: ["get"] }]
+# eslint @graphql-eslint/avoid-operation-name-prefix: ["error", [{"keywords":["get"]}]]
 
 query userDetails {
   # ...
 }
 ```
 
-### Configuration
+## Config Schema
 
-- `keywords`: array of prefixes you with to avoid in operation names.
+### (array)
+
+The schema defines an array with all elements of the type `object`.
+
+The array object has the following properties:
+
+#### `caseSensitive` (boolean)
+
+Default: `false`
+
+#### `keywords` (array, required)
+
+The object is an array with all elements of the type `string`.
+
+Additional restrictions:
+
+* Minimum items: `1`

docs/rules/description-style.md

@@ -1,38 +1,49 @@
-# Enforce style of the description comments
+# `description-style`
 
-- Name: `description-style`
+- Category: `Stylistic Issues`
+- Rule name: `@graphql-eslint/description-style`
 - Requires GraphQL Schema: `false`
+- Requires GraphQL Operations: `false`
 
-Following the same style for description comments in your code will make them easier to read.
+Require all comments to follow the same style (either block or inline)
 
-## Rule Details
+## Usage Examples
 
-This rule enforces same style for all description comments in your code. This rule has one option: `style` that can be set to either `block` or `inline` (default).
-
-Examples of **incorrect** code for this rule:
+### Incorrect
 
 ```graphql
-# eslint @graphql-eslint/description-style: ["error", { style: "inline" }]
+# eslint @graphql-eslint/description-style: ["error", [{"style":"inline"}]]
 
 """ Description """
 type someTypeName {
     ...
 }
 ```
 
-Examples of **correct** code for this rule:
+### Correct
 
 ```graphql
-# eslint @graphql-eslint/description-style: ["error", { style: "inline" }]
+# eslint @graphql-eslint/description-style: ["error", [{"style":"inline"}]]
 
 " Description "
-type SomeTypeName {
-  someFieldName: String
+type someTypeName {
+    ...
 }
 ```
 
-## Options
+## Config Schema
+
+### (array)
+
+The schema defines an array with all elements of the type `object`.
+
+The array object has the following properties:
+
+#### `style` (string, enum)
+
+This element must be one of the following enum values:
 
-This rule accepts configuration object with one option:
+* `block`
+* `inline`
 
-- `style: 'block'|'inline'` - Will require all comments to be either in block style (`"""`) or inline style (`"`)
+Default: `"inline"`

docs/rules/input-name.md

@@ -1,42 +1,53 @@
-# Enforce names of input parameters and input types
+# `input-name`
 
-- Name: `input-name`
+- Category: `Stylistic Issues`
+- Rule name: `@graphql-eslint/input-name`
 - Requires GraphQL Schema: `false`
+- Requires GraphQL Operations: `false`
 
+Require mutation argument to be always called "input" and input type to be called Mutation name + "Input".
 Using the same name for all input parameters will make your schemas easier to consume and more predictable. Using the same name as mutation for InputType will make it easier to find mutations that InputType belongs to.
 
-## Rule Details
+## Usage Examples
 
-This rule enforces all input parameters to be named `input`, and all InputTypes to use the name of the mutation + `'Input'`.
-
-Examples of **incorrect** code for this rule:
+### Incorrect
 
 ```graphql
-# eslint @graphql-eslint/input-name: ["error", { checkInputType: true }]
+# eslint @graphql-eslint/input-name: ["error", [{"checkInputType":true}]]
 
 type Mutation {
   SetMessage(message: InputMessage): String
 }
 ```
 
-Examples of **correct** code for this rule:
+### Correct (with checkInputType)
 
 ```graphql
-# eslint @graphql-eslint/input-name: ["error", { checkInputType: true }]
+# eslint @graphql-eslint/input-name: ["error", [{"checkInputType":true}]]
 
 type Mutation {
   SetMessage(input: SetMessageInput): String
 }
 ```
 
+### Correct (without checkInputType)
+
 ```graphql
-# eslint @graphql-eslint/input-name: ["error", { checkInputType: false }]
+# eslint @graphql-eslint/input-name: ["error", [{"checkInputType":false}]]
 
 type Mutation {
   SetMessage(input: AnyInputTypeName): String
 }
 ```
 
-## Configuration
+## Config Schema
+
+### (array)
+
+The schema defines an array with all elements of the type `object`.
+
+The array object has the following properties:
+
+#### `checkInputType` (boolean)
 
-This rule accepts one option `checkInputType`. If `true` (default) it will verify that the name of the input type matches name of the mutation + 'Input'. If `false` it will not check InputType name.
+Default: `"true"`