feat: add new option omitScalars for toSDL() methods. Eg. `schemaCo…

…mposer.toSDL({ omitScalars: true })` will print schema SDL without Scalar types. Closes #239
graphql-compose · Mar 5, 2020 · d431244 · d431244
1 parent 08e1354
commit d431244
Show file tree

Hide file tree

Showing 9 changed files with 89 additions and 23 deletions.
diff --git a/src/InputTypeComposer.js b/src/InputTypeComposer.js
@@ -839,7 +839,8 @@ export class InputTypeComposer<TContext> {
       nestedTypes = nestedTypes.sort((a, b) => a.getTypeName().localeCompare(b.getTypeName()));
       nestedTypes.forEach(t => {
         if (t !== this && !exclude.includes(t.getTypeName())) {
-          r += `\n\n${t.toSDL(innerOpts)}`;
+          const sdl = t.toSDL(innerOpts);
+          if (sdl) r += `\n\n${sdl}`;
         }
       });
       return r;

diff --git a/src/InterfaceTypeComposer.js b/src/InterfaceTypeComposer.js
@@ -1424,7 +1424,8 @@ export class InterfaceTypeComposer<TSource, TContext> {
       nestedTypes = nestedTypes.sort((a, b) => a.getTypeName().localeCompare(b.getTypeName()));
       nestedTypes.forEach(t => {
         if (t !== this && !exclude.includes(t.getTypeName())) {
-          r += `\n\n${t.toSDL(innerOpts)}`;
+          const sdl = t.toSDL(innerOpts);
+          if (sdl) r += `\n\n${sdl}`;
         }
       });
       return r;

diff --git a/src/ObjectTypeComposer.js b/src/ObjectTypeComposer.js
@@ -1816,7 +1816,8 @@ export class ObjectTypeComposer<TSource, TContext> {
       nestedTypes = nestedTypes.sort((a, b) => a.getTypeName().localeCompare(b.getTypeName()));
       nestedTypes.forEach(t => {
         if (t !== this && !exclude.includes(t.getTypeName())) {
-          r += `\n\n${t.toSDL(innerOpts)}`;
+          const sdl = t.toSDL(innerOpts);
+          if (sdl) r += `\n\n${sdl}`;
         }
       });
       return r;

diff --git a/src/SchemaComposer.js b/src/SchemaComposer.js
@@ -796,6 +796,7 @@ export class SchemaComposer<TContext> extends TypeStorage<any, NamedTypeComposer
    * @param {Object} options
    * @param {String[]} options.include - add to SDL only provided types
    * @param {String[]} options.exclude - do not add provided types to SDL
+   * @param {Boolean} options.omitScalars - do not add Scalar types to SDL
    * @param {Boolean} options.omitDescriptions - do not add descriptions to SDL
    * @param {Boolean} options.omitDirectiveDefinitions - do not add directives definitions to SDL
    * @param {Boolean} options.commentDescriptions - print descriptions like comments, starting with #

diff --git a/src/UnionTypeComposer.js b/src/UnionTypeComposer.js
@@ -741,7 +741,8 @@ export class UnionTypeComposer<TSource, TContext> {
       nestedTypes = nestedTypes.sort((a, b) => a.getTypeName().localeCompare(b.getTypeName()));
       nestedTypes.forEach(t => {
         if (t !== this && !exclude.includes(t.getTypeName())) {
-          r += `\n\n${t.toSDL(innerOpts)}`;
+          const sdl = t.toSDL(innerOpts);
+          if (sdl) r += `\n\n${sdl}`;
         }
       });
       return r;

diff --git a/src/__tests__/ObjectTypeComposer-test.js b/src/__tests__/ObjectTypeComposer-test.js
@@ -1836,6 +1836,33 @@ describe('ObjectTypeComposer', () => {
         scalar String
       `);
 
+      expect(
+        sc1.getOTC('User').toSDL({
+          deep: true,
+          omitScalars: true,
+        })
+      ).toBe(dedent`
+        type User implements I1 & I2 {
+          f1: String
+          f2: Int
+          f3: User
+          f4(f: Filter): Int
+        }
+
+        input Filter {
+          a: Boolean
+          b: Filter
+        }
+
+        interface I1 {
+          f1: String
+        }
+
+        interface I2 {
+          f2: Int
+        }
+      `);
+
       expect(
         sc1.getOTC('User').toSDL({
           deep: true,

diff --git a/src/utils/__tests__/schemaPrinter-test.js b/src/utils/__tests__/schemaPrinter-test.js
@@ -1,4 +1,5 @@
 import { SchemaComposer } from '../../SchemaComposer';
+import { dedent } from '../dedent';
 
 describe('schemaPrinter', () => {
   describe('printSchemaComposer()', () => {
@@ -21,8 +22,8 @@ describe('schemaPrinter', () => {
         sc.toSDL({
           omitDescriptions: true,
         })
-      ).toMatchInlineSnapshot(`
-        "directive @key(fields: _FieldSet!) on OBJECT | INTERFACE
+      ).toBe(dedent`
+        directive @key(fields: _FieldSet!) on OBJECT | INTERFACE
 
         scalar _FieldSet
 
@@ -32,9 +33,9 @@ describe('schemaPrinter', () => {
           me: User
         }
 
-        type User @key(fields: \\"id\\") {
+        type User @key(fields: "id") {
           id: ID!
-        }"
+        }
       `);
     });
 
@@ -44,16 +45,16 @@ describe('schemaPrinter', () => {
           omitDescriptions: true,
           omitDirectiveDefinitions: true,
         })
-      ).toMatchInlineSnapshot(`
-        "scalar ID
+      ).toBe(dedent`
+        scalar ID
 
         type Query {
           me: User
         }
 
-        type User @key(fields: \\"id\\") {
+        type User @key(fields: "id") {
           id: ID!
-        }"
+        }
       `);
     });
 
@@ -63,14 +64,14 @@ describe('schemaPrinter', () => {
           omitDescriptions: true,
           exclude: ['User'],
         })
-      ).toMatchInlineSnapshot(`
-        "directive @key(fields: _FieldSet!) on OBJECT | INTERFACE
+      ).toBe(dedent`
+        directive @key(fields: _FieldSet!) on OBJECT | INTERFACE
 
         scalar _FieldSet
 
         type Query {
           me: User
-        }"
+        }
       `);
     });
 
