Skip to content

completions: build the bunx link and .zshrc paths from raw bytes #46423

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
robobun wants to merge 6 commits into
base: main
Choose a base branch
from
Open

completions: build the bunx link and .zshrc paths from raw bytes #46423

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
dcad561
completions: build the bunx link and .zshrc paths from raw bytes
robobun Oct 21, 2026
1bc0669
Merge remote-tracking branch 'origin/main' into robobun/1a1e7771/comp…
robobun Oct 25, 2026
4c96e90
test: skip the long-target bunx cases where symlink targets are limited
robobun Oct 25, 2026
867e2a6
completions: print the line to add with the same bytes as the .zshrc …
robobun Oct 25, 2026
7e018be
Merge remote-tracking branch 'origin/main' into robobun/1a1e7771/comp…
robobun Oct 29, 2026
25421c8
ci: retrigger
robobun Oct 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 0 additions & 10 deletions src/bun_core/fmt.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -825,16 +825,6 @@ pub fn buf_print_infallible<'a>(buf: &'a mut [u8], args: core::fmt::Arguments<'_
buf_print(buf, args).expect("buf_print: buffer too small")
}

/// [`buf_print_z`] that panics on overflow.
#[inline]
#[track_caller]
pub fn buf_print_z_infallible<'a>(
buf: &'a mut [u8],
args: core::fmt::Arguments<'_>,
) -> &'a crate::ZStr {
buf_print_z(buf, args).expect("buf_print_z: buffer too small")
}

// ════════════════════════════════════════════════════════════════════════════
// VecWriter — `core::fmt::Write` over `&mut Vec<u8>`
// ════════════════════════════════════════════════════════════════════════════
Expand Down
5 changes: 5 additions & 0 deletions src/bun_core/output.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1348,6 +1348,11 @@ pub fn print_bytes(bytes: &[u8]) {
write_bytes(Destination::Stdout, bytes);
}

/// Bytes to stderr exactly as given (no UTF-8 replacement), through the same writer `print_error` uses.
pub fn print_error_bytes(bytes: &[u8]) {
write_bytes(Destination::Stderr, bytes);
}

