Skip to content

Commit

Permalink
Update in the README for v14
Browse files Browse the repository at this point in the history
Summary:
- added `javascript`
- removed `typegenPhase` from the docs

Reviewed By: kassens

Differential Revision: D35092808

fbshipit-source-id: 233a1b066bc46ee3379d07d6ea244fcfde4185e4
  • Loading branch information
alunyov authored and facebook-github-bot committed Mar 25, 2022
1 parent d85428f commit 0e057c3
Showing 1 changed file with 6 additions and 13 deletions.
19 changes: 6 additions & 13 deletions packages/relay-compiler/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,20 +64,18 @@ file sources, and "listen" to the file changes in the "watch" mode. If

- `src` Root directory of application code. [string] [required]
- `schema` Relative path to the file with GraphQL SDL file. [string] [required]
- `schemaConfig`
- `nodeInterfaceIdField` Configure the name of the globally unique ID field on
the Node interface. Useful if you can't use the default `id` field name.
[string][default: "id"]
- `language` The name of the language used for input files and generated
artifacts. ["javascript" | "typescript" | "flow"] [required].
- `artifactDirectory` A specific directory to output all artifacts to. When
enabling this the babel plugin needs `artifactDirectory` to be set as well.
[string]
- `language` The name of the language used for input files and generated
artifacts. ["typescript" | "flow"] [default: "typescript"]. Please, use "flow"
for plain JS projects: flow-types emitted as comments, and the generated
artifacts with "flow" are valid JS modules.
- `excludes` Directories to ignore under `src`. [array] [default:
["**/node_modules/**", "**/__mocks__/**", "**/__generated__/**"]]
- `schemaExtensions` List of directories with schema extensions. [array]
- `schemaConfig`
- `nodeInterfaceIdField` Configure the name of the globally unique ID field on
the Node interface. Useful if you can't use the default `id` field name.
[string][default: "id"]
- `noFutureProofEnums` For `flow` only. This option controls whether or not a
catch-all entry is added to enum type definitions values that may be added in
the future. Enabling this means you will have to update your application
Expand Down Expand Up @@ -108,11 +106,6 @@ file sources, and "listen" to the file changes in the "watch" mode. If
[string]
- `jsModuleFormat` Formatting style for generated files. `commonjs` or `haste`.
Default is `commonjs`. [string]
- `typegenPhase` - `Final` or `Compat`. Use `Compat` for exposing old
`<module>QueryVariables` and `<module>QueryResponse` types in the generated
artifacts. But we do recommend migrating to the `Final` mode, where the naming
of the exposed types are unified with `<module>$data` and `<module>$variables`
suffixes.

### CLI Arguments

Expand Down

0 comments on commit 0e057c3

Please sign in to comment.