ueumd / farm

Extremely fast Vite-compatible web build tool written in Rust

Extremely fast Vite-compatible web building tool written in Rust

English | 简体中文

---

Intro

Farm is a extremely fast vite-compatible web-building tool written in Rust. Benchmark against other tools (using Turbopack's benchmark, 1000 React components) as shown below:

All Benchmark

Test Repository: https://github.com/farm-fe/performance-compare

Test Machine (Linux Mint 21.1 Cinnamon, 11th Gen Intel© Core™ i5-11400 @ 2.60GHz × 6, 15.5 GiB)

Hot (Startup and Build) Benchmark

Note

Since Farm v0.14, Farm has implemented persistent cache. The following compares Farm's use of persistent cache in hot starts and production builds with other tools.

Online experience

Why Farm?

See Why Farm for details.

In short, tools like webpack are too slow, but new tools like Vite are not perfect, Vite has a lot of drawbacks when comes to a large project:

• A huge number of requests during development：when there are hundreds or thousands modules per page, loading performance severely degraded, it may takes seconds or more when refresh the page.
• Inconsistency between development and production: Using different strategy and tools in development and production, it's really inconsistent and it's hard to debug online issues.
• Inflexible Code Splitting: It's hard to control the output of your bundles.

Farm can solve these problems perfectly, and it's really fast cause it's written in Rust. Farm aims to be fast, consistent, flexible, which is the real next generation build tool.

Features

Note

Since Farm v0.13, Vite plugins can be used directly in Farm. Refer to Using vite plugins in Farm

• ⚡ Extremely Fast: Written in Rust, start a React / Vue project in milliseconds and perform an HMR update within 20ms for most situations.
• ⚡ Incremental Building: Support persistent cache, module level cache enabled by default, any module won't be compiled twice until it's changed!
• 🧰 Fully Pluggable and Vite Compatible: Everything inside Farm is powered by plugins, Support Vite Plugins out of box. Supports Farm compilation plugins(both Rust and JavaScript plugins, and SWC plugins), Farm runtime plugins and Farm server plugin.
• ⚙️ Powerful: Compiles JS/TS/JSX/TSX, CSS, Css Modules, HTML, and static assets out of the box. Support official compilation plugins for Popular frameworks/tools like React, Vue, SolidJs, Sass, Less, Postcss and so on.
• ⏱️ Lazy Compilation: Dynamically imported resources are compiled only when requested, speed up compilation for large scale project. Just write a dynamic import and the imported module won't be compiled when it is executed.
• 📦 Partial Bundling: Bundle your project into a few reasonable bundles automatically, speeding up resource loading without losing caching granularity. Refer to RFC-003 Partial Bundling for details.
• 🔒 Consistency: What you see in development will be the same as what you get in production.
• 🌳 Compatibility: Supports both legacy (ES5) and modern browsers.

Farm has implemented all features of a web build tool, including production optimization like tree shake and minification. We have already migrated enterprise projects to Farm, and it works great!

See RFC-001 Architecture for design motivation and architecture.

Getting Started

Create a new Farm(support both React and Vue) project with your favorite package manager:

# with npm
npm create farm@latest
# with yarn
yarn create farm@latest
# with pnpm
pnpm create farm@latest

Then start the project:

cd farm-project && npm start

See our 1 minute quick start video:

farm-quick-start.mp4

Refer to the Documentation to learn more about Farm.

• Farm Guide
• Farm Config
• Farm Plugins

Farm Plugins

See Using Plugins for how to use plugins in Farm.

Rust Plugins

• @farmfe/plugin-react
• @farmfe/plugin-sass

Js Plugins

• @farmfe/js-plugin-postcss
• @farmfe/js-plugin-less
• @farmfe/js-plugin-svgr
• @farmfe/js-plugin-dts
• @farmfe/js-plugin-sass

Community Plugins

Plugins of Vite/Rollup/Unplugin can be directly used in Farm.

• @vitejs/plugin-vue
• @vitejs/plugin-vue-jsx
• vite-plugin-solid
• vite-plugin-mock
• unplugin-auto-import
• unplugin-vue2-script-setup
• unplugin-icons
• unplugin-vue-components
• ...

See Community Plugins for more available plugins.

Contribution

See Contributing Guide.

Examples

Farm support compiling React, Vue, SolidJS, Sass, Less, and Css Modules officially out of the box. See our examples:

React Examples	Vue Examples	Vite Plugin Examples
React-Basic React-Ant-Design React-Sass-CssModules React-Multi-Page-Application React-SSR React-TailwindCSS	Vue-Basic Vue-Jsx Vue-Antdv	Plugin-Vue Plugin-Solid farm-soybean-admin：A real admin project migrated from Vite to Farm

Chat With Us

• Author Twitter, Official Twitter

• With Discord

• Wechat group

Contributors

Credits

Thanks to:

• The SWC project created by @kdy1, which powers Farm's code parsing, transformation and minification.

• The NAPI-RS project created by @Brooooooklyn, which powers Farm's node-binding implementation.

• The Rollup project created by @lukastaegert, which inspired Farm's plugin system implementation.

• The Vite project created by Evan You, which inspired Farm's compatibility design of ecosystem.

Author

brightwu（吴明亮）, worked at Bytedance.