more fully override imenu configuration when using outshine's imenu #93
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
When using outshine's imenu functionality (from either `outshine-imenu` or `outshine-imenu-with-navi-regexp`), the variables that configure imenu behavior are locally overwritten in a `let*` form. However, it's important to also restore the default setting of `imenu-create-index-function` (which should be `imenu-default-create-index-function`). I noticed this bug when editing `R` files in `spacemacs`: the `lsp` configuration involves changing the value of `imenu-create-index-function`, which makes changes to the other variables inconsequential, and then outshine's attempt to change the way imenu works by binding `imenu-generic-expression` has no effect.
|
I don't use Outshine regularly enough anymore to be familiar with its internals, but this seems simple enough, so I'll go ahead and merge it. Thanks very much. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When using outshine's imenu functionality (from either
outshine-imenuoroutshine-imenu-with-navi-regexp), the variables that configure imenu behaviorare locally overwritten in a
let*form (so thatimenuwill pick up onoutshineheadings rather than whatever tags would normally be used). However, I think it misses one key variable: it's important to also overwriteimenu-create-index function, since if that is changed it essentially nerfs any of the other configuration (see the end part of the documentation.I noticed this bug when editing
Rfiles inspacemacs: mylspconfiguration involves changing the value of
imenu-create-index-function,which makes changes to the other variables inconsequential, and then outshine's
attempt to change the way imenu works by binding
imenu-generic-expressionhasno effect.
I don't currently use
navimode, but I made an analogous fix inoutshine-imenu-with-navi-regexpwhich I assume would suffer from the same issue.I'm happy to also open an issue if it's preferred to have discussion over there, but figured I'd start with the PR since I already had a fix.