Vim mode / open current file in external editor

[idealemu]

Hi,

How hard would it be to implement a "vim mode" for basic movements in the editor ? I know quite a few open source projects have this feature, or a plugin that enables it, we could look at for inspiration. Since the idea is mainly relevant for editing, IMHO, perhaps this could also be achieved by 'just' having a feature to open the current file in an external editor ?

I already do this by going into the filesystem and opening the corresponding file if I have specific changes I know are easier to make with vim, but since the files are named for the database it is a slightly cumbersome workflow at the moment.

[vkbo]

Well, you're not supposed to edit files externally as it causes issues with the index and internal meta data. If you do so, it's at your own risk, and it's not something the editor is going to support.

As for vim mode, I guess it could be done. Not sure how it would interfere with other functionality and native Qt features. For the time being, I'm focusing my efforts on editor features, for which the backlog is still pretty big.

[Polygon1556]

I second the VIM editing mode in the main text editor (not opening in an external program). I wish I had the programming skills to contribute this feature. The "vibe" of NovelWriter is already pretty clearly from a coding or programming background (if that makes sense), and I think a lot of people would love a VIM mode.

I use NeoVim for a lot of my personal writing, but for novel writing I need the NovelWriter organization and tagging features, so adding a VIM mode would make it perfect.

[vkbo]

Online sources typically show that grabbing escape can be done by creating a Qt shortcut bound to escape to grab the key event before anything else. If nothing else is grabbing it, or if it is still passed down then we can simply get it like any other key apparently like such if event.key() == Qt.Key_Escape.

novelWriter actually does this already. Escape is captured globally here:

novelWriter/novelwriter/guimain.py

Lines 308 to 311 in 21ce030

	self.keyEscape = QShortcut(self)
	self.keyEscape.setKey("Esc")
	self.keyEscape.activated.connect(self._keyPressEscape)

And processed here:

novelWriter/novelwriter/guimain.py

Lines 1326 to 1333 in 21ce030

	@pyqtSlot()
	def _keyPressEscape(self) -> None:
	"""Process an escape keypress in the main window."""
	if self.docEditor.searchVisible():
	self.docEditor.closeSearch()
	elif SHARED.focusMode:
	SHARED.setFocusMode(False)
	return

You can also associate a shortcut with a specific widget, but that's a bit tricky with the editor because it is a combo of multiple widgets, some of which are free floating and sometimes hidden, hence the custom logic to just capture it globally and use the if statement to decide what to do. You probably need to hook in there to handle the Escape, or try to find a better way to solve that.

[vkbo]

In any case, I can help with a lot of these details if you otherwise have a proof of concept solution. Keep in mind that every line of code added also needs to be covered by unit tests in novelWriter.

[idealemu]

novelWriter actually does this already. Escape is captured globally here

Super ! This is what I have been looking for, I just couldn't find where it was. If I just add a global vim mode state I can get a basic proof of concept to work I think !
And yes I have read through the docs and know about the tests of course.

[vkbo]

I created a feature ticket for this: #2493

Let's keep the implementation discussion going there.

[Polygon1556]

Thank you @vkbo and @idealemu so much! I can't believe this might actually happen!!!!

[SuperUserNameMan]

May i ask what a "vim mode" is ?

[idealemu]

Sure ! A "vim mode" is another editing mode that can be implented by an editor that emulates some of the functionalities of the vim editor. [Vim is a text editor ](https://en.wikipedia.org/wiki/Vim_(text_editor) that is quite popular amongst (I would say) the linux crowd, or people who often work from the terminal, although it doesn't need to be.

The main 'point' of it is a text editor that is fully customizable through a configuration file (this isn't often included in vim modes in other editors), and where all actions can be taken with the keyboard. Mastery of vim, or just knowing the basics, provides a lot of speed, and usually once people like it they usually can't go without it, hence "vim modes" being added to a whole bunch of other editors ! 😄

[SuperUserNameMan]

Thanks for clarifying what you were referring to by "vim mode". (i wasn't sure when i googled).

I'm more a nano/gedit guy. Will this VIM mode that you want to add to novelWritter be optional ?

[vkbo]

Yes, it will be optional 😃