spacemacs-cheatsheet

spacemacs-cheatsheet copied to clipboard

Originally copied from this gist

New issues and pull requests to improve for general community highly encouraged.

Useful Spacemacs commands

• SPC q q - quit

windowing

buffer/file/project juggling

region/highlighting

Unimpaired

evil-mc

evil-mc is a multi-cursor implementation available in spacemacs by default in the develop branch, optionally enabled in the main.

2.1 Quick Guide for Using Multiple Cursors

Multiple cursors can be used to simultaneously modify occurrences of a word, expression, symbol, etc. To enable it globally add (global-evil-mc-mode 1) to your .spacemacs file.

2.2 General Principles

1. Descriptions here are provided to supplement the evil-mc documentation which makes sense if you have a foundation but may be somewhat terse for the novice.

2. You use evil-mc commands to make or manipulate multiple "fake" cursors. You are then able to make modifications to text at all cursors at once in multiple locations of the buffer.

3. Once created, fake cursors persist until you clear them (grq).

4. There are two sets of commands, those that create/remove cursors and those that navigate among them.

5. Fake cursors are created in two ways: a) by matching text, or b) by manually selecting where the cursor should be.

2.3 Simple Case 1 - Matching

Using text matching we can create cursors on multiple lines. Let's say we have this picnic list:

Ron: Ice and soda
Sally: Volleyball
Ron: Vollball nets
Ron: Sand
Ann: Adult beverages
Ron: Sunblock

Rob can't make it now we have to change his assignments to someone else.

1. Put your cursor on the first Rob.
2. In command mode type C-n (evil-mc-make-cursor-and-goto-next-match).
3. You should get another cursor on the next match.
4. Again, type C-n which should give you another cursor on the third match.
5. At this point you can move and edit as appropriate (e.g., b cw Rick).
6. Type ESC to exit insert mode.
7. To clear your cursors, type grq (evil-undo-all-cursors).

2.4 Simple Case 2 - Columnar

Another common case for changing multiple lines is that you want to change a column of text but there are no matching symbols. In the example below, let's say you want to change the ) numbering to simply a ..

1) Sample line A
2) Sample line B
3) Sample line C

If you put your cursor on ) and use the C-n you get the message Search failed because evil doesn't recognize the matching parenthesis. What we can do in this case is use the evil-mc-make-cursor-and-goto-next-line function. Rather than looking for match evil will simply move directly down one line.

1. Put your cursor on the first ).
2. In command mode type grj (evil-mc-make-cursor-and-goto-next-line).
3. You will get a new fake cursor directly below where you started. Type grj again and you will have your third cursor.
4. As before, you can make your edits here using the normal commands.
5. Type ESC to exit insert mode and type grq to clear the cursors.

2.5 Simple Case 3 - Movement Args

When running the cursor commands you can make use of normal vim/spacemacs movement arguments.

1) Sample line A
2) Sample line B
3) Sample line C

1. As before, in command mode put your cursor on the first ).
2. Type 2grj.
3. Edit as usual, ESC to exit insert mode, etc.

2.6 Simple Case 3 - Manually Setting Cursors

In the last example let's say we have some word or symbol that isn't matching really well or we're only dealing with a few lines. In that case you might want to manually place your fake cursors. Let's say we want to instances below from appl to run.

def appl_start = "apple"
println "Application end: {appl_end}"
def (other, appl_and_exit) = [true,false]

1. Move your cursor to the a in appl in the first line.
2. Place a cursor using grh (evil-mc-make-cursor-here).
3. You have your first fake cursor but now it will want to chase the real cursor around while you place your other cursors so you need to pause it. Type grs (evil-mc-pause-cursors).
4. Now move to the a in appl_end and do another grh.
5. Move to the a in appl_and_exit and place your final fake cursor with grh.
6. Now resume cursors with grr (evil-mc-resume-cursors).
7. Edit as usual, ESC to exit insert mode, etc.

Once you get the idea, refer to the evil-mc documentation for more details.

Eyebrowse

Changing workspace

Find/Replace

Git

• Highlight by age of commit or last update time is provided by smeargle.
• Git time machine is provided by git-timemachine.
• Git last commit message per line is provided by git-messenger.

3.1 Magit

A well-featurend Spacemacs layer for managing Git repositories.

Add magit to dotspacemacs-configuration-layers in your .spacemacs file. Access it from spacemacs using SPC f e d

Magit can only work from a Git repository

From within a Git repo:

• SPC g s open magit for a git repo

Common commands

NOTE Staging lines

Magit allows you to stage specific lines by selecting them in a diff and hitting s to stage. Due to inconsistencies between Vim and Emacs editing styles, if you enter visual line state with V, you will stage one more line than intended. To work around this, you can use v instead (since Magit only stages whole lines, in any case).

3.2 Commit message editing buffer

When done editing, commit with <leader>c (<leader> defaults to , in spacemacs) or C-c C-c. Discard the commit with <leader>k, or C-c C-k.

3.3 Interactive rebase buffer

3.4 Quick guide for recurring use cases in Magit

Amend a commit:

• l l to open log buffer
• c a on the commit you want to amend

Squash last commit:

• l l open log buffer
• r e on second to last commit, it opens the rebase buffer
• j put point on last commit
• s squash it

Force push a squashed commit: in the status buffer you should see the new commit unpushed and the old commit unpulled

• P -f P for force a push (beware usually it is not recommended to rewrite the history of a public repository, but if you are sure that you are the only one to work on a repository it is ok - i.e. in your fork). Add upstream remote (the parent repository you have forked):
• M open the remote popup
• a add a remote

Pull changes from upstream (the parent repository you have forked) and push:

• F (-r) C-u F then choose upstream or the name you gave to it
• (-r) toggle on rebase if needed
• P P push the commit to origin

3.5 Git-Flow

magit-gitflow provides git-flow commands in its own magit menu.

• % open magit-gitflow menu

3.6 Git time machine

git-timemachine allows to quickly browse the commits of the current buffer.

Enter git timemachine with SPC g t from the file you wish to explore

• c show current commit
• n show next commit
• N show previous commit
• p show previous commit
• q leave micro-state and git timemachine
• Y copy current commit hash

Useful Vim key bindings

movement

editing

Change text inside something, e.g.