Add --comment-descriptions CLI option

README.md

@@ -44,6 +44,10 @@ Options:
 
     schema definition will be read from STDIN instead of specified file
 
+  --comment-descriptions
+
+    use old way of defining descriptions in GraphQL SDL
+
   -c, --config-direction <path>
 
     path to begin searching for config files

src/runner.js

@@ -28,6 +28,10 @@ export function run(stdout, stdin, stderr, argv) {
       '-p, --custom-rule-paths <paths>',
       'path to additional custom rules to be loaded. Example: rules/*.js'
     )
+    .option(
+      '--comment-descriptions',
+      'use old way of defining descriptions in GraphQL SDL'
+    )
     // DEPRECATED - This code should be removed in v1.0.0.
     .option(
       '-o, --only <rules>',
@@ -136,6 +140,10 @@ function getOptionsFromCommander(commander) {
     options.customRulePaths = commander.customRulePaths.split(',');
   }
 
+  if (commander.commentDescriptions) {
+    options.commentDescriptions = commander.commentDescriptions;
+  }
+
   if (commander.args && commander.args.length) {
     options.schemaPaths = commander.args;
   }

test/fixtures/animal.graphql

@@ -1,21 +1,23 @@
-# Base query
+"Base query"
 type Query {
-  # Animal Viewing
+  "Animal Viewing"
   viewer: Animal!
 }
 
-# Animal
+"Animal"
 type Animal {
-  # name
+  "name"
   name: String!
-  # type
+
+  "type"
   types: [AnimalTypes]
 }
 
-# Animal type enum
+"Animal type enum"
 enum AnimalTypes {
-  # meow
+  "meow"
   CAT_ENUM
-  # woof
+
+  "woof"
   DOG_ENUM
 }

test/fixtures/valid.graphql

@@ -1,5 +1,5 @@
-# Query
+"Query"
 type Query {
-  # a
+  "a"
   a: String!
 }

test/runner.js

@@ -70,6 +70,27 @@ describe('Runner', () => {
       assert.equal(0, exitCode);
     });
 
+    it('allows setting descriptions using comments in GraphQL SDL', () => {
+      const argv = [
+        'node',
+        'lib/cli.js',
+        '--format',
+        'text',
+        '--comment-descriptions',
+        `${__dirname}/fixtures/schema.comment-descriptions.graphql`,
+      ];
+
+      run(mockStdout, mockStdin, mockStderr, argv);
+
+      const expected =
+        `${__dirname}/fixtures/schema.comment-descriptions.graphql\n` +
+        '3:3 The field `Query.a` is missing a description.  fields-have-descriptions\n' +
+        '\n' +
+        '✖ 1 error detected\n';
+
+      assert.equal(expected, stripAnsi(stdout));
+    });
+
     it('validates a single schema file and outputs in text', () => {
       const argv = [
         'node',
@@ -108,7 +129,7 @@ describe('Runner', () => {
       const expected =
         `${__dirname}/fixtures/animal.graphql\n` +
         "18:3 The enum value `AnimalTypes.CAT_ENUM` cannot include the word 'enum'.  enum-name-cannot-contain-enum\n" +
-        "20:3 The enum value `AnimalTypes.DOG_ENUM` cannot include the word 'enum'.  enum-name-cannot-contain-enum\n" +
+        "21:3 The enum value `AnimalTypes.DOG_ENUM` cannot include the word 'enum'.  enum-name-cannot-contain-enum\n" +
         '\n' +
         '✖ 2 errors detected\n';