Make Ctrl-S save opt-in (#42)

* Make Ctrl-S save opt in

* Avoid hanging CI Vim installation

* Keep Homebrew Vim on macOS CI

.github/workflows/test.yml

@@ -16,11 +16,15 @@ jobs:
       - uses: actions/checkout@v4
 
       - name: Install Vim
+        timeout-minutes: 5
         run: |
           if [ "$(uname)" = "Darwin" ]; then
             brew install vim
+          elif command -v vim >/dev/null 2>&1; then
+            vim --version | head -1
           else
-            sudo apt-get update && sudo apt-get install -y vim
+            sudo apt-get update
+            sudo apt-get install -y vim
           fi
 
       - name: Install vim-plug

.vimrc

@@ -11,6 +11,8 @@ endif
 if exists('g:chopsticks_loaded') | finish | endif
 let g:chopsticks_loaded = 1
 
+let g:surround_no_insert_mappings = get(g:, 'surround_no_insert_mappings', 1)
+
 function! s:load(mod) abort
     execute 'source ' . fnameescape(g:chopsticks_dir . '/modules/' . a:mod . '.vim')
 endfunction

QUICKSTART.md

@@ -39,7 +39,6 @@ Esc             back to Normal
 ,w              save
 ,x              save + quit
 :q!             force quit
-Ctrl+s          save from any mode
 ,?              cheat sheet (toggle sidebar)
 ```
 

README.md

@@ -82,6 +82,7 @@ let g:chopsticks_profile = 'minimal'   " core navigation/editing/git/markdown
 let g:chopsticks_profile = 'engineer'  " default: LSP, ALE, syntax extras
 let g:chopsticks_profile = 'full'      " engineer + heavier Markdown feedback
 let g:chopsticks_enable_jk_escape = 1  " optional: insert-mode jk exits insert
+let g:chopsticks_enable_ctrl_s_save = 1 " optional: Ctrl-S saves
 ```
 
 `minimal` avoids LSP, ALE, completion plugins, extra language syntax plugins,
@@ -217,7 +218,7 @@ Each module is self-contained. Comment out one line in `.vimrc` to disable it. A
 | Plugins not loading | `:PlugInstall` then `:PlugUpdate`             |
 | LSP not starting    | `:LspInstallServer` for current filetype      |
 | Colors wrong        | `export COLORTERM=truecolor` in shell rc      |
-| `Ctrl+s` freezes    | `stty -ixon` in shell rc                      |
+| Optional `Ctrl+s` freezes | `stty -ixon` in shell rc                |
 | Everything slow     | Large file? Auto-disabled >10MB               |
 | What's installed?   | `:ChopsticksStatus` shows tools, LSP, linters |
 

modules/core.vim

@@ -137,8 +137,10 @@ nnoremap N Nzzzv
 
 vnoremap // y/\V<C-r>=escape(@",'/\')<CR><CR>
 
+if get(g:, 'chopsticks_enable_ctrl_s_save', 0)
     nnoremap <silent> <C-s> :w<CR>
     inoremap <silent> <C-s> <C-o>:w<CR>
+endif
 
 nnoremap <C-d> <C-d>zz
 vnoremap <C-d> <C-d>zz

modules/tools.vim

@@ -422,7 +422,6 @@ function! s:CheatSheet() abort
         \ '  ,w        save',
         \ '  ,q        quit',
         \ '  ,x        save + quit',
-        \ '  Ctrl+s    save (any mode)',
         \ '  Esc       exit insert',
         \ '  :w!!      sudo save',
         \ '  ,ev       edit vimrc',

scripts/test.sh

@@ -204,6 +204,7 @@ check_vim() {
     XDG_CONFIG_HOME="$EMPTY_XDG" vim -u .vimrc -i NONE -es -N \
         -c 'if maparg("0", "n") !=# "" || maparg("0", "v") !=# "" || maparg("Y", "n") !=# "" || maparg("Q", "n") !=# "" || maparg("<Space>", "n") !=# "" | cquit | endif' \
         -c 'if maparg("jk", "i") !=# "" | cquit | endif' \
+        -c 'if maparg("<C-s>", "n") !=# "" || maparg("<C-s>", "i") !=# "" | cquit | endif' \
         -c 'if maparg("<C-h>", "n") !=# "" || maparg("<C-j>", "n") !=# "" || maparg("<C-k>", "n") !=# "" || maparg("<C-l>", "n") !=# "" | cquit | endif' \
         -c 'if maparg("<C-p>", "n") !=# "" | cquit | endif' \
         -c 'if maparg(",ff", "n") !~# "SmartFiles" | cquit | endif' \
@@ -215,6 +216,13 @@ check_vim() {
         -c 'if maparg("jk", "i") !~# "<Esc>" | cquit | endif' \
         -c 'qa!' 2>&1
 
+    XDG_CONFIG_HOME="$EMPTY_XDG" vim -u NONE -i NONE -es -N \
+        -c 'let g:chopsticks_enable_ctrl_s_save = 1' \
+        -c 'source .vimrc' \
+        -c 'if maparg("<C-s>", "n") !~# ":w" | cquit | endif' \
+        -c 'if maparg("<C-s>", "i") !~# ":w" | cquit | endif' \
+        -c 'qa!' 2>&1
+
     XDG_CONFIG_HOME="$EMPTY_XDG" vim -u .vimrc -i NONE -es -N \
         -c 'silent! delcommand LspStatus' \
         -c 'silent! delcommand LspInstallServer' \
@@ -275,7 +283,7 @@ check_vim() {
     grep -Fq ',dk       hover docs' "$TMP_ROOT/cheat-default.txt"
     grep -Fq ',dp ,dn   LSP diagnostics' "$TMP_ROOT/cheat-default.txt"
     grep -Fq '<C-w>hjkl navigate splits' "$TMP_ROOT/cheat-default.txt"
-    if grep -Eq 'Ctrl\\+p    find file|Ctrl\\+hjkl navigate splits|jk        exit insert|gd        definition|K         hover docs|\\[g \\]g     LSP diagnostics' "$TMP_ROOT/cheat-default.txt"; then
+    if grep -Eq 'Ctrl\\+p    find file|Ctrl\\+hjkl navigate splits|Ctrl\\+s    save|jk        exit insert|gd        definition|K         hover docs|\\[g \\]g     LSP diagnostics' "$TMP_ROOT/cheat-default.txt"; then
         cat "$TMP_ROOT/cheat-default.txt"
         exit 1
     fi