Provide backward compatibility with useFlowReadOnlyTypes flag

Author: mike-marcacci

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

@@ -12,7 +12,7 @@ import {
 
 import * as t from "@babel/types";
 
-import { CompilerOptions } from "apollo-codegen-core/lib/compiler";
+import { FlowCompilerOptions } from "./language";
 
 const builtInScalarMap = {
   [GraphQLString.name]: t.stringTypeAnnotation(),
@@ -23,7 +23,7 @@ const builtInScalarMap = {
 };
 
 export function createTypeAnnotationFromGraphQLTypeFunction(
-  compilerOptions: CompilerOptions
+  compilerOptions: FlowCompilerOptions
 ): Function {
   const arrayType = compilerOptions.useReadOnlyTypes
     ? "$ReadOnlyArray"

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

@@ -16,15 +16,11 @@ export type ObjectProperty = {
   type: t.TSType;
 };
 
-export interface TypescriptCompilerOptions extends CompilerOptions {
-  useReadOnlyTypes: boolean;
-}
-
 export default class TypescriptGenerator {
-  options: TypescriptCompilerOptions;
+  options: CompilerOptions;
   typeFromGraphQLType: Function;
 
-  constructor(compilerOptions: TypescriptCompilerOptions) {
+  constructor(compilerOptions: CompilerOptions) {
     this.options = compilerOptions;
 
     this.typeFromGraphQLType = createTypeFromGraphQLTypeFunction(

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

@@ -337,6 +337,24 @@ describe("client:codegen", () => {
       }
     );
 
+  test
+    .fs({
+      "schema.json": fullSchemaJsonString,
+      "queryOne.graphql": simpleQuery.toString(),
+      "my.config.js": defaultConfig
+    })
+    .command([
+      "client:codegen",
+      "--config=my.config.js",
+      "--target=flow",
+      "--outputFlat",
+      "--useFlowReadOnlyTypes",
+      "__tmp__API.js"
+    ])
+    .it("writes read-only Flow types when the flag is set", () => {
+      expect(fs.readFileSync("__tmp__API.js").toString()).toMatchSnapshot();
+    });
+
   test
     .fs({
       "schema.json": fullSchemaJsonString,

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

@@ -78,6 +78,11 @@ export default class Generate extends ClientCommand {
       description: "Use Flow exact objects for generated types [flow only]"
     }),
 
+    useFlowReadOnlyTypes: flags.boolean({
+      description:
+        "Use read only types for generated types [flow only]. **Deprecated in favor of `useReadOnlyTypes`.**"
+    }),
+
     // flow / TS
     useReadOnlyTypes: flags.boolean({
       description: "Use read only types for generated types [flow | typescript]"
@@ -193,7 +198,8 @@ export default class Generate extends ClientCommand {
                     mergeInFieldsFromFragmentSpreads:
                       flags.mergeInFieldsFromFragmentSpreads,
                     useFlowExactObjects: flags.useFlowExactObjects,
-                    useReadOnlyTypes: flags.useReadOnlyTypes,
+                    useReadOnlyTypes:
+                      flags.useReadOnlyTypes || flags.useFlowReadOnlyTypes,
                     globalTypesFile: flags.globalTypesFile
                   }
                 );