minimap
minimap copied to clipboard
atom-minimap
Remove plugin decoration rendering order config
There is unnecessary complexity in the decoration management/rendering code to render the decorations based on an order. However, this seems unnecessary to me as decorations can perfectly be shown on top of each other and they do not have conflicts. The default for all of them is 0 which means until today by default no ordering has been applied. But the code is still there slowing down the rendering.
This config does not make sense to me and just adds complexity and slow-down.
Instead, I am considering drawing the decorations in this order instead of calculating the order dynamically every time. Rendering in this order does not result in any conflict.
- line
- highlight-under
- highlight-over
- highlight-outline
- gutter
- background-custom
- foreground-custom
I would need some time to do more research. I can see why someone would like to have a specific order of plugins so more important ones show on top. I don't know if anyone actually uses it or which plugins would actually benefit from it.
I would need some time to do more research. I can see why someone would like to have a specific order of plugins so more important ones show on top. I don't know if anyone actually uses it or which plugins would actually benefit from it.
I doubt that anyone uses it. This config is so minor probably no one will notice a difference.
In the future, if we wanted to add support for a brand-new decoration type that absolutely needs to be placed in a certain place, we should add the code inside the dispatcher. The customizability for the users (not developers) has no point here, and so I think the config should be removed.
Prototype for the dispatcher implementation (WIP): https://github.com/atom-minimap/minimap/blob/633611c336aa611662d44b908c597055efab3177/lib/mixins/canvas-drawer.js#L762
I agree it probably isn't used by many users (I didn't even know it existed) but I could see it being used by a few users. This actually solves a problem I was having seeing find-and-replace decorations even when the cursor-line decoration is on the same line. Without this ordering the cursor-line decoration covers the fin-and-replace decoration even though find-and-replace is more specific.
I feel like we need to figure out a way to keep user defined ordering for power users, even if it isn't this setting.
Is there some way we can look at which decoration is smaller and place it on top?
I feel like we need to figure out a way to keep user defined ordering for power users, even if it isn't this setting.
I think if anyone really wants to modify an internal behavior of Minimap, they should modify the code. Making things dynamic is not good all the time, and here, for example, it results in a slow-down in each scroll movement. I prefer that most users get a better experience over a few users wanting to change the Z index of elements.
Is there some way we can look at which decoration is smaller and place it on top?
The current order is buggy and that's why I want to change it so the specific decorations to be always on the top. Hopefully, my prototype will fix this.
Is this something where we can move the sorting to when the decorations get added instead of on each draw? Then the scroll speed is not affected correct?
I am bumping the major version in #798 by removing some of the legacy functions. It might be a good thing to include #761 in this major bump too.
I actually think the plugin order is necessary. how else is it possible to always show find-and-replace above cursor-line? (Which I think it obviously should). I'm fine with it not being user defined but we need some way for plugins to have a well defined priority.