-
-
Notifications
You must be signed in to change notification settings - Fork 254
docs: update AGENTS.md with improved structure #7160
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,32 +1,42 @@ | ||
| # AGENTS.md | ||
|
|
||
| This monorepo contains the Rsbuild build tool, plugins, and related packages. Rsbuild is a high-performance JavaScript build tool powered by Rspack. | ||
| ## Stack | ||
|
|
||
| ## Setup | ||
| - Node.js `22+` | ||
| - `pnpm` workspace + `Nx` monorepo | ||
| - TypeScript (strict mode), Rspack/Rsbuild ecosystem | ||
| - Test runner: `rstest` | ||
|
|
||
| - Enable Corepack and install deps: `npm install corepack -g && corepack enable && pnpm install` | ||
| - Node.js 22+ | ||
| ## Commands (run early) | ||
|
|
||
| ## Commands | ||
| ```bash | ||
| # setup | ||
| corepack enable && pnpm install | ||
|
|
||
| - **Build**: `pnpm build` (all packages) | `npx nx build @rsbuild/core` (specific) | ||
| - **Test**: `pnpm test` (unit tests) | `pnpm test:watch` (watch mode) | `pnpm e2e` (E2E tests) | ||
| - **Single test**: `pnpm test packages/core/src/foo.test.ts` (unit test) | `pnpm e2e cli/base/index.test.ts` (E2E test) | ||
| - **Lint**: `pnpm lint` (REQUIRED before commits) | `pnpm format` (format code) | ||
| # dev checks | ||
| pnpm lint | ||
| pnpm test | ||
| pnpm e2e | ||
|
|
||
| ## Code style | ||
| # focused work | ||
| npx nx build @rsbuild/core | ||
| pnpm test packages/core/tests/foo.test.ts | ||
chenjiahan marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| pnpm e2e css | ||
| ``` | ||
|
|
||
| ## Project structure | ||
|
|
||
| - **Formatting**: Single quotes, Prettier | ||
| - **Types**: TypeScript strict mode | ||
| - **Naming**: camelCase files/functions, PascalCase components/classes, kebab-case packages | ||
| ```text | ||
| packages/core/ # core + CLI | ||
| packages/plugin-*/ # official plugins | ||
| packages/create-rsbuild/ # scaffolding tool | ||
| e2e/ # end-to-end tests | ||
| examples/ # runnable examples | ||
| website/ # docs site | ||
| ``` | ||
|
|
||
| ## Architecture | ||
| ## Code style | ||
|
|
||
| - **Structure**: Monorepo (Pnpm + Nx) | ||
| - `packages/core/`: Main Rsbuild package with CLI | ||
| - `packages/plugin-*/`: Official plugins (React, Vue, Sass, etc.) | ||
| - `packages/create-rsbuild/`: Project scaffolding | ||
| - `e2e/`: End-to-end tests | ||
| - `examples/`: Basic examples | ||
| - `website/`: Documentation | ||
| - **Testing**: `.test.ts` files, use `rstest` runner | ||
| - Use single quotes and existing Prettier conventions. | ||
| - Keep TypeScript strict-safe; avoid `any`. | ||
| - Naming: camelCase (functions/files), PascalCase (types/classes). | ||
chenjiahan marked this conversation as resolved.
Show resolved
Hide resolved
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.