|
|
@@ -10,6 +10,7 @@ and adds `bin/` to PATH. `$LWS` points to repo root.
|
|
|
|
- `bin/` — Scripts auto-added to PATH. New CLI tools go here.
|
|
|
|
- `bin/` — Scripts auto-added to PATH. New CLI tools go here.
|
|
|
|
- `scripts/` — Setup scripts NOT on PATH (git-config, docker fixes, gnome config).
|
|
|
|
- `scripts/` — Setup scripts NOT on PATH (git-config, docker fixes, gnome config).
|
|
|
|
- `conf/` — Tool configs (vim, WireGuard, WSL).
|
|
|
|
- `conf/` — Tool configs (vim, WireGuard, WSL).
|
|
|
|
|
|
|
|
- `doc/` — Reference docs, cheatsheets, bookmarks.
|
|
|
|
- `functions.sh` — Core lib (see below).
|
|
|
|
- `functions.sh` — Core lib (see below).
|
|
|
|
|
|
|
|
|
|
|
|
## Key Helpers (`functions.sh`)
|
|
|
|
## Key Helpers (`functions.sh`)
|
|
|
@@ -26,7 +27,7 @@ and adds `bin/` to PATH. `$LWS` points to repo root.
|
|
|
|
|
|
|
|
|
|
|
|
## Conventions
|
|
|
|
## Conventions
|
|
|
|
|
|
|
|
|
|
|
|
All new bash scripts should use:
|
|
|
|
All new **executable** bash scripts should use:
|
|
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
```bash
|
|
|
|
#!/usr/bin/env bash
|
|
|
|
#!/usr/bin/env bash
|
|
|
@@ -34,8 +35,13 @@ All new bash scripts should use:
|
|
|
|
set -E -o errexit -o nounset -o pipefail
|
|
|
|
set -E -o errexit -o nounset -o pipefail
|
|
|
|
```
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
**Sourced files** (rc files, `functions.sh`) must NOT use `set -o errexit` — they run inside
|
|
|
|
|
|
|
|
the user's shell. Add `# shellcheck shell=bash` at the top instead of a shebang.
|
|
|
|
|
|
|
|
|
|
|
|
Before writing shell code, check `functions.sh` for existing helper functions and prefer them over raw commands.
|
|
|
|
Before writing shell code, check `functions.sh` for existing helper functions and prefer them over raw commands.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Detailed formatting, naming, and syntax rules are in `.claude/rules/bash-style.md`.
|
|
|
|
|
|
|
|
|
|
|
|
RC files MUST guard slow tools and check availability:
|
|
|
|
RC files MUST guard slow tools and check availability:
|
|
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
```bash
|
|
|
@@ -53,5 +59,6 @@ Installers (`install/*.sh`) MUST be idempotent — check before installing.
|
|
|
|
|
|
|
|
|
|
|
|
## Commits
|
|
|
|
## Commits
|
|
|
|
|
|
|
|
|
|
|
|
Do not add `Co-Authored-By` lines to commit messages.
|
|
|
|
- Do not add `Co-Authored-By` lines to commit messages.
|
|
|
|
Prefer one-line commit messages. Add a longer description only when necessary for better understanding.
|
|
|
|
- Commit messages must be in English.
|
|
|
|
|
|
|
|
- Prefer one-line commit messages. Add a longer description only when necessary for better understanding.
|
|
|
|