julien
72e1182308
## Summary Follow-up on [#220](#220). [`80-dotfiles.sh`](docs/setup/scripts/80-dotfiles.sh) was reading `notes/aliases.zsh` and `notes/gitconfig.txt` — but `notes/` is the project lead's personal scratchpad and is gitignored, so a fresh clone on the dev VM has nothing to read: ``` ✗ /home/APF/dev-jugautier/Works/apf_portal/notes/aliases.zsh not found. ``` Move both templates to a versioned location and update the script + docs to match. ## What lands | File | Change | | --- | --- | | `docs/setup/dotfiles/aliases.zsh` | **New.** Project-wide zsh aliases (navigation / files / search / git / dev), previously living in `notes/aliases.zsh`. Header explains scope (project-wide, all devs pick it up on next zsh restart) and where per-dev customizations go (private dotfiles repo). | | `docs/setup/dotfiles/gitconfig.txt` | **New.** Base `~/.gitconfig` template — init / core / aliases / colour. `[user]` block carries placeholder identity (`name = your name` / `email = your.email@example.com`) that the script overwrites at install via `git config --global user.{name,email}`. | | `docs/setup/scripts/80-dotfiles.sh` | Source paths flipped from `$REPO_ROOT/notes/…` to `$REPO_ROOT/docs/setup/dotfiles/…`. Header doc-comment updated. | | `docs/setup/01-dev-debian-vm-setup.md` | Step-3 table row and §8.4 (dotfiles repo) reference the new path. The §8.4 wording is also tightened — the script no longer "falls back" anywhere, it has one source of truth. | | `docs/setup/README.md` | New `dotfiles/` section in the folder index. Step-7 row in the scripts table also reflects the new paths. | ## Why this lives in `docs/setup/dotfiles/` and not `infra/` or a top-level `dotfiles/` - The directory is **consumed exclusively by [`80-dotfiles.sh`](docs/setup/scripts/80-dotfiles.sh)** — co-locating it under `docs/setup/` keeps the setup family self-contained (one folder to read, one folder to clone). - The name `dotfiles/` reads correctly for a future per-dev dotfiles repo migration (§8.4) — the templates here become the seed of that repo, and the install script will then check `~/.dotfiles/` first and fall back to `docs/setup/dotfiles/` second. ## Unblock path (if you're stuck mid-bootstrap) Either pull this PR, or manually create the two files at the **new** location on the VM: ```bash mkdir -p ~/Works/apf_portal/docs/setup/dotfiles # paste the aliases.zsh + gitconfig.txt content there ./docs/setup/scripts/80-dotfiles.sh ``` ## Test plan - [ ] On a fresh Trixie VM, `./docs/setup/scripts/80-dotfiles.sh` succeeds: aliases.zsh symlink lands at `~/.oh-my-zsh/custom/aliases.zsh` pointing at `docs/setup/dotfiles/aliases.zsh`, `~/.gitconfig` written with the prompted identity. - [ ] Re-running the script reports `↪ skip aliases.zsh symlink already correct` (idempotency). - [ ] `git config --global user.name` returns the prompted value (i.e. placeholder `your name` is overwritten). - [x] `pnpm exec prettier --check` clean on the touched files. - [x] `bash -n docs/setup/scripts/80-dotfiles.sh` clean. ## Notes - `notes/aliases.zsh` and `notes/gitconfig.txt` on existing dev workstations are unaffected — those files live outside the repo (gitignored), nothing here touches them. They can be deleted or kept as personal scratch at the dev's discretion. - A future PR creates the **private dotfiles repo** (`apf/dotfiles`) and teaches `80-dotfiles.sh` to prefer `~/.dotfiles/` over `docs/setup/dotfiles/` when both exist. --------- Co-authored-by: Julien Gautier <julien.gautier@apf.asso.fr> Reviewed-on: #224
81 lines
3.0 KiB
Bash
Executable File
81 lines
3.0 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
# Wire up the project-wide dotfiles:
|
|
# - symlink docs/setup/dotfiles/aliases.zsh → ~/.oh-my-zsh/custom/aliases.zsh
|
|
# - copy docs/setup/dotfiles/gitconfig.txt to ~/.gitconfig and overlay your identity
|
|
set -euo pipefail
|
|
# shellcheck source=./lib.sh
|
|
source "$(cd "$(dirname "$0")" && pwd)/lib.sh"
|
|
require_debian
|
|
require_not_root
|
|
|
|
REPO_ROOT="$(git rev-parse --show-toplevel 2>/dev/null || true)"
|
|
if [[ -z "$REPO_ROOT" ]]; then
|
|
err "Run from inside a git checkout of apf_portal."
|
|
exit 1
|
|
fi
|
|
|
|
DOTFILES_DIR="$REPO_ROOT/docs/setup/dotfiles"
|
|
|
|
# ─── 1. Aliases ───────────────────────────────────────────────────────
|
|
SOURCE_ALIASES="$DOTFILES_DIR/aliases.zsh"
|
|
if [[ ! -f "$SOURCE_ALIASES" ]]; then
|
|
err "$SOURCE_ALIASES not found."
|
|
exit 1
|
|
fi
|
|
|
|
OMZ_CUSTOM="${ZSH_CUSTOM:-$HOME/.oh-my-zsh/custom}"
|
|
if [[ ! -d "$OMZ_CUSTOM" ]]; then
|
|
err "$OMZ_CUSTOM not found — run 20-zsh.sh first."
|
|
exit 1
|
|
fi
|
|
|
|
TARGET_ALIASES="$OMZ_CUSTOM/aliases.zsh"
|
|
if [[ -L "$TARGET_ALIASES" \
|
|
&& "$(readlink -f "$TARGET_ALIASES")" == "$(readlink -f "$SOURCE_ALIASES")" ]]; then
|
|
skip "aliases.zsh symlink already correct."
|
|
else
|
|
if [[ -e "$TARGET_ALIASES" || -L "$TARGET_ALIASES" ]]; then
|
|
backup="$TARGET_ALIASES.bak.$(date +%s)"
|
|
mv "$TARGET_ALIASES" "$backup"
|
|
warn "Existing $TARGET_ALIASES backed up to $backup."
|
|
fi
|
|
ln -s "$SOURCE_ALIASES" "$TARGET_ALIASES"
|
|
ok "Linked $TARGET_ALIASES → $SOURCE_ALIASES."
|
|
fi
|
|
|
|
# ─── 2. gitconfig — copy + identity overlay ───────────────────────────
|
|
SOURCE_GITCONFIG="$DOTFILES_DIR/gitconfig.txt"
|
|
if [[ ! -f "$SOURCE_GITCONFIG" ]]; then
|
|
err "$SOURCE_GITCONFIG not found."
|
|
exit 1
|
|
fi
|
|
|
|
TARGET_GITCONFIG="$HOME/.gitconfig"
|
|
if [[ -f "$TARGET_GITCONFIG" ]] && ! confirm "$TARGET_GITCONFIG exists — overwrite (existing backed up)?"; then
|
|
skip "Keeping existing $TARGET_GITCONFIG."
|
|
else
|
|
if [[ -f "$TARGET_GITCONFIG" ]]; then
|
|
cp "$TARGET_GITCONFIG" "$TARGET_GITCONFIG.bak.$(date +%s)"
|
|
fi
|
|
|
|
# Prompt for identity. Defaults: pre-existing config values, else blank.
|
|
current_name="$(git config --global user.name 2>/dev/null || true)"
|
|
current_email="$(git config --global user.email 2>/dev/null || true)"
|
|
read -r -p "Git user.name [${current_name:-<required>}]: " new_name
|
|
new_name="${new_name:-$current_name}"
|
|
read -r -p "Git user.email [${current_email:-<required>}]: " new_email
|
|
new_email="${new_email:-$current_email}"
|
|
if [[ -z "$new_name" || -z "$new_email" ]]; then
|
|
err "Both user.name and user.email are required."
|
|
exit 1
|
|
fi
|
|
|
|
cp "$SOURCE_GITCONFIG" "$TARGET_GITCONFIG"
|
|
# `git config --global` finds and rewrites the [user] section
|
|
# cleanly even when the source carries a different identity.
|
|
git config --global user.name "$new_name"
|
|
git config --global user.email "$new_email"
|
|
|
|
ok "Wrote $TARGET_GITCONFIG with identity $new_name <$new_email>."
|
|
fi
|