[PluginInterface] Add type generator options.

Author: alloy

package.json

@@ -5,7 +5,8 @@
   "main": "index.js",
   "scripts": {
     "build": "rm -rf lib && tsc",
-    "test": "node bin/relay-compiler.js --schema test/schema.graphql --src test/ --outputDir __generated__",
+    "relay": "node bin/relay-compiler.js --schema test/schema.graphql --src test/ --outputDir __generated__",
+    "test": "yarn type-check && jest",
     "type-check": "tsc --noEmit --pretty",
     "prettier": "prettier --write '{src,types}/**/*.ts'",
     "sync-fixtures": "rsync -avh --delete --stats --progress ../relay/packages/relay-compiler/language/javascript/__tests__/fixtures/flow-generator/*.graphql test/fixtures/type-generator"

src/TypeScriptGenerator.ts

@@ -7,7 +7,6 @@ import {
   transformScalarType,
   transformInputType,
   ScalarTypeMapping,
-  Options,
   State
 } from "./TypeScriptTypeTransformers";
 import {
@@ -25,6 +24,8 @@ import {
   Root
 } from "relay-compiler/lib/GraphQLCompilerPublic";
 
+import { TypeGeneratorOptions } from 'relay-compiler'
+
 const { isAbstractType } = SchemaUtils;
 
 export const generate: TypeGenerator["generate"] = (node, options) => {
@@ -276,15 +277,15 @@ function importTypes(names: string[], fromModule: string): ts.Statement {
   );
 }
 
-function createVisitor(options: Options) {
+function createVisitor(options: TypeGeneratorOptions) {
   const state: State = {
     customScalars: options.customScalars,
     enumsHasteModule: options.enumsHasteModule,
     existingFragmentNames: options.existingFragmentNames,
     inputFieldWhiteList: options.inputFieldWhiteList,
     relayRuntimeModule: options.relayRuntimeModule,
-    getGeneratedDirectory: options.getGeneratedDirectory,
-    destinationDirectory: options.destinationDirectory,
+    getGeneratedDirectory: undefined,
+    destinationDirectory: undefined,
     usedEnums: {},
     usedFragments: new Set(),
     useHaste: options.useHaste

src/TypeScriptTypeTransformers.ts

@@ -13,26 +13,20 @@ import {
   GraphQLUnionType
 } from "graphql";
 
+import { TypeGeneratorOptions } from 'relay-compiler'
+
 export type ScalarTypeMapping = {
   [type: string]: string;
 };
 
-export interface Options {
-  customScalars: ScalarTypeMapping;
-  useHaste: boolean;
-  enumsHasteModule: string | null | undefined;
-  existingFragmentNames: Set<string>;
-  inputFieldWhiteList: ReadonlyArray<string>;
-  relayRuntimeModule: string;
-  // TODO: Marking these as optional until we determine how we can best make imports work.
-  getGeneratedDirectory?: (name: string) => CodegenDirectory;
-  destinationDirectory?: CodegenDirectory;
-}
-
 export type State = {
   usedEnums: { [name: string]: GraphQLEnumType };
   usedFragments: Set<string>;
-} & Options;
+  // TODO: Marking these as optional and moved from ‘options’ to ‘state’ until we determine how we can best make imports
+  //       work.
+  getGeneratedDirectory?: (name: string) => CodegenDirectory;
+  destinationDirectory?: CodegenDirectory;
+} & TypeGeneratorOptions;
 
 export function transformScalarType(
   type: GraphQLType,

types/relay-compiler/language/RelayLanguagePluginInterface.d.ts

@@ -35,10 +35,18 @@ export type FormatModule = (
 
 export type GraphQLTagFinder = (text: string) => Array<GraphQLTag>;
 
+export interface TypeGeneratorOptions {
+  readonly customScalars: { [type: string]: string },
+  readonly useHaste: boolean,
+  readonly enumsHasteModule: string | null,
+  readonly existingFragmentNames: Set<string>,
+  readonly inputFieldWhiteList: ReadonlyArray<string>,
+  readonly relayRuntimeModule: string,
+}
+
 export interface TypeGenerator {
   transforms: Array<IRTransform>;
-  // For now this is an opaque set of options communicated from the bin to the plugin.
-  generate: (node: Root | Fragment, options: any) => string;
+  generate: (node: Root | Fragment, options: TypeGeneratorOptions) => string;
 }
 
 export interface PluginInterface {