ContextQMD
Back to React

React Compiler Development Guide

compiler/docs/DEVELOPMENT_GUIDE.md

19.2.51000 B
Original Source

React Compiler Development Guide

Note: for general notes about contributing, see the CONTRIBUTING.md.

Compiler Development

For general compiler development we recommend the following workflow:

sh
# Install dependencies
yarn

# build the custom test runner
yarn snap:build

# Run the primary tests in watch mode
yarn snap --watch

snap is our custom test runner, which creates "golden" test files that have the expected output for each input fixture, as well as the results of executing a specific input (or sequence of inputs) in both the uncompiled and compiler versions of the input.

When contributing changes, we prefer to:

  • Add one or more fixtures that demonstrate the current compiled output for a particular combination of input and configuration. Send this as a first PR.
  • Then, make changes to the compiler that achieve the desired output for those examples. Commit both the output changes and the corresponding compiler changes in a second PR.