migrate description-style

Author: dotansimha

README.md

@@ -4,14 +4,14 @@
 
 This project integrates GraphQL AST parser and ESLint.
 
-## Key Features:
+## Key Features
 
 - 🚀 Integrates with ESLint core (as a ESTree parser).
 - 🚀 Works on `.graphql` files, `gql` usages and `/* GraphQL */` magic comments.
 - 🚀 Lints both GraphQL schema and GraphQL operations.
 - 🚀 Extended type info for more advanced usages
 - 🚀 Supports ESLint directives (for example: `disable-next-line`)
-- 🚀 Easily extendable - supports custom rules.
+- 🚀 Easily extendable - supports custom rules based on GraphQL's AST and ESLint API.
 
 Special thanks to [ilyavolodin](https://github.com/ilyavolodin) for his work on a similar project!
 

example/.eslintrc.json

@@ -9,29 +9,7 @@
       },
       "plugins": ["@graphql-eslint"],
       "rules": {
-        "@graphql-eslint/require-id-when-available": [
-          "error",
-          {
-            "fieldName": "_id"
-          }
-        ],
-        "@graphql-eslint/validate-against-schema": "error",
-        "@graphql-eslint/no-anonymous-operations": "warn",
-        "@graphql-eslint/no-operation-name-suffix": "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": [
-          "warn",
-          {
-            "on": ["SchemaDefinition", "FieldDefinition"]
-          }
-        ]
+        "@graphql-eslint/description-style": ["error", { "style": "block" }]
       }
     }
   ]

packages/plugin/src/rules/description-style.ts

@@ -0,0 +1,47 @@
+import { GraphQLESLintRule } from '../types';
+
+type DescriptionStyleRuleConfig = {
+  style: 'inline' | 'block';
+};
+
+const rule: GraphQLESLintRule<DescriptionStyleRuleConfig> = {
+  meta: {
+    type: 'suggestion',
+    docs: {
+      description: 'Require all comments to follow the same style',
+      category: 'Stylistic Issues',
+      recommended: false,
+      url: 'https://github.com/ilyavolodin/graphql-eslint/blob/master/docs/rules/description-style.md',
+    },
+    schema: [
+      {
+        type: 'object',
+        properties: {
+          style: {
+            type: 'string',
+            enum: ['block', 'inline'],
+            default: 'inline',
+          },
+        },
+        additionalProperties: false,
+      },
+    ],
+  },
+  create(context) {
+    const { style } = context.options[0] || { style: 'inline' };
+    const wrongDescriptionType = style === 'block' ? 'inline' : 'block';
+
+    return {
+      '[description.type="StringValue"]': node => {
+        if (node.description.block !== (style === 'block')) {
+          context.report({
+            node: node.description,
+            message: `Unexpected ${wrongDescriptionType} description`,
+          });
+        }
+      },
+    };
+  },
+};
+
+export default rule;

packages/plugin/src/rules/index.ts

@@ -6,6 +6,7 @@ import avoidOperationNamePrefix from './avoid-operation-name-prefix';
 import noCaseInsensitiveEnumValuesDuplicates from './no-case-insensitive-enum-values-duplicates';
 import requireDescription from './require-description';
 import requireIdWhenAvailable from './require-id-when-available';
+import descriptionStyle from './description-style';
 
 export const rules = {
   'validate-against-schema': validate,
@@ -16,4 +17,5 @@ export const rules = {
   'no-case-insensitive-enum-values-duplicates': noCaseInsensitiveEnumValuesDuplicates,
   'require-description': requireDescription,
   'require-id-when-available': requireIdWhenAvailable,
+  'description-style': descriptionStyle
 };