Configure notifications by type

hackjutsu / Lepton

💻 Democratizing Snippet Management (macOS/Win/Linux)

https://hackjutsu.com/Lepton

MIT License

10.14k stars 475 forks source link

Configure notifications by type #422

Closed dideler closed 4 years ago

dideler commented 4 years ago

I have most notifications on all my devices reduced to a minimum. To reduce notification fatigue, I'm only interested in important notifications. For Lepton, I'm only interested in exceptional notifications, i.e. where the expected result hasn't occurred. I think it's especially important for macOS because these notifications cannot be force closed.

Tasks

[x] Add structured configuration for notifications by type so it's extendable
[x] By default, all notification types are turned on
[x] Document notification configuration options
- [x] README
- [x] Wiki: https://github.com/hackjutsu/Lepton/wiki/Configuration
[x] Deprecate or immediately remove disableNotification option
- No longer needed, can achieve similar behaviour with config for notification types, or can already block all app notifications at the OS level
- Wasn't documented anywhere except in #382, so may only affect a small number of users

dideler commented 4 years ago

BTW haven't yet soft-deprecated the disableNotification option because I'd like to get your thoughts on that first, and because I don't know where to put the notice besides the release notes since the option was never documented.

hackjutsu commented 4 years ago

Hi @dideler , it's my bad to forget mentioning the disableNotification here. We can move the it to README or Wiki if that works better.

I like your approach to distinguish success and failure notification and their configurations. We can deprecate the disableNotification field and use your solution instead. The impact should be minimal since we didn't document this field 😅 cc the original PR author @alexandreamadocastro for awareness.

dideler commented 4 years ago

Hey @hackjutsu, I'll go ahead and remove disableNotification now to simplify things.

I noticed there's already a project wiki, but I don't have permissions to edit it. In order to document the config changes, could you either change the wiki permissions, or alternatively, we can move the config docs somewhere in the code repo and then I won't be blocked.

hackjutsu commented 4 years ago

@dideler The wiki permission is updated. Let me if it works.

dideler commented 4 years ago

@hackjutsu wonderful, thank you! I've created a wiki page, moved over the existing content, added missing options, added the new notifications option, and updated the README.

I think this merge request is good to go now.

hackjutsu commented 4 years ago

Cool, thanks for the contribution!