Automatically configure 'gf' passthrough #161
Conversation
Fixes #157. obsidian.nvim will now automatically configure the 'gf' pasthrough unless this keybinding was already set or you put 'keybindings.gf_passthrough = false' in your obsidian.nvim config.
| @@ -20,7 +20,7 @@ describe("Note", function() | |||
| local note = Note.from_file "README.md" | |||
| assert.equals(note.id, "README") | |||
| assert.equals(#note.aliases, 1) | |||
| assert.equals(note.aliases[1], "Obsidian.nvim") | |||
| assert.equals(note.aliases[1], "obsidian.nvim") | |||
There was a problem hiding this comment.
This seems like it might be unrelated and might be deserving of its own message in the commit log
There was a problem hiding this comment.
This was just because I changed the title of the README from "Obsidian.nvim" to "obsidian.nvim" to be consistent with the repo name.
|
|
||
| -- Optional, override the 'gf' keymap to utilize obsidian.nvim's search functionality. | ||
| -- see also: 'follow_url_func' config option below. | ||
| vim.keymap.set("n", "gf", function() |
There was a problem hiding this comment.
In the spirit of updating the docs, we might want to leave this information somewhere in the README in to provide some direction for users who wish to manage their commands manually. For example, I don't think we document anywhere that this helper function cursor_on_markdown_link() exists, which might be very helpful information for power users.
lua/obsidian/init.lua
Outdated
| if gf_set_by == "" then | ||
| -- 'gf' has not been overridden by user or other plugin so we can safely set it. | ||
| vim.keymap.set("n", "gf", function() | ||
| if require("obsidian").util.cursor_on_markdown_link() then |
There was a problem hiding this comment.
I think there should be an additional check here to ensure that the current buffer is located within the obsidian vault. Could cause problems if someone happens to be writing links formatted like Obsidian links elsewhere.
Maybe it should be an optional parameter for gf_passthrough? only_allow_in_vault or something like that.
There was a problem hiding this comment.
Since we create this keymap within the lazy setup function and we have buffer = true in the keymap options, it's already only going to be set for buffers in the vault.
README.md
Outdated
| -- Optional, keybindings. | ||
| keybindings = { | ||
| -- Overrides the 'gf' keybinding to work on markdown/wiki links within your vault. | ||
| gf_passthrough = true, |
There was a problem hiding this comment.
This is exactly what I described in my issue suggesting this, but I'm now wondering if a more robust system might be preferable? For instance, like what can be found in here.
Could potentially come up with a system like that for mappings to many of our commands with options (like passthrough) to modify their behavior from default.
One the one hand, it seems a bit more transparent in case a user might want different keybind(s) than we set in the plugin, but it also might be a waste of effort if this is the only bind we ever set up.
There was a problem hiding this comment.
Actually I like that a lot. 53ea312
…h#178) Closes epwalsh#175 Closes epwalsh#177 Closes epwalsh#173 Closes epwalsh#169 Closes epwalsh#161 Closes epwalsh#144 Closes epwalsh#138 Fixes epwalsh#136 Closes epwalsh#137 Closes epwalsh#131 Closes epwalsh#117 Closes epwalsh#130 Closes epwalsh#115 Closes epwalsh#86 Closes epwalsh#105 Closes epwalsh#70 Fixes epwalsh#176 Fixes epwalsh#174 Fixes epwalsh#160 Fixes epwalsh#158
Fixes #157.
mappingsfield to the config.mappingsfield in your obsidian.nvim config.