Thank you for your interest in contributing to Farm!. Before submitting your contribution, please make sure to take a moment and read through the following guidelines.
All contributors are expected to follow our Code of Conduct.
As farm is currently in the process of rapid development iteration, some unexpected problems may be encountered in the process of development.
We can't fix what we don't know about, so please report problems and unexpected behavior.
You can open a new issue by following new-issues and choosing one of the issue templates.
Please feel free to open an issue using the feature request template.
-
Please adhere to the code style that you see around the location you are working on.
-
Setup Your Development Environment.
-
Checkout a topic branch from a base branch, e.g.
main
. -
Run
cargo test
and make sure that it passes. -
If you've changed some packages And prepare for an updated version, you should output
npx changeset
in the root directory. we should try our best to keep releasing thepatch version
. If there are no major changes, please choose to update thepatch version
. -
When you are done with your work, verify that it works locally with
pnpm run ready
-
Fork and clone the repo.
-
Create a branch for your PR with
git checkout -b your-branch-name
. -
To keep
main
branch pointing to remote repository and make pull requests from branches on your fork. To do this, run:
git remote add upstream https://github.com/farm-fe/farm.git
git fetch upstream
git branch --set-upstream-to=upstream/main main
We recommend that you use vscode for development and recommend two necessary plugins that you need to install
rust-analyzer
support rust languagebiome
farm use biome to detect and format the code
You can install them in the extension
- Install protoc for building
sass-embedded
.
TIP: When you run pnpm bootstrap
and you use mac or linux systems, farm will automatically install protoc for you system
Farm development is very simple. You only need to execute pnpm bootstrap
in the root directory for development.
$ pnpm bootstrap
-
use
pnpm bootstrap
to install dependencies and build core packages with series of initialization operations. -
Work with examples (open a new terminal):
cd examples/react && pnpm start
, report an issue if the example does not start normally. -
If
examples/react
project runs successfully, the development environment has been configured successfully -
If you changed Rust code in
crates
, runnpm run build:rs
underpackages/core
again to get the latest binary.
When you are developing node side code, the root directory executes pnpm start to debug the code in real time, and when you are developing rust side code, the root directory executes pnpm start:rs to debug the code in real time.
// node side
pnpm start
// rust side
pnpm start:rs
We also need to test two parts, a set of Rust
tests and a set of Node
tests. Make sure all the tests pass before you submit the code.
- Input
cargo test
in the root directory will run all the test cases.
# root path or crates path
cargo test
- Input
pnpm test
in the root directory to run all test cases based onvitest
.
# root path
pnpm test
If you want to develop a plugin for farm, farm provides a scaffolding to help you quickly create a plugin, which you can create with the following command.
You can go to the cd packages/ cli
directory, run npm link
or global installation @ farmfe/ cli
to use this CLI, after the installation is complete, You can create a plugin through farm plugin create
.
Farm supports the creation of rust and js plugins.
$ farm plugin create <plugin-name> # create a plugin support js or rust
Farm is divided into two parts: the JavaScript side
and the Rust side
:
-
the JavaScript side: see code in the
packages
directory. contains core (dev server, file watcher, and compiler wrapper), CLI, runtime, and runtime plugins (module system, HMR). -
the Rust side: see code in the
crates
andrust-plugins
directory. contains core (compilation context, plugin drivers, etc.), compiler (compile process, HMR update, etc.), and plugins.