Skip to content

Commit 0073abe

Browse files
committed
feat: add Rstack configuration guide link
1 parent 9316dab commit 0073abe

18 files changed

Lines changed: 59 additions & 1 deletion

File tree

.agents/skills/migrate-to-rstack-cli/SKILL.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ Use one of the default names: `rstack.config.ts`, `.js`, `.mts`, or `.mjs`.
4040
Use `rs -c <path>` or `rs --config <path>` only for a custom path.
4141

4242
```ts
43+
// Rstack configuration guide: https://rstack.rs/config
4344
import { define } from 'rstack';
4445

4546
define.app({

examples/app-react/rstack.config.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
// Rstack configuration guide: https://rstack.rs/config
12
import { define } from 'rstack';
23

34
define.app(async () => {

examples/app-vanilla/rstack.config.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
// Rstack configuration guide: https://rstack.rs/config
12
import { define } from 'rstack';
23

34
define.test({

examples/documentation/rstack.config.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
// Rstack configuration guide: https://rstack.rs/config
12
import { define } from 'rstack';
23
import path from 'node:path';
34

examples/lib-node/rstack.config.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
// Rstack configuration guide: https://rstack.rs/config
12
import { define } from 'rstack';
23

34
define.lib({

examples/lib-react/rstack.config.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
// Rstack configuration guide: https://rstack.rs/config
12
import { define } from 'rstack';
23

34
define.lib(async () => {

examples/rstest-inline-projects/rstack.config.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
// Rstack configuration guide: https://rstack.rs/config
12
import { define } from 'rstack';
23
import { defineInlineProject } from 'rstack/test';
34

packages/rstack/rstack.config.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
// Rstack configuration guide: https://rstack.rs/config
12
import { define } from 'rstack';
23

34
define.test(async () => {

packages/rstack/src/config.ts

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,18 +78,24 @@ type Define = {
7878
* Defines the Rsbuild config for the app.
7979
*
8080
* This config is used by the `rs dev`, `rs build`, and `rs preview` commands.
81+
*
82+
* @see {@link https://rstack.rs/config | Rstack configuration guide}
8183
*/
8284
app: (config: RsbuildConfigDefinition) => void;
8385
/**
8486
* Defines the Rslib config for libraries.
8587
*
8688
* This config is used by the `rs lib` command.
89+
*
90+
* @see {@link https://rstack.rs/config | Rstack configuration guide}
8791
*/
8892
lib: (config: RslibConfigDefinition) => void;
8993
/**
9094
* Defines the Rspress config for documentation.
9195
*
9296
* This config is used by the `rs doc` command.
97+
*
98+
* @see {@link https://rstack.rs/config | Rstack configuration guide}
9399
*/
94100
doc: (config: RspressConfigDefinition) => void;
95101
/**
@@ -100,24 +106,32 @@ type Define = {
100106
* Unless `extends` is set explicitly, Rstest automatically extends `define.app` or
101107
* falls back to `define.lib`. For multi-project configs, this applies to every inline
102108
* project without an explicit `extends`. The app config takes precedence when both are defined.
109+
*
110+
* @see {@link https://rstack.rs/config | Rstack configuration guide}
103111
*/
104112
test: (config: RstestConfigExport) => void;
105113
/**
106114
* Defines the Rslint config for linting.
107115
*
108116
* This config is used by the `rs lint` command.
117+
*
118+
* @see {@link https://rstack.rs/config | Rstack configuration guide}
109119
*/
110120
lint: (config: RslintConfig | (() => Promise<RslintConfig>)) => void;
111121
/**
112122
* Defines the Prettier config for formatting.
113123
*
114124
* This config will be used by the `rs fmt` command.
125+
*
126+
* @see {@link https://rstack.rs/config | Rstack configuration guide}
115127
*/
116128
fmt: (config: FmtConfigDefinition) => void;
117129
/**
118130
* Defines the lint-staged config for staged files.
119131
*
120132
* This config is used by the `rs staged` command.
133+
*
134+
* @see {@link https://rstack.rs/config | Rstack configuration guide}
121135
*/
122136
staged: (config: StagedConfig) => void;
123137
};

pnpm-lock.yaml

Lines changed: 16 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)