diff --git a/.agents/skills/migrate-to-rstack-cli/SKILL.md b/.agents/skills/migrate-to-rstack-cli/SKILL.md index 06d61983..992cf06c 100644 --- a/.agents/skills/migrate-to-rstack-cli/SKILL.md +++ b/.agents/skills/migrate-to-rstack-cli/SKILL.md @@ -41,7 +41,7 @@ Use one of the default names: `rstack.config.ts`, `.js`, `.mts`, or `.mjs`. Use `rs -c ` or `rs --config ` only for a custom path. ```ts -// Rstack configuration guide: https://rstack.rs/config +// Configuration guide: https://rstack.rs/config import { define } from 'rstack'; define.app({ diff --git a/examples/app-react/rstack.config.ts b/examples/app-react/rstack.config.ts index 960e215b..d6c4a461 100644 --- a/examples/app-react/rstack.config.ts +++ b/examples/app-react/rstack.config.ts @@ -1,4 +1,4 @@ -// Rstack configuration guide: https://rstack.rs/config +// Configuration guide: https://rstack.rs/config import { define } from 'rstack'; define.app(async () => { diff --git a/examples/app-vanilla/rstack.config.ts b/examples/app-vanilla/rstack.config.ts index 9707fbda..6e3bb9a8 100644 --- a/examples/app-vanilla/rstack.config.ts +++ b/examples/app-vanilla/rstack.config.ts @@ -1,4 +1,4 @@ -// Rstack configuration guide: https://rstack.rs/config +// Configuration guide: https://rstack.rs/config import { define } from 'rstack'; define.test({ diff --git a/examples/documentation/rstack.config.ts b/examples/documentation/rstack.config.ts index 10c5a9ad..8d99518f 100644 --- a/examples/documentation/rstack.config.ts +++ b/examples/documentation/rstack.config.ts @@ -1,4 +1,4 @@ -// Rstack configuration guide: https://rstack.rs/config +// Configuration guide: https://rstack.rs/config import { define } from 'rstack'; import path from 'node:path'; diff --git a/examples/lib-node/rstack.config.ts b/examples/lib-node/rstack.config.ts index ed274a80..104652eb 100644 --- a/examples/lib-node/rstack.config.ts +++ b/examples/lib-node/rstack.config.ts @@ -1,4 +1,4 @@ -// Rstack configuration guide: https://rstack.rs/config +// Configuration guide: https://rstack.rs/config import { define } from 'rstack'; define.lib({ diff --git a/examples/lib-react/rstack.config.ts b/examples/lib-react/rstack.config.ts index fd97fdae..ec8669f4 100644 --- a/examples/lib-react/rstack.config.ts +++ b/examples/lib-react/rstack.config.ts @@ -1,4 +1,4 @@ -// Rstack configuration guide: https://rstack.rs/config +// Configuration guide: https://rstack.rs/config import { define } from 'rstack'; define.lib(async () => { diff --git a/examples/test-inline-projects/rstack.config.ts b/examples/test-inline-projects/rstack.config.ts index 12fa4e57..55383b03 100644 --- a/examples/test-inline-projects/rstack.config.ts +++ b/examples/test-inline-projects/rstack.config.ts @@ -1,4 +1,4 @@ -// Rstack configuration guide: https://rstack.rs/config +// Configuration guide: https://rstack.rs/config import { define } from 'rstack'; define.app(async () => { diff --git a/packages/create-rstack/rstack.config.ts b/packages/create-rstack/rstack.config.ts index 923fc17d..7daaf593 100644 --- a/packages/create-rstack/rstack.config.ts +++ b/packages/create-rstack/rstack.config.ts @@ -1,4 +1,4 @@ -// Rstack configuration guide: https://rstack.rs/config +// Configuration guide: https://rstack.rs/config import { define } from 'rstack'; define.lib({ diff --git a/packages/create-rstack/template-app-lit-ts/rstack.config.ts b/packages/create-rstack/template-app-lit-ts/rstack.config.ts index d7f664c7..434eac7d 100644 --- a/packages/create-rstack/template-app-lit-ts/rstack.config.ts +++ b/packages/create-rstack/template-app-lit-ts/rstack.config.ts @@ -1,4 +1,4 @@ -// Rstack configuration guide: https://rstack.rs/config +// Configuration guide: https://rstack.rs/config import { define } from 'rstack'; define.app({ diff --git a/packages/create-rstack/template-app-lit/rstack.config.js b/packages/create-rstack/template-app-lit/rstack.config.js index 4a74583c..e5a6fd11 100644 --- a/packages/create-rstack/template-app-lit/rstack.config.js +++ b/packages/create-rstack/template-app-lit/rstack.config.js @@ -1,5 +1,5 @@ // @ts-check -// Rstack configuration guide: https://rstack.rs/config +// Configuration guide: https://rstack.rs/config import { define } from 'rstack'; define.app({ diff --git a/packages/create-rstack/template-app-preact-ts/rstack.config.ts b/packages/create-rstack/template-app-preact-ts/rstack.config.ts index e1ec7e4d..9fdeba76 100644 --- a/packages/create-rstack/template-app-preact-ts/rstack.config.ts +++ b/packages/create-rstack/template-app-preact-ts/rstack.config.ts @@ -1,4 +1,4 @@ -// Rstack configuration guide: https://rstack.rs/config +// Configuration guide: https://rstack.rs/config import { define } from 'rstack'; define.app(async () => { diff --git a/packages/create-rstack/template-app-preact/rstack.config.js b/packages/create-rstack/template-app-preact/rstack.config.js index 0c586e57..912d57af 100644 --- a/packages/create-rstack/template-app-preact/rstack.config.js +++ b/packages/create-rstack/template-app-preact/rstack.config.js @@ -1,5 +1,5 @@ // @ts-check -// Rstack configuration guide: https://rstack.rs/config +// Configuration guide: https://rstack.rs/config import { define } from 'rstack'; define.app(async () => { diff --git a/packages/create-rstack/template-app-react-ts/rstack.config.ts b/packages/create-rstack/template-app-react-ts/rstack.config.ts index b6214713..cb508e42 100644 --- a/packages/create-rstack/template-app-react-ts/rstack.config.ts +++ b/packages/create-rstack/template-app-react-ts/rstack.config.ts @@ -1,4 +1,4 @@ -// Rstack configuration guide: https://rstack.rs/config +// Configuration guide: https://rstack.rs/config import { define } from 'rstack'; define.app(async () => { diff --git a/packages/create-rstack/template-app-react/rstack.config.js b/packages/create-rstack/template-app-react/rstack.config.js index e01ac564..886b005a 100644 --- a/packages/create-rstack/template-app-react/rstack.config.js +++ b/packages/create-rstack/template-app-react/rstack.config.js @@ -1,5 +1,5 @@ // @ts-check -// Rstack configuration guide: https://rstack.rs/config +// Configuration guide: https://rstack.rs/config import { define } from 'rstack'; define.app(async () => { diff --git a/packages/create-rstack/template-app-solid-ts/rstack.config.ts b/packages/create-rstack/template-app-solid-ts/rstack.config.ts index 17f42c04..d364bf54 100644 --- a/packages/create-rstack/template-app-solid-ts/rstack.config.ts +++ b/packages/create-rstack/template-app-solid-ts/rstack.config.ts @@ -1,4 +1,4 @@ -// Rstack configuration guide: https://rstack.rs/config +// Configuration guide: https://rstack.rs/config import { define } from 'rstack'; define.app(async () => { diff --git a/packages/create-rstack/template-app-solid/rstack.config.js b/packages/create-rstack/template-app-solid/rstack.config.js index 035c1408..da3845a4 100644 --- a/packages/create-rstack/template-app-solid/rstack.config.js +++ b/packages/create-rstack/template-app-solid/rstack.config.js @@ -1,5 +1,5 @@ // @ts-check -// Rstack configuration guide: https://rstack.rs/config +// Configuration guide: https://rstack.rs/config import { define } from 'rstack'; define.app(async () => { diff --git a/packages/create-rstack/template-app-svelte-ts/rstack.config.ts b/packages/create-rstack/template-app-svelte-ts/rstack.config.ts index aaf917a8..f2dec78f 100644 --- a/packages/create-rstack/template-app-svelte-ts/rstack.config.ts +++ b/packages/create-rstack/template-app-svelte-ts/rstack.config.ts @@ -1,4 +1,4 @@ -// Rstack configuration guide: https://rstack.rs/config +// Configuration guide: https://rstack.rs/config import { define } from 'rstack'; define.app(async () => { diff --git a/packages/create-rstack/template-app-svelte/rstack.config.js b/packages/create-rstack/template-app-svelte/rstack.config.js index a1efbfc7..0fb4fac1 100644 --- a/packages/create-rstack/template-app-svelte/rstack.config.js +++ b/packages/create-rstack/template-app-svelte/rstack.config.js @@ -1,5 +1,5 @@ // @ts-check -// Rstack configuration guide: https://rstack.rs/config +// Configuration guide: https://rstack.rs/config import { define } from 'rstack'; define.app(async () => { diff --git a/packages/create-rstack/template-app-vanilla-ts/rstack.config.ts b/packages/create-rstack/template-app-vanilla-ts/rstack.config.ts index 6e755422..dfe1edc1 100644 --- a/packages/create-rstack/template-app-vanilla-ts/rstack.config.ts +++ b/packages/create-rstack/template-app-vanilla-ts/rstack.config.ts @@ -1,4 +1,4 @@ -// Rstack configuration guide: https://rstack.rs/config +// Configuration guide: https://rstack.rs/config import { define } from 'rstack'; define.app({ diff --git a/packages/create-rstack/template-app-vanilla/rstack.config.js b/packages/create-rstack/template-app-vanilla/rstack.config.js index a9f27d77..cf825efc 100644 --- a/packages/create-rstack/template-app-vanilla/rstack.config.js +++ b/packages/create-rstack/template-app-vanilla/rstack.config.js @@ -1,5 +1,5 @@ // @ts-check -// Rstack configuration guide: https://rstack.rs/config +// Configuration guide: https://rstack.rs/config import { define } from 'rstack'; define.app({ diff --git a/packages/create-rstack/template-app-vue-ts/rstack.config.ts b/packages/create-rstack/template-app-vue-ts/rstack.config.ts index 97e764c0..0c8fe28e 100644 --- a/packages/create-rstack/template-app-vue-ts/rstack.config.ts +++ b/packages/create-rstack/template-app-vue-ts/rstack.config.ts @@ -1,4 +1,4 @@ -// Rstack configuration guide: https://rstack.rs/config +// Configuration guide: https://rstack.rs/config import { define } from 'rstack'; define.app(async () => { diff --git a/packages/create-rstack/template-app-vue/rstack.config.js b/packages/create-rstack/template-app-vue/rstack.config.js index 8116b0df..1cf8b2e1 100644 --- a/packages/create-rstack/template-app-vue/rstack.config.js +++ b/packages/create-rstack/template-app-vue/rstack.config.js @@ -1,5 +1,5 @@ // @ts-check -// Rstack configuration guide: https://rstack.rs/config +// Configuration guide: https://rstack.rs/config import { define } from 'rstack'; define.app(async () => { diff --git a/packages/create-rstack/template-doc-i18n/rstack.config.ts b/packages/create-rstack/template-doc-i18n/rstack.config.ts index e3185a0d..87a0190d 100644 --- a/packages/create-rstack/template-doc-i18n/rstack.config.ts +++ b/packages/create-rstack/template-doc-i18n/rstack.config.ts @@ -1,4 +1,4 @@ -// Rstack configuration guide: https://rstack.rs/config +// Configuration guide: https://rstack.rs/config import path from 'node:path'; import { define } from 'rstack'; diff --git a/packages/create-rstack/template-doc/rstack.config.ts b/packages/create-rstack/template-doc/rstack.config.ts index 99bf9d0d..4a65ede6 100644 --- a/packages/create-rstack/template-doc/rstack.config.ts +++ b/packages/create-rstack/template-doc/rstack.config.ts @@ -1,4 +1,4 @@ -// Rstack configuration guide: https://rstack.rs/config +// Configuration guide: https://rstack.rs/config import path from 'node:path'; import { define } from 'rstack'; diff --git a/packages/create-rstack/template-lib-node-ts/rstack.config.ts b/packages/create-rstack/template-lib-node-ts/rstack.config.ts index 76a7cb35..09769776 100644 --- a/packages/create-rstack/template-lib-node-ts/rstack.config.ts +++ b/packages/create-rstack/template-lib-node-ts/rstack.config.ts @@ -1,4 +1,4 @@ -// Rstack configuration guide: https://rstack.rs/config +// Configuration guide: https://rstack.rs/config import { define } from 'rstack'; define.lib({ diff --git a/packages/create-rstack/template-lib-node/rstack.config.js b/packages/create-rstack/template-lib-node/rstack.config.js index 047c2d6c..6080e25d 100644 --- a/packages/create-rstack/template-lib-node/rstack.config.js +++ b/packages/create-rstack/template-lib-node/rstack.config.js @@ -1,5 +1,5 @@ // @ts-check -// Rstack configuration guide: https://rstack.rs/config +// Configuration guide: https://rstack.rs/config import { define } from 'rstack'; define.lib({ diff --git a/packages/create-rstack/template-lib-react-ts/rstack.config.ts b/packages/create-rstack/template-lib-react-ts/rstack.config.ts index 8c91acb5..1aeb4946 100644 --- a/packages/create-rstack/template-lib-react-ts/rstack.config.ts +++ b/packages/create-rstack/template-lib-react-ts/rstack.config.ts @@ -1,4 +1,4 @@ -// Rstack configuration guide: https://rstack.rs/config +// Configuration guide: https://rstack.rs/config import { define } from 'rstack'; define.lib(async () => { diff --git a/packages/create-rstack/template-lib-react/rstack.config.js b/packages/create-rstack/template-lib-react/rstack.config.js index 12fc5223..76fdfda3 100644 --- a/packages/create-rstack/template-lib-react/rstack.config.js +++ b/packages/create-rstack/template-lib-react/rstack.config.js @@ -1,5 +1,5 @@ // @ts-check -// Rstack configuration guide: https://rstack.rs/config +// Configuration guide: https://rstack.rs/config import { define } from 'rstack'; define.lib(async () => { diff --git a/packages/create-rstack/template-lib-solid-ts/rstack.config.ts b/packages/create-rstack/template-lib-solid-ts/rstack.config.ts index 3fa4dc06..c61c28e5 100644 --- a/packages/create-rstack/template-lib-solid-ts/rstack.config.ts +++ b/packages/create-rstack/template-lib-solid-ts/rstack.config.ts @@ -1,4 +1,4 @@ -// Rstack configuration guide: https://rstack.rs/config +// Configuration guide: https://rstack.rs/config import { define } from 'rstack'; define.lib(async () => { diff --git a/packages/create-rstack/template-lib-solid/rstack.config.js b/packages/create-rstack/template-lib-solid/rstack.config.js index 0e2a8f3e..974cf85d 100644 --- a/packages/create-rstack/template-lib-solid/rstack.config.js +++ b/packages/create-rstack/template-lib-solid/rstack.config.js @@ -1,5 +1,5 @@ // @ts-check -// Rstack configuration guide: https://rstack.rs/config +// Configuration guide: https://rstack.rs/config import { define } from 'rstack'; define.lib(async () => { diff --git a/packages/create-rstack/template-lib-svelte-ts/rstack.config.ts b/packages/create-rstack/template-lib-svelte-ts/rstack.config.ts index b74a4f81..6aeaf38c 100644 --- a/packages/create-rstack/template-lib-svelte-ts/rstack.config.ts +++ b/packages/create-rstack/template-lib-svelte-ts/rstack.config.ts @@ -1,4 +1,4 @@ -// Rstack configuration guide: https://rstack.rs/config +// Configuration guide: https://rstack.rs/config import { define } from 'rstack'; import { svelteDtsPlugin } from './scripts/rslib-plugin-svelte-dts.ts'; diff --git a/packages/create-rstack/template-lib-svelte/rstack.config.js b/packages/create-rstack/template-lib-svelte/rstack.config.js index 4bbb928c..7a952e06 100644 --- a/packages/create-rstack/template-lib-svelte/rstack.config.js +++ b/packages/create-rstack/template-lib-svelte/rstack.config.js @@ -1,5 +1,5 @@ // @ts-check -// Rstack configuration guide: https://rstack.rs/config +// Configuration guide: https://rstack.rs/config import { define } from 'rstack'; define.lib(async () => { diff --git a/packages/create-rstack/template-lib-vue-ts/rstack.config.ts b/packages/create-rstack/template-lib-vue-ts/rstack.config.ts index e441042e..c30a51b2 100644 --- a/packages/create-rstack/template-lib-vue-ts/rstack.config.ts +++ b/packages/create-rstack/template-lib-vue-ts/rstack.config.ts @@ -1,4 +1,4 @@ -// Rstack configuration guide: https://rstack.rs/config +// Configuration guide: https://rstack.rs/config import { define } from 'rstack'; define.lib(async () => { diff --git a/packages/create-rstack/template-lib-vue/rstack.config.js b/packages/create-rstack/template-lib-vue/rstack.config.js index cd42bd0d..42ec7988 100644 --- a/packages/create-rstack/template-lib-vue/rstack.config.js +++ b/packages/create-rstack/template-lib-vue/rstack.config.js @@ -1,5 +1,5 @@ // @ts-check -// Rstack configuration guide: https://rstack.rs/config +// Configuration guide: https://rstack.rs/config import { define } from 'rstack'; define.lib(async () => { diff --git a/packages/rstack/rstack.config.ts b/packages/rstack/rstack.config.ts index 09910407..8abe863e 100644 --- a/packages/rstack/rstack.config.ts +++ b/packages/rstack/rstack.config.ts @@ -1,4 +1,4 @@ -// Rstack configuration guide: https://rstack.rs/config +// Configuration guide: https://rstack.rs/config import { define } from 'rstack'; define.test(async () => { diff --git a/packages/rstack/src/config.ts b/packages/rstack/src/config.ts index 0bf3bc52..222e6ff3 100644 --- a/packages/rstack/src/config.ts +++ b/packages/rstack/src/config.ts @@ -94,7 +94,7 @@ type Define = { * * This config is used by the `rs dev`, `rs build`, and `rs preview` commands. * - * @see {@link https://rstack.rs/config | Rstack configuration guide} + * @see {@link https://rstack.rs/config | Configuration guide} */ app: (config: RsbuildConfigDefinition) => void; /** @@ -102,7 +102,7 @@ type Define = { * * This config is used by the `rs lib` command. * - * @see {@link https://rstack.rs/config | Rstack configuration guide} + * @see {@link https://rstack.rs/config | Configuration guide} */ lib: (config: RslibConfigDefinition) => void; /** @@ -110,7 +110,7 @@ type Define = { * * This config is used by the `rs doc` command. * - * @see {@link https://rstack.rs/config | Rstack configuration guide} + * @see {@link https://rstack.rs/config | Configuration guide} */ doc: (config: RspressConfigDefinition) => void; /** @@ -122,7 +122,7 @@ type Define = { * falls back to `define.lib`. For multi-project configs, this applies to every inline * project without an explicit `extends`. The app config takes precedence when both are defined. * - * @see {@link https://rstack.rs/config | Rstack configuration guide} + * @see {@link https://rstack.rs/config | Configuration guide} */ test: (config: RstestConfigExport) => void; /** @@ -131,7 +131,7 @@ type Define = { * This config is used by the `rs lint` command. * A config factory receives the exports from `rstack/lint`. * - * @see {@link https://rstack.rs/config | Rstack configuration guide} + * @see {@link https://rstack.rs/config | Configuration guide} */ lint: (config: RslintConfig | RslintConfigFactory) => void; /** @@ -139,7 +139,7 @@ type Define = { * * This config will be used by the `rs fmt` command. * - * @see {@link https://rstack.rs/config | Rstack configuration guide} + * @see {@link https://rstack.rs/config | Configuration guide} */ fmt: (config: FmtConfigDefinition) => void; /** @@ -147,7 +147,7 @@ type Define = { * * This config is used by the `rs staged` command. * - * @see {@link https://rstack.rs/config | Rstack configuration guide} + * @see {@link https://rstack.rs/config | Configuration guide} */ staged: (config: StagedConfig) => void; }; diff --git a/rstack.config.ts b/rstack.config.ts index 3e20de09..68b2ef8f 100644 --- a/rstack.config.ts +++ b/rstack.config.ts @@ -1,4 +1,4 @@ -// Rstack configuration guide: https://rstack.rs/config +// Configuration guide: https://rstack.rs/config import { define } from 'rstack'; define.lint(async ({ js, ts }) => { diff --git a/website/docs/en/guide/configuration.mdx b/website/docs/en/guide/configuration.mdx index 9b3d8283..ff057d24 100644 --- a/website/docs/en/guide/configuration.mdx +++ b/website/docs/en/guide/configuration.mdx @@ -9,7 +9,7 @@ Rstack CLI centralizes the configuration for your project's tools in a single fi Create `rstack.config.ts` in the project root and call the relevant `define.*()` APIs: ```ts title="rstack.config.ts" -// Rstack configuration guide: https://rstack.rs/config +// Configuration guide: https://rstack.rs/config import { define } from 'rstack'; define.app({ diff --git a/website/docs/en/guide/quick-start.mdx b/website/docs/en/guide/quick-start.mdx index 902be45d..ec64840d 100644 --- a/website/docs/en/guide/quick-start.mdx +++ b/website/docs/en/guide/quick-start.mdx @@ -156,7 +156,7 @@ The following commands are available: Create `rstack.config.ts` in the project root and register the configurations your project needs. The following is a minimal example for an application with testing and linting: ```ts title="rstack.config.ts" -// Rstack configuration guide: https://rstack.rs/config +// Configuration guide: https://rstack.rs/config import { define } from 'rstack'; define.app({ diff --git a/website/docs/zh/guide/configuration.mdx b/website/docs/zh/guide/configuration.mdx index dc3d8fde..5f15b77b 100644 --- a/website/docs/zh/guide/configuration.mdx +++ b/website/docs/zh/guide/configuration.mdx @@ -9,7 +9,7 @@ Rstack CLI 将项目所用工具的配置集中到一份文件中。通过 `defi 在项目根目录创建 `rstack.config.ts`,并调用对应的 `define.*()` API: ```ts title="rstack.config.ts" -// Rstack configuration guide: https://rstack.rs/config +// Configuration guide: https://rstack.rs/config import { define } from 'rstack'; define.app({ diff --git a/website/docs/zh/guide/quick-start.mdx b/website/docs/zh/guide/quick-start.mdx index aa7352a7..4cc43cca 100644 --- a/website/docs/zh/guide/quick-start.mdx +++ b/website/docs/zh/guide/quick-start.mdx @@ -156,7 +156,7 @@ Rstack CLI 提供以下命令: 在项目根目录创建 `rstack.config.ts`,并注册项目所需的配置。以下是一个包含应用、测试和代码检查的最小示例: ```ts title="rstack.config.ts" -// Rstack configuration guide: https://rstack.rs/config +// Configuration guide: https://rstack.rs/config import { define } from 'rstack'; define.app({ diff --git a/website/rstack.config.ts b/website/rstack.config.ts index aa78c750..8e1fd234 100644 --- a/website/rstack.config.ts +++ b/website/rstack.config.ts @@ -1,4 +1,4 @@ -// Rstack configuration guide: https://rstack.rs/config +// Configuration guide: https://rstack.rs/config import path from 'node:path'; import { define } from 'rstack';