|
8 | 8 | <a href="https://github.com/rstackjs/rstack/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square&colorA=564341&colorB=EDED91" alt="license" /></a> |
9 | 9 | </p> |
10 | 10 |
|
11 | | -Rstack CLI brings the Rstack toolchain together for JavaScript development, with one CLI and one consistent workflow. |
| 11 | +Rstack CLI brings the Rstack toolchain together for JavaScript development, with one CLI, one configuration, and one consistent workflow. |
| 12 | + |
| 13 | +It also covers local development needs outside Rstack's scope, with Oxfmt formatting and lint-staged commands. |
12 | 14 |
|
13 | 15 | | Command | Description | Powered by | |
14 | 16 | | ------------ | ----------------------------- | --------------------------------------------------------- | |
15 | 17 | | `rs dev` | Start a local app dev server | [Rsbuild](https://github.com/web-infra-dev/rsbuild) | |
16 | 18 | | `rs build` | Create a production app build | [Rsbuild](https://github.com/web-infra-dev/rsbuild) | |
17 | 19 | | `rs preview` | Preview the production build | [Rsbuild](https://github.com/web-infra-dev/rsbuild) | |
18 | | -| `rs lib` | Build library outputs | [Rslib](https://github.com/web-infra-dev/rslib) | |
19 | | -| `rs doc` | Develop and build docs | [Rspress](https://github.com/web-infra-dev/rspress) | |
20 | 20 | | `rs test` | Run the test suite | [Rstest](https://github.com/web-infra-dev/rstest) | |
21 | 21 | | `rs lint` | Lint and type-check code | [Rslint](https://github.com/web-infra-dev/rslint) | |
| 22 | +| `rs lib` | Build library outputs | [Rslib](https://github.com/web-infra-dev/rslib) | |
| 23 | +| `rs doc` | Develop and build docs (TODO) | [Rspress](https://github.com/web-infra-dev/rspress) | |
| 24 | +| `rs fmt` | Format code (TODO) | [Oxfmt](https://github.com/oxc-project/oxc) | |
22 | 25 | | `rs staged` | Run tasks for staged files | [lint-staged](https://github.com/lint-staged/lint-staged) | |
23 | 26 |
|
24 | | -It also covers common local development tasks, with formatting powered by [Oxfmt](https://github.com/oxc-project/oxc) and staged-file commands powered by [lint-staged](https://github.com/lint-staged/lint-staged), giving Rstack projects a complete development experience out of the box. |
25 | | - |
26 | 27 | Rstack CLI fits into your existing project workflow. It does not replace your runtime, package manager, or task runner, such as [pnpm](https://github.com/pnpm/pnpm), [Bun](https://github.com/oven-sh/bun), [Turborepo](https://github.com/vercel/turborepo), [Nx](https://github.com/nrwl/nx), and [Nub](https://github.com/nubjs/nub). |
27 | 28 |
|
28 | 29 | ## Current status |
|
0 commit comments