feat(astToSchema): add prefix/suffix option

Author: nodkz

package.json

@@ -11,7 +11,7 @@
     "lib"
   ],
   "dependencies": {
-    "dedent": "^0.7.0"
+    "dedent": "0.7.0"
   },
   "peerDependencies": {
     "graphql-compose": "^7.6.1"

src/__tests__/astToSchema-test.ts

@@ -3,6 +3,7 @@ import { astToSchema, createFields } from '../astToSchema';
 import { SchemaComposer } from 'graphql-compose';
 import { printSchema } from 'graphql/utilities';
 import path from 'path';
+import dedent from 'dedent';
 
 describe('astToSchema()', () => {
   describe('Schema ./__testSchema__', () => {
@@ -29,8 +30,8 @@ describe('astToSchema()', () => {
       createFields(
         sc,
         getAstForFile(module, path.resolve(__dirname, './__testSchema__/query/field.ts')),
-        'Query',
-        sc.Query
+        sc.Query,
+        'Query'
       );
       expect(sc.Query.hasField('field')).toBeTruthy();
       expect(sc.Query.getFieldTypeName('field')).toBe('String');
@@ -40,8 +41,8 @@ describe('astToSchema()', () => {
       createFields(
         sc,
         getAstForFile(module, path.resolve(__dirname, './__testSchema__/query/some.nested.ts')),
-        'Query',
-        sc.Query
+        sc.Query,
+        'Query'
       );
       expect(sc.Query.hasField('some')).toBeTruthy();
       expect(sc.Query.getFieldTypeName('some')).toBe('QuerySome');
@@ -53,8 +54,8 @@ describe('astToSchema()', () => {
       createFields(
         sc,
         getAstForFile(module, path.resolve(__dirname, './__testSchema__/query/some.type.index.ts')),
-        'Query',
-        sc.Query
+        sc.Query,
+        'Query'
       );
       expect(sc.Query.hasField('some')).toBeTruthy();
       expect(sc.Query.getFieldTypeName('some')).toBe('QuerySome');
@@ -69,8 +70,8 @@ describe('astToSchema()', () => {
       createFields(
         sc,
         getAstForDir(module, path.resolve(__dirname, './__testSchema__/query/me')),
-        'Query',
-        sc.Query
+        sc.Query,
+        'Query'
       );
       expect(sc.Query.hasField('me')).toBeTruthy();
       expect(sc.Query.getFieldTypeName('me')).toBe('QueryMe');
@@ -105,5 +106,47 @@ describe('astToSchema()', () => {
     });
     const sc = astToSchema(ast);
     expect(sc.Query.getFieldOTC('auth').getFieldTypeName('nested')).toBe('QueryAuthNested');
+    expect(sc.Query.toSDL({ deep: true })).toBe(dedent`
+      type Query {
+        auth: QueryAuth
+      }
+
+      type QueryAuth {
+        nested: QueryAuthNested
+      }
+      
+      type QueryAuthNested {
+        method: Boolean
+      }
+      
+      """The \`Boolean\` scalar type represents \`true\` or \`false\`."""
+      scalar Boolean
+    `);
+  });
+
+  describe('astToSchema()', () => {
+    it('should properly add prefix for created TypeNames', () => {
+      const ast = directoryToAst(module, {
+        relativePath: './__testSchema__',
+        include: /query\.auth$|query\.auth\/nested/,
+      });
+      const sc = astToSchema(ast, { prefix: 'Corp', suffix: 'Old' });
+      expect(sc.Query.toSDL({ deep: true })).toBe(dedent`
+        type Query {
+          auth: CorpQueryAuthOld
+        }
+
+        type CorpQueryAuthOld {
+          nested: CorpQueryAuthNestedOld
+        }
+        
+        type CorpQueryAuthNestedOld {
+          method: Boolean
+        }
+
+        """The \`Boolean\` scalar type represents \`true\` or \`false\`."""
+        scalar Boolean
+      `);
+    });
   });
 });

src/astToSchema.ts

@@ -15,6 +15,8 @@ import { GraphQLObjectType } from 'graphql';
 
 export interface AstOptions {
   schemaComposer?: SchemaComposer<any>;
+  prefix?: string;
+  suffix?: string;
 }
 
 export function astToSchema<TContext = any>(
@@ -36,29 +38,31 @@ export function astToSchema<TContext = any>(
     sc = new SchemaComposer();
   }
 
-  if (ast.query) populateRoot(sc, 'Query', ast.query);
-  if (ast.mutation) populateRoot(sc, 'Mutation', ast.mutation);
-  if (ast.subscription) populateRoot(sc, 'Subscription', ast.subscription);
+  if (ast.query) populateRoot(sc, 'Query', ast.query, opts);
+  if (ast.mutation) populateRoot(sc, 'Mutation', ast.mutation, opts);
+  if (ast.subscription) populateRoot(sc, 'Subscription', ast.subscription, opts);
 
   return sc;
 }
 
 function populateRoot(
   sc: SchemaComposer<any>,
   rootName: 'Query' | 'Mutation' | 'Subscription',
-  astRootNode: AstRootTypeNode
+  astRootNode: AstRootTypeNode,
+  opts?: AstOptions
 ) {
   const tc = sc[rootName];
   Object.keys(astRootNode.children).forEach((key) => {
-    createFields(sc, astRootNode.children[key], rootName, tc);
+    createFields(sc, astRootNode.children[key], tc, rootName, opts || {});
   });
 }
 
 export function createFields(
   sc: SchemaComposer<any>,
   ast: AstDirNode | AstFileNode | void,
-  prefix: string,
-  parent: ObjectTypeComposer
+  parent: ObjectTypeComposer,
+  pathPrefix: string,
+  opts: AstOptions = {}
 ): void {
   if (!ast) return;
 
@@ -76,7 +80,7 @@ export function createFields(
       if (name.endsWith('.index')) {
         const fieldName = name.slice(0, -6); // remove ".index" from field name
         parent.addNestedFields({
-          [fieldName]: prepareNamespaceFieldConfig(sc, ast, `${prefix}${getTypename(ast)}`),
+          [fieldName]: prepareNamespaceFieldConfig(sc, ast, getTypename(ast, pathPrefix, opts)),
         });
       } else {
         parent.addNestedFields({
@@ -88,7 +92,7 @@ export function createFields(
   }
 
   if (ast.kind === 'dir') {
-    const typename = `${prefix}${getTypename(ast)}`;
+    const typename = getTypename(ast, pathPrefix, opts);
     let fc: ObjectTypeComposerFieldConfig<any, any>;
     if (ast.children['index'] && ast.children['index'].kind === 'file') {
       fc = prepareNamespaceFieldConfig(sc, ast.children['index'], typename);
@@ -103,15 +107,17 @@ export function createFields(
       },
     });
 
+    const pathPrefixForChild = getTypename(ast, pathPrefix, {});
     Object.keys(ast.children).forEach((key) => {
-      createFields(sc, ast.children[key], typename, fc.type as any);
+      createFields(sc, ast.children[key], fc.type as any, pathPrefixForChild, opts);
     });
   }
 }
 
-function getTypename(ast: AstDirNode | AstFileNode): string {
+function getTypename(ast: AstDirNode | AstFileNode, pathPrefix: string, opts: AstOptions): string {
   const name = ast.name;
 
+  let typename = pathPrefix;
   if (name.indexOf('.') !== -1) {
     const namesArray = name.split('.');
 
@@ -121,12 +127,16 @@ function getTypename(ast: AstDirNode | AstFileNode): string {
       );
     }
 
-    return namesArray.reduce((prev, current) => {
+    typename += namesArray.reduce((prev, current) => {
       return prev + upperFirst(current);
     }, '');
   } else {
-    return upperFirst(name);
+    typename += upperFirst(name);
   }
+
+  if (opts.prefix) typename = `${opts.prefix}${typename}`;
+  if (opts.suffix) typename += opts.suffix;
+  return typename;
 }
 
 function prepareNamespaceFieldConfig(

yarn.lock

@@ -2188,7 +2188,7 @@ decode-uri-component@^0.2.0:
   resolved "https://registry.yarnpkg.com/decode-uri-component/-/decode-uri-component-0.2.0.tgz#eb3913333458775cb84cd1a1fae062106bb87545"
   integrity sha1-6zkTMzRYd1y4TNGh+uBiEGu4dUU=
 
-dedent@^0.7.0:
+dedent@0.7.0:
   version "0.7.0"
   resolved "https://registry.yarnpkg.com/dedent/-/dedent-0.7.0.tgz#2495ddbaf6eb874abb0e1be9df22d2e5a544326c"
   integrity sha1-JJXduvbrh0q7Dhvp3yLS5aVEMmw=