Update project documentation
This commit is contained in:
@@ -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.
|
||||
- `scripts/` — Setup scripts NOT on PATH (git-config, docker fixes, gnome config).
|
||||
- `conf/` — Tool configs (vim, WireGuard, WSL).
|
||||
- `doc/` — Reference docs, cheatsheets, bookmarks.
|
||||
- `functions.sh` — Core lib (see below).
|
||||
|
||||
## Key Helpers (`functions.sh`)
|
||||
@@ -26,7 +27,7 @@ and adds `bin/` to PATH. `$LWS` points to repo root.
|
||||
|
||||
## Conventions
|
||||
|
||||
All new bash scripts should use:
|
||||
All new **executable** bash scripts should use:
|
||||
|
||||
```bash
|
||||
#!/usr/bin/env bash
|
||||
@@ -34,8 +35,13 @@ All new bash scripts should use:
|
||||
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.
|
||||
|
||||
Detailed formatting, naming, and syntax rules are in `.claude/rules/bash-style.md`.
|
||||
|
||||
RC files MUST guard slow tools and check availability:
|
||||
|
||||
```bash
|
||||
|
||||
Reference in New Issue
Block a user