fix(export): make re-exporting possible (contentful-userland#108)

Both export methods (`toString` and `write`), require to modify the source project.
When re-exporting the output changes depending on the order.

With this fix, re-exporting is possible for both methods.

Author: marcolink

src/cf-definitions-builder.ts

@@ -70,9 +70,54 @@ export default class CFDefinitionsBuilder {
             return writeCallback(targetPath, file.getFullText());
         });
         await Promise.all(writePromises);
+        this.removeIndexFile();
     };
 
-    public toString = (): string => this.mergeFile().getFullText();
+    public toString = (): string => {
+        const mergeFileName = 'ContentTypes';
+        const mergeFile = this.addFile(mergeFileName);
+
+        const imports: OptionalKind<ImportDeclarationStructure>[] = [];
+        const types: string[] = [];
+
+        this.project.getSourceFiles()
+            .filter(sourceFile => sourceFile.getBaseNameWithoutExtension() !== mergeFileName)
+            .forEach(sourceFile => forEachStructureChild(sourceFile.getStructure(),
+                childStructure => {
+                    switch (childStructure.kind) {
+                    case StructureKind.ImportDeclaration:
+                        imports.push(childStructure);
+                        break;
+                    case StructureKind.Interface:
+                        types.push(childStructure.name);
+                        mergeFile.addInterface(childStructure);
+                        break;
+                    case StructureKind.TypeAlias:
+                        types.push(childStructure.name);
+                        mergeFile.addTypeAlias(childStructure);
+                        break;
+                    default:
+                        throw new Error(`Unhandled node type '${StructureKind[childStructure.kind]}'.`);
+                    }
+                }));
+
+        // only import modules not present in merge file
+        imports.forEach(importD => {
+            const name = importD.moduleSpecifier.slice(2);
+            if (!types.includes(name)) {
+                mergeFile.addImportDeclaration(importD);
+            }
+        });
+
+        mergeFile.organizeImports({
+            ensureNewLineAtEndOfFile: true,
+        });
+
+        const fullText = mergeFile.getFullText();
+        this.project.removeSourceFile(mergeFile);
+
+        return fullText;
+    }
 
     private addFile = (name: string): SourceFile => {
         return this.project.createSourceFile(`${name}.ts`,
@@ -86,14 +131,14 @@ export default class CFDefinitionsBuilder {
         return file.addInterface({name, isExported: true});
     };
 
-    private addIndexFile = (): void => {
-        const oldIndexFile = this.project.getSourceFile(file => {
+    private getIndexFile = (): SourceFile | undefined => {
+        return this.project.getSourceFile(file => {
             return file.getBaseNameWithoutExtension() === 'index';
         });
+    }
 
-        if (oldIndexFile) {
-            this.project.removeSourceFile(oldIndexFile);
-        }
+    private addIndexFile = (): void => {
+        this.removeIndexFile();
 
         const files = this.project
             .getSourceFiles()
@@ -112,6 +157,13 @@ export default class CFDefinitionsBuilder {
         indexFile.organizeImports();
     };
 
+    private removeIndexFile = () => {
+        const indexFile = this.getIndexFile();
+        if (indexFile) {
+            this.project.removeSourceFile(indexFile);
+        }
+    }
+
     private addEntryTypeAlias = (file: SourceFile, aliasName: string, entryType: string) => {
         file.addTypeAlias({
             isExported: true,
@@ -146,48 +198,6 @@ export default class CFDefinitionsBuilder {
         file.addImportDeclarations(propertyImports(field, file.getBaseNameWithoutExtension()));
     };
 
-    private mergeFile = (mergeFileName = 'ContentTypes'): SourceFile => {
-        const mergeFile = this.addFile(mergeFileName);
-
-        const imports: OptionalKind<ImportDeclarationStructure>[] = [];
-        const types: string[] = [];
-
-        this.project.getSourceFiles()
-            .filter(sourceFile => sourceFile.getBaseNameWithoutExtension() !== mergeFileName)
-            .forEach(sourceFile => forEachStructureChild(sourceFile.getStructure(),
-                childStructure => {
-                    switch (childStructure.kind) {
-                    case StructureKind.ImportDeclaration:
-                        imports.push(childStructure);
-                        break;
-                    case StructureKind.Interface:
-                        types.push(childStructure.name);
-                        mergeFile.addInterface(childStructure);
-                        break;
-                    case StructureKind.TypeAlias:
-                        types.push(childStructure.name);
-                        mergeFile.addTypeAlias(childStructure);
-                        break;
-                    default:
-                        throw new Error(`Unhandled node type '${StructureKind[childStructure.kind]}'.`);
-                    }
-                }));
-
-        // only import modules not present in merge file
-        imports.forEach(importD => {
-            const name = importD.moduleSpecifier.slice(2);
-            if (!types.includes(name)) {
-                mergeFile.addImportDeclaration(importD);
-            }
-        });
-
-        mergeFile.organizeImports({
-            ensureNewLineAtEndOfFile: true,
-        });
-
-        return mergeFile;
-    };
-
     private addDefaultImports(file: SourceFile) {
         file.addImportDeclaration({
             moduleSpecifier: 'contentful',

test/cf-definitions-builder.test.ts

@@ -404,40 +404,40 @@ describe('A Contentful definitions builder', () => {
             `));
     });
 
-  it('can self-reference', async () => {
-    builder.appendType(modelType);
-    builder.appendType({
-      id: 'rootId',
-      name: 'Root Name',
-      sys: {
-        id: 'myType',
-        type: 'ContentType',
-      }, fields: [
-        {
-          id: 'linkFieldId',
-          name: 'Linked entry Field',
-          type: 'Link',
-          localized: false,
-          required: false,
-          validations: [
-            {
-              linkContentType: [
-                'myType',
-              ],
-            },
-          ],
-          disabled: false,
-          omitted: false,
-          linkType: 'Entry',
-        },
-      ],
-    });
+    it('can self-reference', async () => {
+        builder.appendType(modelType);
+        builder.appendType({
+            id: 'rootId',
+            name: 'Root Name',
+            sys: {
+                id: 'myType',
+                type: 'ContentType',
+            }, fields: [
+                {
+                    id: 'linkFieldId',
+                    name: 'Linked entry Field',
+                    type: 'Link',
+                    localized: false,
+                    required: false,
+                    validations: [
+                        {
+                            linkContentType: [
+                                'myType',
+                            ],
+                        },
+                    ],
+                    disabled: false,
+                    omitted: false,
+                    linkType: 'Entry',
+                },
+            ],
+        });
 
-    await builder.write(fixturesPath, writeFile);
+        await builder.write(fixturesPath, writeFile);
 
-    const result2 = await fs.readFile(path.resolve(fixturesPath, 'TypeMyType.ts'));
+        const result2 = await fs.readFile(path.resolve(fixturesPath, 'TypeMyType.ts'));
 
-    expect('\n' + result2.toString()).to.equal(stripIndent(`
+        expect('\n' + result2.toString()).to.equal(stripIndent(`
                 import * as Contentful from "contentful";
                 
                 export interface TypeMyTypeFields {
@@ -446,5 +446,52 @@ describe('A Contentful definitions builder', () => {
 
                 export type TypeMyType = Contentful.Entry<TypeMyTypeFields>;
                 `));
-  });
+    });
+
+    it('is not changing source project on export', async () => {
+        builder.appendType(modelType);
+        builder.appendType({
+            id: 'rootId',
+            name: 'Root Name',
+            sys: {
+                id: 'myType',
+                type: 'ContentType',
+            }, fields: [
+                {
+                    id: 'linkFieldId',
+                    name: 'Linked entry Field',
+                    type: 'Link',
+                    localized: false,
+                    required: false,
+                    validations: [
+                        {
+                            linkContentType: [
+                                'myType',
+                            ],
+                        },
+                    ],
+                    disabled: false,
+                    omitted: false,
+                    linkType: 'Entry',
+                },
+            ],
+        });
+
+        let beforeWriteResult: Record<string, string> = {}
+        let afterWriteResult: Record<string, string> = {}
+
+        const write = (result: Record<string, string>) => {
+            return async (filePath: string, content: string) => {
+                result = {[filePath]: content, ...result};
+            }
+        }
+
+        const beforeResult = builder.toString();
+        await builder.write(fixturesPath, write(beforeWriteResult));
+        const afterResult = builder.toString();
+        await builder.write(fixturesPath, write(afterWriteResult));
+
+        expect(beforeResult).eql(afterResult);
+        expect(beforeWriteResult).eql(afterWriteResult);
+    });
 });