OpenParable
Skip to content
← Back to skills

Farmfe Guide

Development
farmfe-guide

Farmfe Guide is an Agent Skill for development published in the farm-fe/farm repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Comprehensive Farm build-tool reference for AI agents. Use when writing or reviewing farm.config.ts, adding/configuring plugins, troubleshooting builds, implementing SSR or library mode, using the JavaScript API, writing Farm JS/Rust plugins, or authoring custom plugins from scratch. Covers all config options, official plugins, CLI commands, key features, and plugin authoring sourced from website/docs.

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/farm-fe/farm/blob/HEAD/skills/farmfe-guide/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/farmfe-guide, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

Farm Build Tool — Agent Guide

Farm is an extremely fast Vite-compatible web build tool written in Rust.
Official site: https://farmfe.org | Package: @farmfe/core | Repo: farm-fe/farm


Reference Index

Detailed documentation is split into focused reference files under references/:

FileContents
references/config.mdConfig file setup, shared options, all compilation.* options, all server.* options
references/cli.mdCLI commands (start, build, watch, preview, clean) and all flags
references/plugins.mdUsing plugins (Rust, JS, Vite/Rollup, SWC, Runtime) + official plugins table
references/features.mdQuick start, CSS, TypeScript/JSX, env vars, assets, library mode, SSR, HMR, lazy compilation, persistent cache
references/javascript-api.md@farmfe/core JS API — start/build/watch/preview/clean, Compiler, Server, loadEnv
references/js-plugin-api.mdWriting JS plugins — all hooks, filters structure, code examples
references/writing-plugins.mdAuthoring custom plugins — scaffolding, JS plugin structure, Rust plugin structure, hooks, publishing
references/recipes.mdCommon patterns, framework quick-configs (React/Vue/Svelte/Electron), troubleshooting

Quick Orientation

Create a Project

pnpm create farm@latest
# or with a template:
pnpm create farm my-app --template react

Templates: vanilla, react, vue3, vue2, svelte, solid, preact, lit, nestjs, tauri, electron.

Minimal Config

import { defineConfig } from '@farmfe/core';

export default defineConfig({
  plugins: ['@farmfe/plugin-react'],  // Rust plugin by package name
  compilation: {
    input:  { index: './index.html' },
    output: { targetEnv: 'browser-es2017' },
  },
  server: { port: 9000 },
});

Key Rules

  • Config file: farm.config.ts|js|mjs — do not use __dirname/__filename; use import.meta.url.
  • Rust plugins → plugins: ['package-name'] or ['package-name', optionsObject].
  • Vite/Rollup plugins → vitePlugins: [plugin()], not plugins.
  • JS plugin hooks must declare filters (regex arrays) for performance.
  • resolve.symlinks: true is required when using pnpm.
  • targetEnv: 'library' enables library mode with format: ['esm', 'cjs'] array support.

Dev/Prod Defaults

OptionDevelopmentProduction
lazyCompilation✅ enabled❌ disabled
persistentCache✅ enabled✅ enabled
minify❌ disabled✅ enabled
treeShaking❌ disabled✅ enabled
presetEnv❌ disabled✅ enabled
css.transformToScript✅ enabled❌ disabled