Vim Mode 2022

[tombh]

Can I finally get Vim Mode merged?

Fixes #236, #246 and #264

[laughingbiscuit]

do you want to community to use and test for your fork prior to merge?

[martin-braun]

vimium in browsh will be a game changer for me!

[jivank]

I was having trouble building this branch with the provided documentation. I assume the repo has a GitHub Action that successfully builds?

[tombh]

I would love help with this. The only thing that needs fixing to get this merged is the failing tests.

@jivank The local dev setup docs do indeed need updating. If you're on Linux or similar you can use https://github.com/browsh-org/browsh/blob/master/.github/workflows/main.yml for inspiration.

[jivank]

I see in TTY tests:

Error: test/tty/tty_test.go:4:2: package browsh/interfacer/src/browsh is not in GOROOT (/opt/hostedtoolcache/go/1.18.10/x64/src/browsh/interfacer/src/browsh)

This is a similar error I was facing when I was attempting to build it on my local machine.

[isaacphi]

@tombh What sort of help do you need with this PR as of now?

[tombh]

I never merged it because the tests failed. But considering that I've been giving Browsh so little attention, I guess I could just give up on the tests and make a release with this anyway. If enough people test this PR themselves then I suppose that's enough.

[heywoodlh]

All the keyboard shortcuts seem to work for me as expected! Would be nice if the README/website documentation included a list of the shortcuts -- or maybe just a link to

browsh/interfacer/src/browsh/config.go

Lines 78 to 136 in a075246

	// Vim commands
	vimKeyMap["normal gg"] = "scrollToTop"
	vimKeyMap["normal G"] = "scrollToBottom"
	vimKeyMap["normal j"] = "scrollDown"
	vimKeyMap["normal k"] = "scrollUp"
	vimKeyMap["normal h"] = "scrollLeft"
	vimKeyMap["normal l"] = "scrollRight"
	vimKeyMap["normal d"] = "scrollHalfPageDown"
	vimKeyMap["normal <C-d>"] = "scrollHalfPageDown"
	vimKeyMap["normal u"] = "scrollHalfPageUp"
	vimKeyMap["normal <C-u>"] = "scrollHalfPageUp"
	vimKeyMap["normal e"] = "editURL"
	vimKeyMap["normal ge"] = "editURL"
	vimKeyMap["normal gE"] = "editURLInNewTab"
	vimKeyMap["normal H"] = "historyBack"
	vimKeyMap["normal L"] = "historyForward"
	vimKeyMap["normal J"] = "prevTab"
	vimKeyMap["normal K"] = "nextTab"
	vimKeyMap["normal r"] = "reload"
	vimKeyMap["normal xx"] = "removeTab"
	vimKeyMap["normal X"] = "restoreTab"
	vimKeyMap["normal t"] = "newTab"
	vimKeyMap["normal T"] = "searchForTab"
	vimKeyMap["normal /"] = "findMode"
	vimKeyMap["normal n"] = "findNext"
	vimKeyMap["normal N"] = "findPrevious"
	vimKeyMap["normal g0"] = "firstTab"
	vimKeyMap["normal g$"] = "lastTab"
	vimKeyMap["normal gu"] = "urlUp"
	vimKeyMap["normal gU"] = "urlRoot"
	vimKeyMap["normal <<"] = "moveTabLeft"
	vimKeyMap["normal >>"] = "moveTabRight"
	vimKeyMap["normal ^"] = "previouslyVisitedTab"
	vimKeyMap["normal m"] = "makeMark"
	vimKeyMap["normal '"] = "gotoMark"
	vimKeyMap["normal i"] = "insertMode"
	vimKeyMap["normal I"] = "insertModeHard"
	vimKeyMap["normal yy"] = "copyURL"
	vimKeyMap["normal p"] = "openClipboardURL"
	vimKeyMap["normal P"] = "openClipboardURLInNewTab"
	vimKeyMap["normal gi"] = "focusFirstTextInput"
	vimKeyMap["normal f"] = "openLinkInCurrentTab"
	vimKeyMap["normal F"] = "openLinkInNewTab"
	vimKeyMap["normal <M-f>"] = "openMultipleLinksInNewTab"
	vimKeyMap["normal yf"] = "copyLinkURL"
	vimKeyMap["normal [["] = "followLinkLabeledPrevious"
	vimKeyMap["normal ]]"] = "followLinkLabeledNext"
	vimKeyMap["normal yt"] = "duplicateTab"
	vimKeyMap["normal v"] = "visualMode"
	vimKeyMap["normal ?"] = "viewHelp"
	vimKeyMap["caret v"] = "visualMode"
	vimKeyMap["caret h"] = "moveCaretLeft"
	vimKeyMap["caret l"] = "moveCaretRight"
	vimKeyMap["caret j"] = "moveCaretDown"
	vimKeyMap["caret k"] = "moveCaretUp"
	vimKeyMap["caret <Enter>"] = "clickAtCaretPosition"
	vimKeyMap["visual c"] = "caretMode"
	vimKeyMap["visual o"] = "swapVisualModeCursorPosition"
	vimKeyMap["visual y"] = "copyVisualModeSelection"

---

I packaged this PR's commit as a Nix flake for use with the Nix package manager. See below if you are interested in easy installation/testing with Nix.

Flake is here: https://github.com/heywoodlh/flakes/tree/main/browsh

Run the flake with the following command:

nix --extra-experimental-features "nix-command flakes" run "github:heywoodlh/flakes?dir=browsh"

If you do this from Linux, my flake includes Firefox-ESR bundled with it, so it should just work. I've also provided an appimage of my bundled flake -- although, mileage may vary on how well it works as it was very slow for me:

curl -L "https://github.com/heywoodlh/flakes/releases/download/appimages/browsh-$(arch).appimage" -o /tmp/browsh.appimage && chmod +x /tmp/browsh.appimage

/tmp/browsh.appimage

[jooaf]

I tested the keyboard shortcuts using the Dockerfile posted here. i then built and tested the docker image from the root of the repo using the following:

docker build -t browsh-vim .
docker run --rm -ti browsh-vim https://hexdocs.pm/gleam_json

for those who are curious, i tested via my fork here
For the most part all of the keybinds seems to work! I did notice that the insert mode keybindings didn't work, but that could just be my terminal. Overall, works as expected thank you so much :)

[God-damnit-all]

I never merged it because the tests failed. But considering that I've been giving Browsh so little attention, I guess I could just give up on the tests and make a release with this anyway. If enough people test this PR themselves then I suppose that's enough.

It would be nice to have binaries for the latest version.

[bqv]

@tombh 🙏

[tombh]

I know 🥺 The automated CI build is broken, and it's tricky to fix. I keep wanting to sit down and do a proper rewrite.