feat: add namespaceConfig to AstDirNode which populates only by index.ts file in current folder. Other occurrences field.index, dir.index are perceive like a regular sub-field with index name.

Author: nodkz

src/__tests__/__snapshots__/astToSchema-test.ts.snap

@@ -64,8 +64,8 @@ type QueryMeAddress {
 }
 
 type QuerySome {
+  index: SomeIndexFileType
   nested: Int
-  type: SomeIndexFileType
 }
 
 type SomeIndexFileType {

src/__tests__/__snapshots__/directoryToAst-test.ts.snap

@@ -7,9 +7,6 @@ Object {
     "auth": Object {
       "absPath": Any<String>,
       "children": Object {
-        "index": ObjectContaining {
-          "kind": "file",
-        },
         "login": ObjectContaining {
           "kind": "file",
         },
@@ -22,6 +19,9 @@ Object {
       },
       "kind": "dir",
       "name": "auth",
+      "namespaceConfig": ObjectContaining {
+        "kind": "file",
+      },
     },
     "logs.nested": Object {
       "absPath": Any<String>,
@@ -62,12 +62,6 @@ Object {
     "field": ObjectContaining {
       "kind": "file",
     },
-    "index": Object {
-      "absPath": Any<String>,
-      "code": Any<Object>,
-      "kind": "file",
-      "name": "index",
-    },
     "me": Object {
       "absPath": Any<String>,
       "children": Object {
@@ -77,35 +71,36 @@ Object {
         "address.street": ObjectContaining {
           "kind": "file",
         },
-        "index": Object {
-          "absPath": Any<String>,
-          "code": Any<Object>,
-          "kind": "file",
-          "name": "index",
-        },
         "name": ObjectContaining {
           "kind": "file",
         },
       },
       "kind": "dir",
       "name": "me",
+      "namespaceConfig": Object {
+        "absPath": Any<String>,
+        "code": Any<Object>,
+        "kind": "file",
+        "name": "index",
+      },
     },
+    "some.index": Any<Object>,
     "some.nested": ObjectContaining {
       "kind": "file",
     },
-    "some.type.index": Any<Object>,
     "user": Object {
       "absPath": Any<String>,
       "children": Object {
         "extendedData": Any<Object>,
-        "index": Any<Object>,
         "roles": Any<Object>,
       },
       "kind": "dir",
       "name": "user",
+      "namespaceConfig": Any<Object>,
     },
   },
   "kind": "rootType",
   "name": "query",
+  "namespaceConfig": Any<Object>,
 }
 `;

src/__tests__/__testSchema__/query/some.type.index.ts renamed to src/__tests__/__testSchema__/query/some.index.ts

@@ -50,18 +50,18 @@ describe('astToSchema()', () => {
       expect(sc.Query.getFieldOTC('some').getFieldTypeName('nested')).toBe('Int');
     });
 
-    it('file: query/some.type.index.ts', () => {
+    it('file: query/some.index.ts should be as regular field', () => {
       createFields(
         sc,
-        getAstForFile(module, path.resolve(__dirname, './__testSchema__/query/some.type.index.ts')),
+        getAstForFile(module, path.resolve(__dirname, './__testSchema__/query/some.index.ts')),
         sc.Query,
         'Query'
       );
       expect(sc.Query.hasField('some')).toBeTruthy();
       expect(sc.Query.getFieldTypeName('some')).toBe('QuerySome');
-      expect(sc.Query.getFieldOTC('some').hasField('type')).toBeTruthy();
-      expect(sc.Query.getFieldOTC('some').getFieldTypeName('type')).toBe('SomeIndexFileType');
-      expect((sc.Query.getFieldOTC('some').getFieldConfig('type') as any).resolve()).toEqual({
+      expect(sc.Query.getFieldOTC('some').hasField('index')).toBeTruthy();
+      expect(sc.Query.getFieldOTC('some').getFieldTypeName('index')).toBe('SomeIndexFileType');
+      expect((sc.Query.getFieldOTC('some').getFieldConfig('index') as any).resolve()).toEqual({
         awesomeValue: 'awesomeValue',
       });
     });

src/__tests__/astToSchema-test.ts

@@ -22,26 +22,26 @@ describe('directoryToAst()', () => {
               'address.city': expect.objectContaining({ kind: 'file' }),
               'address.street': expect.objectContaining({ kind: 'file' }),
               name: expect.objectContaining({ kind: 'file' }),
-              index: {
-                kind: 'file',
-                name: 'index',
-                absPath: expect.any(String),
-                code: expect.any(Object),
-              },
+            },
+            namespaceConfig: {
+              kind: 'file',
+              name: 'index',
+              absPath: expect.any(String),
+              code: expect.any(Object),
             },
           },
-          index: { kind: 'file', absPath: expect.any(String), code: expect.any(Object) },
           'some.nested': expect.objectContaining({ kind: 'file' }),
-          'some.type.index': expect.any(Object),
+          'some.index': expect.any(Object),
           user: {
             absPath: expect.any(String),
             children: {
               extendedData: expect.any(Object),
-              index: expect.any(Object),
               roles: expect.any(Object),
             },
+            namespaceConfig: expect.any(Object),
           },
         },
+        namespaceConfig: expect.any(Object),
       });
     });
 
@@ -54,11 +54,11 @@ describe('directoryToAst()', () => {
           auth: {
             absPath: expect.any(String),
             children: {
-              index: expect.objectContaining({ kind: 'file' }),
               login: expect.objectContaining({ kind: 'file' }),
               logout: expect.objectContaining({ kind: 'file' }),
               nested: expect.objectContaining({ kind: 'dir' }),
             },
+            namespaceConfig: expect.objectContaining({ kind: 'file' }),
           },
           user: {
             absPath: expect.any(String),

src/__tests__/directoryToAst-test.ts

@@ -76,26 +76,17 @@ export function createFields(
   }
 
   if (ast.kind === 'file') {
-    if (name !== 'index') {
-      if (name.endsWith('.index')) {
-        const fieldName = name.slice(0, -6); // remove ".index" from field name
-        parent.addNestedFields({
-          [fieldName]: prepareNamespaceFieldConfig(sc, ast, getTypename(ast, pathPrefix, opts)),
-        });
-      } else {
-        parent.addNestedFields({
-          [name]: prepareFieldConfig(sc, ast),
-        });
-      }
-    }
+    parent.addNestedFields({
+      [name]: prepareFieldConfig(sc, ast),
+    });
     return;
   }
 
   if (ast.kind === 'dir') {
     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);
+    if (ast.namespaceConfig) {
+      fc = prepareNamespaceFieldConfig(sc, ast.namespaceConfig, typename);
     } else {
       fc = { type: sc.createObjectTC(typename) };
     }

src/astToSchema.ts

@@ -21,13 +21,15 @@ export interface AstRootTypeNode extends AstBaseNode {
   children: {
     [key: string]: AstDirNode | AstFileNode;
   };
+  namespaceConfig?: AstFileNode;
 }
 
 export interface AstDirNode extends AstBaseNode {
   kind: 'dir';
   children: {
     [key: string]: AstDirNode | AstFileNode;
   };
+  namespaceConfig?: AstFileNode;
 }
 
 export interface AstFileNode extends AstBaseNode {
@@ -92,6 +94,9 @@ export function directoryToAst(m: NodeModule, options: Options = defaultOptions)
             };
           } else {
             rootTypeAst.children = astDir.children;
+            if (astDir.namespaceConfig) {
+              rootTypeAst.namespaceConfig = astDir.namespaceConfig;
+            }
           }
           result[opType] = rootTypeAst;
         }
@@ -138,7 +143,9 @@ export function getAstForDir(
       // this node is a file
       const fileAst = getAstForFile(m, absFilePath, options);
       if (fileAst) {
-        if (result.children[fileAst.name]) {
+        if (fileAst.name === 'index') {
+          result.namespaceConfig = fileAst;
+        } else if (result.children[fileAst.name]) {
           throw new Error(
             `You have a folder and file with same name "${fileAst.name}" by the following path ${absPath}. Please remove one of them.`
           );
@@ -159,7 +166,7 @@ export function getAstForFile(
 ): AstFileNode | void {
   const filename = basename(absPath);
   if (absPath !== m.filename && checkInclusion(absPath, 'file', filename, options)) {
-    // hash node key shouldn't include file extension
+    // module name shouldn't include file extension
     const moduleName = filename.substring(0, filename.lastIndexOf('.'));
     return {
       kind: 'file',