feat(core): option to disable creating index files (#915)

* feat(core): option to disable creating index files

* change option to indexFiles

---------

Co-authored-by: Victor <victor@emaniax.io>

Author: Eric Butler

packages/core/src/types.ts

@@ -51,6 +51,7 @@ export type NormalizedOutputOptions = {
   tsconfig?: Tsconfig;
   packageJson?: PackageJson;
   headers: boolean;
+  indexFiles: boolean;
 };
 
 export type NormalizedOverrideOutput = {
@@ -163,6 +164,7 @@ export type OutputOptions = {
   tsconfig?: string | Tsconfig;
   packageJson?: string;
   headers?: boolean;
+  indexFiles?: boolean;
 };
 
 export type SwaggerParserOptions = Omit<SwaggerParser.Options, 'validate'> & {

packages/core/src/writers/schemas.ts

@@ -82,6 +82,7 @@ export const writeSchemas = async ({
   isRootKey,
   specsName,
   header,
+  indexFiles,
 }: {
   schemaPath: string;
   schemas: GeneratorSchema[];
@@ -90,10 +91,8 @@ export const writeSchemas = async ({
   isRootKey: boolean;
   specsName: Record<string, string>;
   header: string;
+  indexFiles: boolean;
 }) => {
-  const schemaFilePath = upath.join(schemaPath, '/index.ts');
-  await fs.ensureFile(schemaFilePath);
-
   await Promise.all(
     schemas.map((schema) =>
       writeSchema({
@@ -108,32 +107,36 @@ export const writeSchemas = async ({
     ),
   );
 
-  try {
-    const data = await fs.readFile(schemaFilePath);
+  if (indexFiles) {
+    const schemaFilePath = upath.join(schemaPath, '/index.ts');
+    await fs.ensureFile(schemaFilePath);
+    try {
+      const data = await fs.readFile(schemaFilePath);
 
-    const stringData = data.toString();
+      const stringData = data.toString();
 
-    const importStatements = schemas
-      .filter((schema) => {
-        return (
-          !stringData.includes(`export * from './${camel(schema.name)}'`) &&
-          !stringData.includes(`export * from "./${camel(schema.name)}"`)
-        );
-      })
-      .map((schema) => `export * from './${camel(schema.name)}';`);
+      const importStatements = schemas
+          .filter((schema) => {
+            return (
+                !stringData.includes(`export * from './${camel(schema.name)}'`) &&
+                !stringData.includes(`export * from "./${camel(schema.name)}"`)
+            );
+          })
+          .map((schema) => `export * from './${camel(schema.name)}';`);
 
-    const currentFileExports = (stringData
-      .match(/export \* from(.*)('|")/g)
-      ?.map((s) => s + ';') ?? []) as string[];
+      const currentFileExports = (stringData
+          .match(/export \* from(.*)('|")/g)
+          ?.map((s) => s + ';') ?? []) as string[];
 
-    const exports = [...currentFileExports, ...importStatements]
-      .sort()
-      .join('\n');
+      const exports = [...currentFileExports, ...importStatements]
+          .sort()
+          .join('\n');
 
-    const fileContent = `${header}\n${exports}`;
+      const fileContent = `${header}\n${exports}`;
 
-    await fs.writeFile(schemaFilePath, fileContent);
-  } catch (e) {
-    throw `Oups... 🍻. An Error occurred while writing schema index file ${schemaFilePath} => ${e}`;
+      await fs.writeFile(schemaFilePath, fileContent);
+    } catch (e) {
+      throw `Oups... 🍻. An Error occurred while writing schema index file ${schemaFilePath} => ${e}`;
+    }
   }
 };

packages/orval/src/utils/options.ts

@@ -120,6 +120,7 @@ export const normalizeOptions = async (
       tsconfig,
       packageJson,
       headers: outputOptions.headers ?? false,
+      indexFiles: outputOptions.indexFiles ?? true,
       override: {
         ...outputOptions.override,
         mock: {

packages/orval/src/write-specs.ts

@@ -72,6 +72,7 @@ export const writeSpecs = async (
           specKey,
           isRootKey: isRootKey(specKey, target),
           header,
+          indexFiles: output.indexFiles,
         });
       }),
     );
@@ -108,24 +109,26 @@ export const writeSpecs = async (
       );
     }
 
-    const indexFile = upath.join(workspacePath, '/index.ts');
-
-    if (await fs.pathExists(indexFile)) {
-      const data = await fs.readFile(indexFile, 'utf8');
-      const importsNotDeclared = imports.filter((imp) => !data.includes(imp));
-      await fs.appendFile(
-        indexFile,
-        uniq(importsNotDeclared)
-          .map((imp) => `export * from '${imp}';`)
-          .join('\n') + '\n',
-      );
-    } else {
-      await fs.outputFile(
-        indexFile,
-        uniq(imports)
-          .map((imp) => `export * from '${imp}';`)
-          .join('\n') + '\n',
-      );
+    if (output.indexFiles) {
+      const indexFile = upath.join(workspacePath, '/index.ts');
+
+      if (await fs.pathExists(indexFile)) {
+        const data = await fs.readFile(indexFile, 'utf8');
+        const importsNotDeclared = imports.filter((imp) => !data.includes(imp));
+        await fs.appendFile(
+          indexFile,
+          uniq(importsNotDeclared)
+            .map((imp) => `export * from '${imp}';`)
+            .join('\n') + '\n',
+        );
+      } else {
+        await fs.outputFile(
+          indexFile,
+          uniq(imports)
+            .map((imp) => `export * from '${imp}';`)
+            .join('\n') + '\n',
+        );
+      }
     }
 
     implementationPaths = [indexFile, ...implementationPaths];