rougier / mu4e-dashboard

A dashboard for mu4e (mu for emacs)
GNU General Public License v3.0
463 stars 42 forks source link

Make the link type customizable (Issue #7). #13

Closed sp1ff closed 3 years ago

sp1ff commented 3 years ago

The present, the hard-coded link type "mu4e" will clash with that defined by 'org-mu4e'. Since users have presumably already authored dashboards using the "mu4e" link type, this commit doesn't change that; it instead makes the link type defined by 'mu4e-dashboard' customizable with a default of "mu4e". This will allow existing dashboards to continue to work, while also allowing user to change it if they so desire. Perhaps at a later date, say when this packge reaches 1.0, we can pick a new link type and standardize on that.

This commit will also address issue #6 by replacing the use of the deprecated 'org-add-link-type' with 'org-link-set-parameters').

sp1ff commented 3 years ago

Continuing the conversation from @omar-polo 's PR (now closed), I gather there is an existing consensus that the link name needs to be changed (to avoid conflicting with the one defined by mu4e [which I use heavily BTW]). My question for the existing contributors: are you OK just changing it and breaking all the existing dashboards that today use "mu4e:..."? My thinking behind making it customizable, with a default setting of "mu4e" was that it would be a non-breaking change, but allow users to avoid the conflict with "mu4e" today. Then, as this package matures (maybe towards 1.0 status), the maintainer and community would pick something else ("mu" or "mudash" or whatever) and begin moving toward that (e.g. by making mu4e-dashboard-link-name deprecated via define-obsolete-variable-alias). OTOH, if you are OK with breaking existing dashboards, then by all means let us pick the new name now & get the pain over with. What say you @rougier ?

rougier commented 3 years ago

I think we can break compatibility just now since I don't think there's a large user base. Also, it's only a matter of changing the default link type now. The example dashboard would need to be changed though.

sp1ff commented 3 years ago

What shall the new link type name named? Also, I'm not clear on your suggestion, @rougier: are you saying we should just pick a new name & use it unconditionally, or that we should keep this PR as-is (i.e. link type is customizable), but make the default value of mu4e-dashboard-link-name be the new name (and not "mu4e")?

rougier commented 3 years ago

I meant that we can got to a configurable link name and use the new default "mu".

sp1ff commented 3 years ago

PR updated with the feedback in this conversation (including updating the sample dashboards).

rougier commented 3 years ago

Nice, thank you.