feat: added output.fileExtension option to possible specifying the extension for the generated file. (#1320)

* feat: add `output.extension` option

* feat: use `output.extension` in each mode

* docs: add document for `extension` option

* chore: change option name from `extension` to `fileExtension`

* Update output.md

---------

Co-authored-by: Melloware <mellowaredev@gmail.com>

Author: soartec-lab

docs/src/pages/reference/configuration/output.md

@@ -57,6 +57,36 @@ module.exports = {
 };
 ```
 
+### fileExtension
+
+Type: `String`.
+
+Default Value: `.ts`.
+
+Specify the file extension for files generated automatically. Modes such as `tags`, `tags-split`, and `split` do not alter `schema` files; they only pertain to `client` files.
+
+```js
+module.exports = {
+  petstore: {
+    output: {
+      mode: 'split'
+      target: './/gen/endpoints',
+      schemas: './gen/model',
+      fileExtension: '.gen.ts'
+    },
+  },
+};
+```
+
+```
+src/gen/
+├── endpoints
+│   └── swaggerPetstore.gen.ts
+└── model
+    ├── listPetsParams.ts
+    └── pets.ts
+```
+
 ### workspace
 
 Type: `String`.
@@ -803,7 +833,6 @@ Default Value: `Detect from package json`.
 
 Use to specify a version for the generated hooks. This is useful if you want to force a version for the hooks.
 
-
 #### angular
 
 Type: `Object`.

packages/core/src/types.ts

@@ -43,6 +43,7 @@ export type NormalizedOutputOptions = {
   workspace?: string;
   target?: string;
   schemas?: string;
+  fileExtension: string;
   mode: OutputMode;
   mock?: GlobalMockOptions | ClientMockBuilder;
   override: NormalizedOverrideOutput;
@@ -161,6 +162,7 @@ export type OutputOptions = {
   workspace?: string;
   target?: string;
   schemas?: string;
+  fileExtension?: string;
   mode?: OutputMode;
   // If mock is a boolean, it will use the default mock options (type: msw)
   mock?: boolean | GlobalMockOptions | ClientMockBuilder;

packages/core/src/writers/single-mode.ts

@@ -21,6 +21,7 @@ export const writeSingleMode = async ({
   try {
     const { path, dirname } = getFileInfo(output.target, {
       backupFilename: camel(builder.info.title),
+      extension: output.fileExtension,
     });
 
     const {
@@ -38,7 +39,11 @@ export const writeSingleMode = async ({
     let data = header;
 
     const schemasPath = output.schemas
-      ? upath.relativeSafe(dirname, getFileInfo(output.schemas).dirname)
+      ? upath.relativeSafe(
+          dirname,
+          getFileInfo(output.schemas, { extension: output.fileExtension })
+            .dirname,
+        )
       : undefined;
 
     const isAllowSyntheticDefaultImports = isSyntheticDefaultImportsAllow(

packages/core/src/writers/split-mode.ts

@@ -22,6 +22,7 @@ export const writeSplitMode = async ({
   try {
     const { filename, dirname, extension } = getFileInfo(output.target, {
       backupFilename: camel(builder.info.title),
+      extension: output.fileExtension,
     });
 
     const {
@@ -40,7 +41,11 @@ export const writeSplitMode = async ({
     let mockData = header;
 
     const relativeSchemasPath = output.schemas
-      ? upath.relativeSafe(dirname, getFileInfo(output.schemas).dirname)
+      ? upath.relativeSafe(
+          dirname,
+          getFileInfo(output.schemas, { extension: output.fileExtension })
+            .dirname,
+        )
       : './' + filename + '.schemas';
 
     const isAllowSyntheticDefaultImports = isSyntheticDefaultImportsAllow(

packages/core/src/writers/split-tags-mode.ts

@@ -22,6 +22,7 @@ export const writeSplitTagsMode = async ({
 }: WriteModeProps): Promise<string[]> => {
   const { filename, dirname, extension } = getFileInfo(output.target, {
     backupFilename: camel(builder.info.title),
+    extension: output.fileExtension,
   });
 
   const target = generateTargetForTags(builder, output);
@@ -50,7 +51,11 @@ export const writeSplitTagsMode = async ({
 
         const relativeSchemasPath = output.schemas
           ? '../' +
-            upath.relativeSafe(dirname, getFileInfo(output.schemas).dirname)
+            upath.relativeSafe(
+              dirname,
+              getFileInfo(output.schemas, { extension: output.fileExtension })
+                .dirname,
+            )
           : '../' + filename + '.schemas';
 
         const importsForBuilder =

packages/core/src/writers/tags-mode.ts

@@ -21,6 +21,7 @@ export const writeTagsMode = async ({
 }: WriteModeProps): Promise<string[]> => {
   const { filename, dirname, extension } = getFileInfo(output.target, {
     backupFilename: camel(builder.info.title),
+    extension: output.fileExtension,
   });
 
   const target = generateTargetForTags(builder, output);
@@ -47,7 +48,11 @@ export const writeTagsMode = async ({
         let data = header;
 
         const schemasPathRelative = output.schemas
-          ? upath.relativeSafe(dirname, getFileInfo(output.schemas).dirname)
+          ? upath.relativeSafe(
+              dirname,
+              getFileInfo(output.schemas, { extension: output.fileExtension })
+                .dirname,
+            )
           : './' + filename + '.schemas';
 
         const importsForBuilder = [

packages/orval/src/utils/options.ts

@@ -102,6 +102,8 @@ export const normalizeOptions = async (
     };
   }
 
+  const defaultFileExtension = '.ts';
+
   const normalizedOptions: NormalizedOptions = {
     input: {
       target: globalOptions.input
@@ -126,6 +128,7 @@ export const normalizeOptions = async (
         ? normalizePath(globalOptions.output, process.cwd())
         : normalizePath(outputOptions.target, outputWorkspace),
       schemas: normalizePath(outputOptions.schemas, outputWorkspace),
+      fileExtension: outputOptions.fileExtension || defaultFileExtension,
       workspace: outputOptions.workspace ? outputWorkspace : undefined,
       client: outputOptions.client ?? client ?? OutputClient.AXIOS_FUNCTIONS,
       mode: normalizeOutputMode(outputOptions.mode ?? mode),