feat: supports providing a string as 'augmentModule'

Author: joelgallant

app-config-generate/src/index.test.ts

@@ -181,6 +181,25 @@ describe('TypeScript File Generation', () => {
       },
     );
   });
+
+  it('augements specific module name', async () => {
+    await withTempFiles(
+      {
+        '.app-config.meta.yml': `
+          generate:
+            - file: generated.d.ts
+              augmentModule: foo-bar
+        `,
+        '.app-config.schema.yml': ``,
+      },
+      async (inDir) => {
+        await generateTypeFiles({ directory: inDir('.') });
+        const config = await readFile(inDir('generated.d.ts')).then((v) => v.toString());
+
+        expect(config).toMatch(`declare module 'foo-bar'`);
+      },
+    );
+  });
 });
 
 describe('Flow File Generation', () => {

app-config-generate/src/index.ts

@@ -58,7 +58,7 @@ export async function generateQuicktype(
   schema: JSONSchema,
   type: string,
   name: string,
-  augmentModule: boolean = true,
+  augmentModule: boolean | string = true,
   leadingCommentsOverride?: string[],
   rendererOptions: RendererOptions = {},
 ): Promise<string[]> {
@@ -108,7 +108,7 @@ export async function generateQuicktype(
       lines.push(`export interface ${name} {}\n`);
     }
 
-    if (augmentModule !== false) {
+    if (augmentModule === true) {
       lines.push(
         ...[
           '// augment the default export from app-config',
@@ -119,6 +119,19 @@ export async function generateQuicktype(
       );
     }
 
+    if (typeof augmentModule === 'string') {
+      lines.push(
+        ...[
+          '// augment the default export from app-config',
+          `declare module '${augmentModule}' {`,
+          `  export * from '@app-config/main';`,
+          `  export { default } from '@app-config/main';`,
+          `  export interface ExportedConfig extends ${name} {}`,
+          '}',
+        ],
+      );
+    }
+
     return (
       lines
         // this is a fix for quicktype, which adds an Object postfix, sometimes