antfu
Original:🇺🇸 English
Translated
Anthony Fu's opinionated tooling and conventions for JavaScript/TypeScript projects. Use when setting up new projects, configuring ESLint/Prettier alternatives, monorepos, library publishing, or when the user mentions Anthony Fu's preferences.
24installs
Sourceantfu/skills
Added on
NPX Install
npx skill4agent add antfu/skills antfuTags
Translated version includes tags in frontmatterSKILL.md Content
View Translation Comparison →Coding Practices
Code Organization
- Single responsibility: Each source file should have a clear, focused scope/purpose
- Split large files: Break files when they become large or handle too many concerns
- Type separation: Always separate types and interfaces into or
types.tstypes/*.ts - Constants extraction: Move constants to a dedicated file
constants.ts
Runtime Environment
- Prefer isomorphic code: Write runtime-agnostic code that works in Node, browser, and workers whenever possible
- Clear runtime indicators: When code is environment-specific, add a comment at the top of the file:
ts
// @env node
// @env browserTypeScript
- Explicit return types: Declare return types explicitly when possible
- Avoid complex inline types: Extract complex types into dedicated or
typedeclarationsinterface
Comments
- Avoid unnecessary comments: Code should be self-explanatory
- Explain "why" not "how": Comments should describe the reasoning or intent, not what the code does
Testing (Vitest)
- Test files: →
foo.ts(same directory)foo.test.ts - Use /
describeAPI (notit)test - Use for complex outputs
toMatchSnapshot - Use with explicit path for language-specific snapshots
toMatchFileSnapshot
Tooling Choices
@antfu/ni Commands
| Command | Description |
|---|---|
| Install dependencies |
| Add dependency / dev dependency |
| Run script |
| Upgrade dependencies |
| Uninstall dependency |
| Clean install ( |
| Execute package ( |
TypeScript Config
json
{
"compilerOptions": {
"target": "ESNext",
"module": "ESNext",
"moduleResolution": "bundler",
"strict": true,
"esModuleInterop": true,
"skipLibCheck": true,
"resolveJsonModule": true,
"isolatedModules": true,
"noEmit": true
}
}ESLint Setup
js
// eslint.config.mjs
import antfu from '@antfu/eslint-config'
export default antfu()When completing tasks, run to format the code and fix coding style.
pnpm run lint --fixFor detailed configuration options: antfu-eslint-config
Git Hooks
json
{
"simple-git-hooks": {
"pre-commit": "pnpm i --frozen-lockfile --ignore-scripts --offline && npx lint-staged"
},
"lint-staged": { "*": "eslint --fix" },
"scripts": {
"prepare": "npx simple-git-hooks"
}
}pnpm Catalogs
Use named catalogs in for version management:
pnpm-workspace.yaml| Catalog | Purpose |
|---|---|
| Production dependencies |
| Bundler-inlined dependencies |
| Dev tools (linter, bundler, testing) |
| Frontend libraries |
Avoid the default catalog. Catalog names can be adjusted per project needs.
References
| Topic | Description | Reference |
|---|---|---|
| ESLint Config | Framework support, formatters, rule overrides, VS Code settings | antfu-eslint-config |
| Project Setup | .gitignore, GitHub Actions, VS Code extensions | setting-up |
| App Development | Vue/Nuxt/UnoCSS conventions and patterns | app-development |
| Library Development | tsdown bundling, pure ESM publishing | library-development |
| Monorepo | pnpm workspaces, centralized alias, Turborepo | monorepo |