-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Bye, JS Compiler, we love you! (#3634)
Summary: In the next major Relay Release (v13) the new rust version of the compiler will be the only version. This PR: - Removes JS compiler. - `relay-compiler-experimental` is moved to `relay-compiler`. - Updates `gulpfile` to publish the latest release from the main branch to `reley-compiler` instead of `relay-compiler-experimental`. In the following PRs, we will also update documentation, etc. ![Thank you, bye](https://media.giphy.com/media/YSHCkTrb4M8mcV9jxr/giphy.gif) Pull Request resolved: #3634 Test Plan: Imported from GitHub, without a `Test Plan:` line. **Static Docs Preview: relay** |[Full Site](https://our.intern.facebook.com/intern/staticdocs/eph/1636727028/relay/)| |**Modified Pages**| Reviewed By: kassens Differential Revision: D32380358 Pulled By: alunyov fbshipit-source-id: ae10b3bc9d7cd8f0f968bba13a34e1e83d20afd5
- Loading branch information
1 parent
16c84f7
commit 4467ae8
Showing
711 changed files
with
136 additions
and
86,641 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,21 +1,3 @@ | ||
# Relay Compiler | ||
|
||
Relay-Compiler is a code-generation toolkit for GraphQL. It contains the core functionalities of GraphQL code-gen, including file parsing, validation, syntax tree parsing and transformation. | ||
|
||
The GraphQL-Compiler package [exports library code](./GraphQLCompilerPublic.js) which you may use to find the modules you need, or to extend the compiler with your own custom input and output. Note, the internal APIs of the GraphQL-Compiler are under constant iteration, so rolling your own version may lead to incompatibilities with future releases. | ||
|
||
The following graph illustrates the high-level architecture of a complete GraphQL code-generation pipeline: | ||
|
||
![CodegenPipeline](https://github.com/facebook/relay/raw/main/packages/relay-compiler/docs/Architecture.png) | ||
|
||
To understand the underlying workflow of the core compilation step, which is what happens in the "GraphQL Compiler" block in the above graph, please refer [HERE](./ARCHITECTURE.md). | ||
|
||
You can build your own version of the Compiler by adding your own `FileWriter`, and by swapping or adding a `FileParser` and additional `IRTransforms` (IR, which stands for `Intermediate Representation`, a special-purpose syntax tree format designed for transformability). | ||
|
||
* The GraphQL-Compiler package provides a [`DotGraphQLParser`](./core/DotGraphQLParser.js), which can be used to parse general `.graphql` files, and a [`GraphQLTextParser`](../relay-test-utils-internal/parseGraphQLText.js), which can be used to parse GraphQL text in any source files with customized tags. You can also write your own `FileParser` at your discretion. | ||
|
||
* You can add additional `IRTransforms` by extending the basic [`RelayIRTransforms`](./core/RelayIRTransforms.js). | ||
|
||
* A sample `FileWriter` can be found [HERE](./codegen/RelayFileWriter.js). | ||
|
||
To actually run your compiler, you will also need a script to assemble all the above components. A sample file can be found [HERE](./bin/RelayCompilerBin.js). |
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.
4467ae8
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
❤️