/// `bun.Output.println(fmt, args)` — `print()` with a trailing newline.
#[inline]
pub fn println(args: fmt::Arguments<'_>) {
Expand Down
101 changes: 53 additions & 48 deletions src/runtime/cli/install_completions_command.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ use bun_core::pretty_errorln;
use bun_core::strings;
use bun_core::{Global, Output, env_var};
#[cfg(not(windows))]
use bun_core::{note, print_errorln};
use bun_core::{note, pretty_error, print_errorln};
#[cfg(not(windows))]
use bun_paths::{platform, resolve_path};
use bun_sys::{self, E, File};
Expand Down Expand Up @@ -35,32 +35,24 @@ impl InstallCompletionsCommand {
return Ok(());
}

// first try installing the symlink into the same directory as the bun executable
let exe = bun_core::self_exe_path()?;
let mut link_buf = bun_paths::path_buffer_pool::get();
let link_path = buf_print_z(
&mut link_buf,
format_args!(
"{}/{}",
bstr::BStr::new(bun_core::dirname(exe).expect("exe has dirname")),
Self::BUNX_NAME
),
);
if bun_sys::symlink(exe, link_path).is_ok() {
return Ok(());
}

for (dir, bin_dir) in [
(env_var::BUN_INSTALL.get(), "bin"),
(env_var::HOME.get(), ".bun/bin"),
(env_var::HOME.get(), ".local/bin"),
// first try installing the symlink into the same directory as the bun executable
(bun_core::dirname(exe), b"/".as_slice()),
(env_var::BUN_INSTALL.get(), b"/bin/".as_slice()),
(env_var::HOME.get(), b"/.bun/bin/".as_slice()),
(env_var::HOME.get(), b"/.local/bin/".as_slice()),
] {
let Some(dir) = dir else { continue };
let link_path = buf_print_z(
&mut link_buf,
format_args!("{}/{}/{}", bstr::BStr::new(dir), bin_dir, Self::BUNX_NAME),
);
if bun_sys::symlink(exe, link_path).is_ok() {
// Formatting the path would replace invalid UTF-8 and name a different directory.
let Ok(link_path) = strings::concat_buf_t::<u8>(
&mut link_buf[..],
&[dir, bin_dir, Self::BUNX_NAME.as_bytes(), b"\0"],
) else {
continue;
};
if bun_sys::symlink(exe, bun_core::ZStr::from_slice_with_nul(link_path)).is_ok() {
return Ok(());
}
}
Expand Down Expand Up @@ -456,12 +448,15 @@ impl InstallCompletionsCommand {
let _ = bun_sys::close(output_dir);

// Check if they need to load the zsh completions file into their .zshrc
if shell == Shell::Zsh {
let mut completions_path_buf = bun_paths::path_buffer_pool::get();
let completions_path: &[u8] = resolve_path::join_string_buf::<platform::Auto>(
&mut completions_path_buf,
// No shell can open a path that does not fit, so such a path gets no line.
if shell == Shell::Zsh
&& let mut completions_path_buf = bun_paths::path_buffer_pool::get()
&& let Some(completions_path) = resolve_path::join_z_buf_checked::<platform::Auto>(
&mut completions_path_buf[..],
&[completions_dir, filename],
);
)
{
let completions_path: &[u8] = completions_path.as_bytes();
let mut zshrc_filepath = bun_paths::path_buffer_pool::get();
let needs_to_tell_them_to_add_completions_file: bool = 'brk: {
let dot_zshrc: File = 'zshrc: {
Expand All @@ -472,12 +467,14 @@ impl InstallCompletionsCommand {
(env_var::HOME.get(), b"/.zshenv".as_slice()),
] {
let Some(dir) = dir else { continue };
let len = dir.len() + name.len();
zshrc_filepath[..dir.len()].copy_from_slice(dir);
zshrc_filepath[dir.len()..len].copy_from_slice(name);
zshrc_filepath[len] = 0;
let Ok(path) = strings::concat_buf_t::<u8>(
&mut zshrc_filepath[..],
&[dir, name, b"\0"],
) else {
continue;
};
if let Ok(f) = bun_sys::open_file_absolute_z(
bun_core::ZStr::from_buf(&zshrc_filepath[..], len),
bun_core::ZStr::from_slice_with_nul(path),
bun_sys::OpenFlags::READ_WRITE,
) {
break 'zshrc f;
Expand Down Expand Up @@ -512,14 +509,19 @@ impl InstallCompletionsCommand {
// Okay, we need to add it

// We need to add it to the end of the file
let remaining = &mut buf[read..];
let extra = buf_print(
remaining,
format_args!(
"\n# bun completions\n[ -s \"{0}\" ] && source \"{0}\"\n",
bstr::BStr::new(completions_path)
),
);
// Without room for the line, the file is longer than fstat said.
let Ok(extra) = strings::concat_buf_t::<u8>(
&mut buf[read..],
&[
b"\n# bun completions\n[ -s \"",
completions_path,
b"\" ] && source \"",
completions_path,
b"\"\n",
],
) else {
break 'brk true;
};

if dot_zshrc
.pwrite_all(extra, i64::try_from(read).expect("int cast"))
Expand All @@ -533,11 +535,17 @@ impl InstallCompletionsCommand {
};

if needs_to_tell_them_to_add_completions_file {
pretty_errorln!(
"<r>To enable completions, add this to your .zshrc:\n <b>[ -s \"{}\" ] && source \"{}\"",
bstr::BStr::new(completions_path),
bstr::BStr::new(completions_path),
);
pretty_error!("<r>To enable completions, add this to your .zshrc:\n <b>");
// Same bytes as the .zshrc line above: a pasted copy is found again.
for part in [
b"[ -s \"".as_slice(),
completions_path,
b"\" ] && source \"",
completions_path,
b"\"\n",
] {
Output::print_error_bytes(part);
}
}
}

Expand All @@ -551,6 +559,3 @@ impl InstallCompletionsCommand {
}
}
}

#[cfg(not(windows))]
use bun_core::fmt::{buf_print_infallible as buf_print, buf_print_z_infallible as buf_print_z};
Loading
Loading