Skip to content

hookscripts.md

Latest commit

 

History

History
48 lines (33 loc) · 3.58 KB

hookscripts.md

File metadata and controls

48 lines (33 loc) · 3.58 KB
Raw

Hookscripts

POSIX-like platforms will automatically install required dependencies thanks to the hookscripts in .chezmoiscripts/00-macos/ and .chezmoiscripts/00-linux/ (plus 01-fedora/ and 02-bluefin/ layers on Linux).

Similarly NT platforms use the hookscripts in .chezmoiscripts/00-nt/ for dependency installation.

Every POSIX hookscript opens with one of two shared preambles from .chezmoitemplates/:

  • posix-preamble.sh -- platform guards, lazy can_sudo/require_sudo, load_brew (loads brew if present, sets HAS_BREW), and MANAGER. For scripts that merely prefer brew and have a fallback.
  • posix-preamble-brew.sh -- the above plus require_brew, the brew counterpart of require_sudo: fails fast if brew is missing and guarantees $HOMEBREW_PREFIX is set. For scripts whose whole job is brew work (package lists, casks, taps, anything that reads $HOMEBREW_PREFIX).

On macOS, 003-macos-prereqs runs first and installs the Apple-shipped prerequisites on every Mac: the Xcode Command Line Tools through softwareupdate, non-interactively (Apple's own xcode-select --install prompt only as the fallback), and Rosetta 2 on Apple Silicon. So both are in place before brew, MacPorts or any source build. 015-brew-taps then adds the third-party brew taps; everything installed from them is written as user/repo/name. Brew itself is installed by 005-homebrew on both platforms, from .chezmoitemplates/homebrew-install.sh, before anything that needs it. It is a run_after_, so a host whose brew was removed gets it back on the next apply.

The brew prefix is decided once, at chezmoi init, as .homebrewPrefix (/opt/homebrew on Apple Silicon, /usr/local on Intel, /home/linuxbrew/.linuxbrew on Linux) and rendered into every static file that has to name a brew binary: tmux, gpg-agent, the Touch ID PAM lines, the Chrome gpgme manifest, .bootstrap.sh. Hookscripts get the same answer at runtime from brew shellenv. After pulling a version of this repo that introduced .homebrewPrefix or .macos.series, run chezmoi init once -- .chezmoi.toml.tmpl is only re-rendered by init, and templates reference both keys.

Packages: winget/scoop/apt/pkg/brew/pnpm/uv/whatever

Remember to define the package in the correct hookscript under .chezmoiscripts/00-macos/, .chezmoiscripts/00-linux/ or .chezmoiscripts/00-nt/.

Running one script

Scripts can be applied individually, addressed by their stripped target name, which is useful when bringing up a new host in stages:

chezmoi apply ~/.chezmoiscripts/00-macos/005-homebrew.sh

C/C++ language support

Vim installs coc-clangd from dot_coc-extensions.txt through the plugin bootstrap. Neovim enables clangd through its native LSP client and nvim-lspconfig. Both use the clangd executable on PATH.

Host Provisioned package
Windows Scoop clangd
Ubuntu/Debian apt clangd
Fedora dnf clang-tools-extra
Bluefin Homebrew llvm
macOS Homebrew llvm; .commonprofile appends its keg-only bin directory to PATH

CoC also needs Node.js, which is already provisioned on every supported host. clangd provides completion, diagnostics, navigation, and formatting; a separate clang-format executable is not required for LSP formatting. Building code still requires the project's compiler and SDK/headers. For project-aware analysis, generate compile_commands.json (for example, configure CMake with -DCMAKE_EXPORT_COMPILE_COMMANDS=ON using Ninja or Makefiles). For a small project, compile_flags.txt can supply include paths and compiler flags instead.