diff options
| author | 魏曹先生 <1992414357@qq.com> | 2026-08-17 19:21:52 +0800 |
|---|---|---|
| committer | 魏曹先生 <1992414357@qq.com> | 2026-08-17 19:21:52 +0800 |
| commit | 89bf57f33a9f0f5a96fc50e272c83d926fa35c4a (patch) | |
| tree | cc5a72e850bdd9215b60dc1655f162e22ee97d12 /GETTING-STARTED.md | |
| parent | 40bb7ffd6954184fac718c8f99c9cdc3e054e4eb (diff) | |
refactor!: replace build.rs with compile-time macro build steps
BREAKING CHANGE: Replace the `build`/`builds` feature system with
compile-time macro-driven generation. `gen_program!()` now automatically
invokes `build_comp!()` and `build_pathf!()` when the `comp`/`pathf`
features are enabled, eliminating the need for `build.rs` and
`[build-dependencies]` blocks.
This removes the `build` feature, the `mingling::build` module, and all
related build-time API functions. Completion scripts are now written to
`{target_directory}/mingling/` instead of `target/release/`. The
`mingling_cli` uses `build_comp!("mling")` for its custom binary name.
Diffstat (limited to 'GETTING-STARTED.md')
| -rw-r--r-- | GETTING-STARTED.md | 10 |
1 files changed, 3 insertions, 7 deletions
diff --git a/GETTING-STARTED.md b/GETTING-STARTED.md index 020e098..e4a706a 100644 --- a/GETTING-STARTED.md +++ b/GETTING-STARTED.md @@ -234,13 +234,9 @@ fn main() { } ``` -In your `build.rs`, generate the shell scripts: - -```rust -// BUILD TIME -// Features: ["comp", "build"] -mingling::build::build_comp_scripts(env!("CARGO_PKG_NAME")).unwrap(); -``` +The completion scripts are generated automatically: with the `comp` feature enabled, +`gen_program!()` invokes `build_comp!()` at compile time and writes the shell scripts +(named after `CARGO_PKG_NAME`) into `target/mingling/`. For enum-based completions, use `suggest_enum!`: |
