Feat/file extension (#1130)

* feat(apollo typescript): tsFileExtension CLI arg

Author: adrienharnay

packages/apollo-codegen-core/src/compiler/index.ts

@@ -42,6 +42,9 @@ export interface CompilerOptions {
   namespace?: string;
   generateOperationIds?: boolean;
   operationIdsPath?: string;
+  // this option is only implemented in the ts codegen, so we name it
+  // `ts` fileExtension for now.
+  tsFileExtension?: string;
   useReadOnlyTypes?: boolean;
 }
 

packages/apollo-codegen-typescript/src/codeGeneration.ts

@@ -24,6 +24,7 @@ import { BasicGeneratedFile } from "apollo-codegen-core/lib/utilities/CodeGenera
 import { CompilerOptions } from "apollo-codegen-core/lib/compiler";
 import TypescriptGenerator, { ObjectProperty } from "./language";
 import Printer from "./printer";
+import { DEFAULT_FILE_EXTENSION } from "./helpers";
 import { GraphQLType, isListType } from "graphql/type/definition";
 import {
   GraphQLNonNull,
@@ -82,14 +83,15 @@ function printGlobalImport(
   generator: TypescriptAPIGenerator,
   typesUsed: GraphQLType[],
   outputPath: string,
+  tsFileExtension: string,
   globalSourcePath: string
 ) {
   if (typesUsed.length > 0) {
     const relative = path.relative(
       path.dirname(outputPath),
       path.join(
         path.dirname(globalSourcePath),
-        path.basename(globalSourcePath, ".ts")
+        path.basename(globalSourcePath, `.${tsFileExtension}`)
       )
     );
 
@@ -116,7 +118,8 @@ export function generateSource(context: CompilerContext) {
 
     generatedFiles.push({
       sourcePath: operation.filePath,
-      fileName: `${operation.operationName}.ts`,
+      fileName: `${operation.operationName}.${context.options.tsFileExtension ||
+        DEFAULT_FILE_EXTENSION}`,
       content: new TypescriptGeneratedFile(output)
     });
   });
@@ -162,14 +165,16 @@ export function generateLocalSource(
 
   const operations = Object.values(context.operations).map(operation => ({
     sourcePath: operation.filePath,
-    fileName: `${operation.operationName}.ts`,
+    fileName: `${operation.operationName}.${context.options.tsFileExtension ||
+      DEFAULT_FILE_EXTENSION}`,
     content: (options?: IGeneratedFileOptions) => {
       generator.fileHeader();
       if (options && options.outputPath && options.globalSourcePath) {
         printGlobalImport(
           generator,
           generator.getGlobalTypesUsedForOperation(operation),
           options.outputPath,
+          context.options.tsFileExtension || DEFAULT_FILE_EXTENSION,
           options.globalSourcePath
         );
       }
@@ -181,14 +186,16 @@ export function generateLocalSource(
 
   const fragments = Object.values(context.fragments).map(fragment => ({
     sourcePath: fragment.filePath,
-    fileName: `${fragment.fragmentName}.ts`,
+    fileName: `${fragment.fragmentName}.${context.options.tsFileExtension ||
+      DEFAULT_FILE_EXTENSION}`,
     content: (options?: IGeneratedFileOptions) => {
       generator.fileHeader();
       if (options && options.outputPath && options.globalSourcePath) {
         printGlobalImport(
           generator,
           generator.getGlobalTypesUsedForFragment(fragment),
           options.outputPath,
+          context.options.tsFileExtension || DEFAULT_FILE_EXTENSION,
           options.globalSourcePath
         );
       }

packages/apollo-codegen-typescript/src/helpers.ts

@@ -14,6 +14,8 @@ import * as t from "@babel/types";
 
 import { CompilerOptions } from "apollo-codegen-core/lib/compiler";
 
+const DEFAULT_FILE_EXTENSION = "ts";
+
 const builtInScalarMap = {
   [GraphQLString.name]: t.TSStringKeyword(),
   [GraphQLInt.name]: t.TSNumberKeyword(),
@@ -79,3 +81,5 @@ export function createTypeFromGraphQLTypeFunction(
 
   return typeFromGraphQLType;
 }
+
+export { DEFAULT_FILE_EXTENSION };

packages/apollo/src/commands/client/__tests__/__snapshots__/generate.test.ts.snap

@@ -364,6 +364,21 @@ export interface SimpleQuery {
 "
 `;
 
+exports[`client:codegen writes types for typescript with a custom extension 1`] = `
+"/* tslint:disable */
+/* eslint-disable */
+// This file was automatically generated and should not be edited.
+
+// ====================================================
+// GraphQL query operation: SimpleQuery
+// ====================================================
+
+export interface SimpleQuery {
+  hello: string;
+}
+"
+`;
+
 exports[`client:codegen writes typescript types for query with client-side data when client schema in graphql file 1`] = `
 "/* tslint:disable */
 /* eslint-disable */

packages/apollo/src/commands/client/__tests__/generate.test.ts

@@ -191,6 +191,28 @@ describe("client:codegen", () => {
       expect(fs.readFileSync("API.ts").toString()).toMatchSnapshot();
     });
 
+  test
+    .fs({
+      "schema.json": fullSchemaJsonString,
+      "queryOne.graphql": simpleQuery.toString(),
+      "my.config.js": defaultConfig
+    })
+    .command([
+      "client:codegen",
+      "--config=my.config.js",
+      "--target=typescript",
+      "--tsFileExtension=d.ts",
+      "--outputFlat",
+      "outDirectory"
+    ])
+    .it("writes types for typescript with a custom extension", () => {
+      const files = fs.readdirSync("./outDirectory");
+      const filePath = files.find(f => f === "SimpleQuery.d.ts");
+      expect(filePath).toBeDefined();
+      const file = fs.readFileSync(`./outDirectory/${filePath}`).toString();
+      expect(file).toMatchSnapshot();
+    });
+
   test
     .fs({
       "schema.json": fullSchemaJsonString,

packages/apollo/src/commands/client/codegen.ts

@@ -96,7 +96,11 @@ export default class Generate extends ClientCommand {
     // typescript
     globalTypesFile: flags.string({
       description:
-        'By default, TypeScript will put a file named "globalTypes.ts" inside the "output" directory. Set "globalTypesFile" to specify a different path.'
+        'By default, TypeScript will put a file named "globalTypes.ts" inside the "output" directory. Set "globalTypesFile" to specify a different path. Alternatively, set "fileExtension" to modify the extension of the file, for example "d.ts" will output "globalTypes.d.ts"'
+    }),
+    tsFileExtension: flags.string({
+      description:
+        'By default, TypeScript will output "ts" files. Set "tsFileExtension" to specify a different file extension, for example "d.ts"'
     })
   };
 
@@ -200,7 +204,8 @@ export default class Generate extends ClientCommand {
                     useFlowExactObjects: flags.useFlowExactObjects,
                     useReadOnlyTypes:
                       flags.useReadOnlyTypes || flags.useFlowReadOnlyTypes,
-                    globalTypesFile: flags.globalTypesFile
+                    globalTypesFile: flags.globalTypesFile,
+                    tsFileExtension: flags.tsFileExtension
                   }
                 );
               };

packages/apollo/src/generate.ts

@@ -25,6 +25,7 @@ import { generateSource as generateScalaSource } from "apollo-codegen-scala";
 
 import { FlowCompilerOptions } from "../../apollo-codegen-flow/lib/language";
 import { validateQueryDocument } from "apollo-language-server/lib/errors/validation";
+import { DEFAULT_FILE_EXTENSION as TYPESCRIPT_DEFAULT_FILE_EXTENSION } from "apollo-codegen-typescript/lib/helpers";
 
 export type TargetType =
   | "json"
@@ -38,6 +39,7 @@ export type GenerationOptions = CompilerOptions &
   LegacyCompilerOptions &
   FlowCompilerOptions & {
     globalTypesFile?: string;
+    tsFileExtension?: string;
     rootPath?: string;
   };
 
@@ -154,7 +156,12 @@ export default function generate(
       }
 
       const globalSourcePath =
-        options.globalTypesFile || path.join(outputPath, "globalTypes.ts");
+        options.globalTypesFile ||
+        path.join(
+          outputPath,
+          `globalTypes.${options.tsFileExtension ||
+            TYPESCRIPT_DEFAULT_FILE_EXTENSION}`
+        );
       outFiles[globalSourcePath] = {
         output: generatedGlobalFile.fileContents
       };