From 515654370241ea1f69b7b9de6d31b71b3dab6412 Mon Sep 17 00:00:00 2001 From: m1ngsama Date: Sun, 17 May 2026 11:00:03 +0800 Subject: [PATCH] Bump Vim version docs to 8.1+ and lead onboarding with ,? (#78) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Two small first-run UX fixes bundled together (both touch install.sh and README, with the same review surface): 1. README badge and install.sh warn line bumped 8.0+ → 8.1+. The runtime conditionally relies on patches 8.1.0360 (diffopt) and 8.1.1517 (completeopt+=popup). Guards no-op on 8.0 but the docs were silently misleading anyone debugging on stale Vim. 2. "First steps inside Vim" block reordered so ,? leads. The cheat sheet is the most useful onboarding asset; it shouldn't be buried below three "how to leave" hints. Also promoted ,x above :q! since the latter is emergency, not first-run. Closes #76 Closes #77 --- CHANGELOG.md | 6 ++++++ README.md | 2 +- install.sh | 6 +++--- 3 files changed, 10 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 2e0b5e2..497efe5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -23,6 +23,9 @@ ### Fixed +- README badge and `install.sh` recommend Vim 8.1+ instead of 8.0+ — + the runtime conditionally relies on patches `8.1.0360` (diffopt) and + `8.1.1517` (completeopt+=popup), so 8.0 users hit option errors - `install.sh` no longer silently `PlugClean!`s user-added plugins from `~/.vim/plugged`; it now lists undeclared plugin directories first and asks before removing them (`--yes` skips the removal entirely) @@ -40,6 +43,9 @@ ### Changed +- `install.sh` "First steps inside Vim" block now leads with `,?` + (cheat sheet) — the single best onboarding asset is now the first + thing a new user sees after install, not the fourth - `set exrc`/`set secure` are now opt-in via `g:chopsticks_enable_exrc = 1`; Vim no longer sources project-local `.vimrc`/`.exrc` from the working directory by default diff --git a/README.md b/README.md index 6466ef3..9529779 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@

MIT License - Vim 8.0+ + Vim 8.1+ Platform Tests Release diff --git a/install.sh b/install.sh index 6b41b1e..0f4aa10 100755 --- a/install.sh +++ b/install.sh @@ -519,7 +519,7 @@ fi [[ -n "$VIM_BIN" ]] || die "vim installed but not found in PATH" ok "Found: $("$VIM_BIN" --version | head -n1) ($VIM_BIN)" "$VIM_BIN" --version | grep -q 'Vi IMproved 8\|Vi IMproved 9' || \ - warn "Vim 8.0+ recommended for full async/LSP support — some features may not work" + warn "Vim 8.1+ recommended for full async/LSP support — some features may not work" # Node.js (optional — vim-lsp needs no Node.js; only npm formatters do) HAS_NODE=0; command -v node >/dev/null 2>&1 && HAS_NODE=1 @@ -1201,10 +1201,10 @@ echo -e " ${CYAN}vim .${NC} Open dashboard in current directory" echo -e " ${CYAN}vim myfile${NC} Edit a specific file" echo "" echo -e "${BOLD} First steps inside Vim${NC}" +echo -e " ${CYAN},?${NC} Open cheat sheet — your map of every keybinding" echo -e " ${CYAN}Esc${NC} Exit insert mode → back to Normal" -echo -e " ${CYAN}:q!${NC} + Enter Emergency quit without saving" echo -e " ${CYAN},x${NC} Save and quit" -echo -e " ${CYAN},?${NC} Open cheat sheet" +echo -e " ${CYAN}:q!${NC} + Enter Emergency quit without saving" if [[ $CONFIG_PROFILE != "minimal" ]]; then echo -e " ${CYAN}:LspInstallServer${NC} Install LSP for current filetype" fi