aboutsummaryrefslogtreecommitdiff
path: root/mingling_core/src/build/comp.rs
diff options
context:
space:
mode:
author魏曹先生 <1992414357@qq.com>2026-08-17 19:21:52 +0800
committer魏曹先生 <1992414357@qq.com>2026-08-17 19:21:52 +0800
commit89bf57f33a9f0f5a96fc50e272c83d926fa35c4a (patch)
treecc5a72e850bdd9215b60dc1655f162e22ee97d12 /mingling_core/src/build/comp.rs
parent40bb7ffd6954184fac718c8f99c9cdc3e054e4eb (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 'mingling_core/src/build/comp.rs')
-rw-r--r--mingling_core/src/build/comp.rs183
1 files changed, 0 insertions, 183 deletions
diff --git a/mingling_core/src/build/comp.rs b/mingling_core/src/build/comp.rs
deleted file mode 100644
index d6bb34f..0000000
--- a/mingling_core/src/build/comp.rs
+++ /dev/null
@@ -1,183 +0,0 @@
-use std::path::PathBuf;
-
-use just_template::tmpl;
-
-use crate::ShellFlag;
-
-const TMPL_COMP_BASH: &str = include_str!("../../tmpls/comps/bash.sh");
-const TMPL_COMP_ZSH: &str = include_str!("../../tmpls/comps/zsh.zsh");
-const TMPL_COMP_FISH: &str = include_str!("../../tmpls/comps/fish.fish");
-const TMPL_COMP_PWSH: &str = include_str!("../../tmpls/comps/pwsh.ps1");
-
-/// Generate shell completion scripts for a given binary name.
-///
-/// On Windows, generates `PowerShell` completion.
-/// On Linux, generates Zsh, Bash, and Fish completions.
-/// Scripts are written to the `OUT_DIR` (or `target/` if `OUT_DIR` is not set).
-///
-/// # Example
-/// ```
-/// # #[cfg(all(feature = "build", feature = "comp"))] {
-/// # temp_env::with_var("OUT_DIR", Some(".temp/target/test/out/"), || {
-/// # use mingling_core::ShellFlag;
-/// # use mingling_core::build::build_comp_scripts;
-/// // Generate completion scripts for "myapp"
-/// build_comp_scripts("myapp").unwrap();
-///
-/// // Generate completion scripts for current package
-/// build_comp_scripts(env!("CARGO_PKG_NAME")).unwrap();
-/// # });
-/// # }
-/// ```
-pub fn build_comp_scripts(name: &str) -> Result<(), std::io::Error> {
- #[cfg(target_os = "windows")]
- {
- build_comp_script(&ShellFlag::Powershell, name)?;
- Ok(())
- }
-
- #[cfg(target_os = "linux")]
- {
- build_comp_script(&ShellFlag::Zsh, name)?;
- build_comp_script(&ShellFlag::Bash, name)?;
- build_comp_script(&ShellFlag::Fish, name)?;
- Ok(())
- }
-
- #[cfg(target_os = "macos")]
- {
- build_comp_script(&ShellFlag::Zsh, name)?;
- build_comp_script(&ShellFlag::Bash, name)?;
- build_comp_script(&ShellFlag::Fish, name)?;
- Ok(())
- }
-}
-
-/// Generate a shell completion script for a specific shell.
-///
-/// This function takes a shell flag and a binary name, selects the appropriate
-/// template, substitutes the binary name into the template, and writes the
-/// resulting completion script to the target directory (typically `target/`).
-///
-/// # Example
-/// ```
-/// # #[cfg(all(feature = "build", feature = "comp"))] {
-/// # temp_env::with_var("OUT_DIR", Some(".temp/target/test/out/"), || {
-/// # use mingling_core::ShellFlag;
-/// # use mingling_core::build::build_comp_script;
-/// build_comp_script(&ShellFlag::Bash, "myapp").unwrap();
-/// # });
-/// # }
-/// ```
-pub fn build_comp_script(shell_flag: &ShellFlag, bin_name: &str) -> Result<(), std::io::Error> {
- let out_dir = std::path::PathBuf::from(std::env::var("OUT_DIR").unwrap());
- let target_dir = out_dir.join("../../../");
- build_comp_script_to(shell_flag, bin_name, &target_dir.to_string_lossy())
-}
-
-/// Generate a shell completion script to a specified directory.
-///
-/// This function takes a shell flag, a binary name, and a target directory path,
-/// selects the appropriate template, substitutes the binary name into the template,
-/// and writes the resulting completion script to the specified directory.
-///
-/// # Example
-/// ```
-/// # #[cfg(all(feature = "build", feature = "comp"))] {
-/// # temp_env::with_var("OUT_DIR", Some(".temp/target/test/out/"), || {
-/// # use mingling_core::ShellFlag;
-/// # use mingling_core::build::build_comp_script_to;
-/// build_comp_script_to(&ShellFlag::Bash, "myapp", ".temp/target/test/out/").unwrap();
-/// # });
-/// # }
-/// ```
-pub fn build_comp_script_to(
- shell_flag: &ShellFlag,
- bin_name: &str,
- target_dir: &str,
-) -> Result<(), std::io::Error> {
- let (tmpl_str, ext) = get_tmpl(shell_flag);
- let mut tmpl = just_template::Template::from(tmpl_str);
- tmpl!(bin_name = bin_name);
- let target_path = std::path::PathBuf::from(target_dir);
- std::fs::create_dir_all(&target_path)?;
- let output_path = target_path.join(format!("{bin_name}_comp{ext}"));
- std::fs::write(&output_path, tmpl.to_string())
-}
-
-/// Generate a shell completion script and write it to a specified file path.
-///
-/// This function takes a shell flag, a binary name, and an output file path,
-/// selects the appropriate template, substitutes the binary name into the template,
-/// and writes the resulting completion script directly to the specified file path.
-///
-/// # Example
-/// ```
-/// # #[cfg(all(feature = "build", feature = "comp"))] {
-/// # temp_env::with_var("OUT_DIR", Some(".temp/target/test/out/"), || {
-/// # use mingling_core::ShellFlag;
-/// # use mingling_core::build::build_comp_script_to_file;
-/// build_comp_script_to_file(&ShellFlag::Bash, "myapp", ".temp/target/test/out/myapp.comp.sh").unwrap();
-/// # });
-/// # }
-/// ```
-pub fn build_comp_script_to_file(
- shell_flag: &ShellFlag,
- bin_name: &str,
- output_path: impl Into<PathBuf>,
-) -> Result<(), std::io::Error> {
- let (tmpl_str, _ext) = get_tmpl(shell_flag);
- let mut tmpl = just_template::Template::from(tmpl_str);
- tmpl!(bin_name = bin_name);
- std::fs::write(output_path.into(), tmpl.to_string())
-}
-
-const fn get_tmpl(shell_flag: &ShellFlag) -> (&'static str, &'static str) {
- match shell_flag {
- ShellFlag::Bash | ShellFlag::Other(_) => (TMPL_COMP_BASH, ".sh"),
- ShellFlag::Zsh => (TMPL_COMP_ZSH, ".zsh"),
- ShellFlag::Fish => (TMPL_COMP_FISH, ".fish"),
- ShellFlag::Powershell => (TMPL_COMP_PWSH, ".ps1"),
- }
-}
-
-#[cfg(test)]
-mod tests {
- use super::*;
- use crate::ShellFlag;
-
- #[test]
- fn get_tmpl_bash() {
- let (tmpl, ext) = get_tmpl(&ShellFlag::Bash);
- assert_eq!(ext, ".sh");
- assert!(!tmpl.is_empty(), "bash template should not be empty");
- }
-
- #[test]
- fn get_tmpl_zsh() {
- let (tmpl, ext) = get_tmpl(&ShellFlag::Zsh);
- assert_eq!(ext, ".zsh");
- assert!(!tmpl.is_empty(), "zsh template should not be empty");
- }
-
- #[test]
- fn get_tmpl_fish() {
- let (tmpl, ext) = get_tmpl(&ShellFlag::Fish);
- assert_eq!(ext, ".fish");
- assert!(!tmpl.is_empty(), "fish template should not be empty");
- }
-
- #[test]
- fn get_tmpl_powershell() {
- let (tmpl, ext) = get_tmpl(&ShellFlag::Powershell);
- assert_eq!(ext, ".ps1");
- assert!(!tmpl.is_empty(), "powershell template should not be empty");
- }
-
- #[test]
- fn get_tmpl_other() {
- let (tmpl, ext) = get_tmpl(&ShellFlag::Other("custom".to_string()));
- assert_eq!(ext, ".sh");
- assert!(!tmpl.is_empty(), "fallback template should not be empty");
- }
-}