m1ngsama/chopsticks

Fork 0

mirror of https://oauth2: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@github.com/m1ngsama/chopsticks.git synced 2026-05-10 19:10:59 +08:00

m1ngsama 0ba2e84e0c fix: correct 13 bugs across .vimrc, install.sh, and docs

.vimrc:
- Fix syntax=OFF no-op in large file handler (syntax= is correct)
- Fix <leader>rG broken -F flag (new RgWord command with -F before --)
- Fix :Gdiff → :Gdiffsplit (fugitive v3+ compat)
- Fix go_def_mode/go_info_mode conflicting with go_gopls_enabled=0
- Fix <leader>m prefix collision with mt/mp (renamed to <leader>ms)
- Wrap PlugInstall autocmd in augroup (prevent doubling on re-source)

install.sh:
- Guard against empty version string in hadolint/marksman downloads
- Add HAS_SUDO check in _do_binary_apt before sudo mv
- Add PlugClean warning when existing plugins directory is non-empty
- Fix pkg_install brew-first priority (macOS-only now, Linux fallback)
- Fix menu double-draw flicker on first render
- Fix Fedora deselected tools not tracked in SKIPPED array

docs:
- Remove nonexistent nvm install step from README
- Fix TOC description (side window, not quickfix) in README/QUICKSTART
- Fix TTY detection description (add dumb, empty, builtin)
- Add missing ,cd and ,wa mappings to README
- Remove dead CoC formatOnSaveFiletypes from coc-settings.json

2026-04-15 09:57:26 +08:00

4.9 KiB

Raw Blame History

Quick Start

Five minutes from zero to a working Vim environment.

Step 0: Vim Basics (2 minutes)

When confused, press Esc until things feel normal again.

Vim is modal — the keyboard behaves differently depending on which mode you are in.

Mode	Purpose	Enter	Leave
Normal	Navigate and run commands	default on startup	—
Insert	Type text	`i` before / `a` after / `o` new line	`Esc` or `jk`
Visual	Select text	`v` char / `V` line	`Esc`

4 commands that get you out of any jam

Command	Action
`Esc` or `jk`	Exit insert / visual mode → Normal
`:q!` then `Enter`	Force quit without saving
`,x`	Save and quit
`,w` or `Ctrl+s`	Save

Once in Normal mode, press ,? to open the cheat sheet.

Step 1: Install

curl -fsSL https://raw.githubusercontent.com/m1ngsama/chopsticks/main/get.sh | bash

Traditional:

git clone https://github.com/m1ngsama/chopsticks.git ~/.vim
cd ~/.vim && ./install.sh

Non-interactive / CI:

curl -fsSL https://raw.githubusercontent.com/m1ngsama/chopsticks/main/get.sh | bash -s -- --yes

Step 2: Open Vim

vim          # startup dashboard (recent files + sessions)
vim .        # startup dashboard, current directory listed
vim myfile   # edit a specific file

Step 3: Set Up LSP

Open a source file, then run:

:LspInstallServer

This auto-detects the filetype and installs the correct language server. No Node.js required — vim-lsp runs on pure VimScript.

Check status:

:LspStatus

Markdown LSP (marksman) needs a standalone binary:

brew install marksman    # macOS
sudo pacman -S marksman  # Arch
# install.sh handles this automatically

The Keys That Matter

,?              Open cheat sheet (all bindings in one place)
Esc / jk        Exit insert mode → Normal
Ctrl+s          Save
Ctrl+p          Fuzzy find file
,e              File browser (netrw)
gd              Go to definition
K               Show documentation
[g / ]g         Prev / next LSP diagnostic
,rn             Rename symbol
,rG             Search word under cursor (ripgrep)
,gs             Git status
,mp             Markdown live preview in browser
,w / ,x         Save / Save+quit

Daily Use

Navigate Code

Key	Action
`gd`	Go to definition
`gy`	Go to type definition
`gi`	Go to implementation
`gr`	List references
`K`	Docs for symbol under cursor
`Ctrl+o`	Jump back
`Ctrl+i`	Jump forward

Edit Code

Key	Action
`Tab`	Select next completion item
`Enter`	Confirm completion
`gc`	Toggle comment (visual mode too)
`cs"'`	Change surrounding `"` to `'`
`ds(`	Delete surrounding `(`
`s` + 2 chars	EasyMotion: jump anywhere

Manage Errors

Key	Action
`]g`	Jump to next LSP diagnostic
`[g`	Jump to previous diagnostic
`K`	Read the error message
`,ca`	Apply code action / auto-fix

Markdown

Key	Action
`,mp`	Open live preview in browser
`,mt`	Table of contents (side window)
`zr` / `zm`	Unfold / fold all headings

Formatting in the buffer is live: **bold** renders as bold, headings hide their # markers. Raw syntax reappears when the cursor enters that line.

Git Workflow

,gs   git status (stage with 's', commit with 'cc')
,gd   diff current file
,gb   blame
,gc   commit
,gp   push
,gl   pull

Quick Reference Card

BASICS
  Esc / jk        Exit insert mode → Normal
  Ctrl+s          Save
  :q! + Enter     Emergency quit
  ,?              Open cheat sheet

FILES
  Ctrl+p          Fuzzy find file (git-aware)
  ,e              File browser (netrw)
  ,b              Search open buffers
  ,rg             Search file contents (ripgrep)
  ,rG             Ripgrep word under cursor
  ,w  Save  |  ,q  Quit  |  ,x  Save+quit
  ,wa             Save all buffers
  ,,              Switch to last file

CODE
  gd  Definition  |  gy  Type def  |  gi  Impl  |  gr  References
  K               Show documentation
  [g / ]g         Prev / next LSP diagnostic
  [e / ]e         Prev / next ALE error
  ,rn             Rename symbol
  ,ca             Code action
  ,f              Format buffer / selection

MARKDOWN
  ,mp   Live preview  |  ,mt  Table of contents

GIT
  ,gs  Status  |  ,gd  Diff  |  ,gb  Blame
  ,gc  Commit  |  ,gp  Push  |  ,gl  Pull

WINDOWS / PANES
  Ctrl+h/j/k/l    Move between Vim windows or tmux panes
  ,h / ,l         Prev / next buffer
  ,tv / ,th       Terminal (vertical / horizontal)
  Esc Esc         Exit terminal mode
  ,u              Undo tree

SEARCH
  /text  Forward  |  ?text  Backward  |  n  next  |  N  prev
  //     Search visually selected text
  ,*     Replace word under cursor (file-wide)

See README.md for the complete reference.

4.9 KiB Raw Blame History