@@ -80,16 +81,16 @@ describe('schemaPrinter', () => {
           omitDescriptions: true,
           include: ['User'],
         })
-      ).toMatchInlineSnapshot(`
-        "directive @key(fields: _FieldSet!) on OBJECT | INTERFACE
+      ).toBe(dedent`
+        directive @key(fields: _FieldSet!) on OBJECT | INTERFACE
 
         scalar _FieldSet
 
         scalar ID
 
-        type User @key(fields: \\"id\\") {
+        type User @key(fields: "id") {
           id: ID!
-        }"
+        }
       `);
     });
 
@@ -100,14 +101,32 @@ describe('schemaPrinter', () => {
           include: ['User'],
           exclude: ['User', 'ID'],
         })
-      ).toMatchInlineSnapshot(`
-        "directive @key(fields: _FieldSet!) on OBJECT | INTERFACE
+      ).toBe(dedent`
+        directive @key(fields: _FieldSet!) on OBJECT | INTERFACE
 
         scalar _FieldSet
 
-        type User @key(fields: \\"id\\") {
+        type User @key(fields: "id") {
           id: ID!
-        }"
+        }
+      `);
+    });
+
+    it('should print schema in SDL without scalars', () => {
+      expect(
+        sc.toSDL({
+          omitScalars: true,
+        })
+      ).toBe(dedent`
+        directive @key(fields: _FieldSet!) on OBJECT | INTERFACE
+
+        type Query {
+          me: User
+        }
+
+        type User @key(fields: "id") {
+          id: ID!
+        }
       `);
     });
   });

diff --git a/src/utils/schemaPrinter.d.ts b/src/utils/schemaPrinter.d.ts
@@ -37,6 +37,13 @@ type Options = {
    */
   omitDescriptions?: boolean;
 
+  /**
+   * Do not print Scalars for types
+   *
+   * Default: false
+   */
+  omitScalars?: boolean | null;
+
   /**
    * Sort fields, args and interfaces.
    * Useful for snapshot testing.

diff --git a/src/utils/schemaPrinter.js b/src/utils/schemaPrinter.js
@@ -62,6 +62,13 @@ type Options = {
    */
   omitDescriptions?: ?boolean,
 
+  /**
+   * Do not print Scalars for types
+   *
+   * Default: false
+   */
+  omitScalars?: boolean | null,
+
   /**
    * Sort fields, args and interfaces.
    * Useful for snapshot testing.
@@ -258,6 +265,7 @@ export function printType(type: GraphQLNamedType, options?: Options): string {
 }
 
 export function printScalar(type: GraphQLScalarType, options?: Options): string {
+  if (options?.omitScalars) return '';
   return `${printDescription(type, options)}scalar ${type.name}${printNodeDirectives(
     type.astNode
   )}`;