remark-lint icon indicating copy to clipboard operation
remark-lint copied to clipboard

Combine severity types

Open jablko opened this issue 3 years ago • 5 comments

Initial checklist

  • [x] I read the support docs
  • [x] I read the contributing guide
  • [x] I agree to follow the code of conduct
  • [x] I searched issues and couldn’t find anything (or linked relevant results below)
  • [x] If applicable, I’ve added docs and tests

Description of changes

Another unimportant change: What do you think about adding the severity string literals to the Severity type? The purely-numeric type ({0|1|2}) is an internal detail, I think?

jablko avatar Apr 01 '22 17:04 jablko

Hi! It seems some of the things asked in the template are missing? Please edit your post to fill out everything.

  • [ ] Initial checklist (todo)
  • [x] Description of changes

You won’t get any more notifications from me, but I’ll keep on updating this comment, and remove it when done!

If you need it, here’s the original template
<!--
  Please check the needed checkboxes ([ ] -> [x]). Leave the
  comments as they are, they won’t show on GitHub.
  We are excited about pull requests, but please try to limit the scope, provide
  a general description of the changes, and remember, it’s up to you to convince
  us to land it.
-->

### Initial checklist

*   [ ] I read the support docs <!-- https://github.com/remarkjs/.github/blob/main/support.md -->
*   [ ] I read the contributing guide <!-- https://github.com/remarkjs/.github/blob/main/contributing.md -->
*   [ ] I agree to follow the code of conduct <!-- https://github.com/remarkjs/.github/blob/main/code-of-conduct.md -->
*   [ ] I searched issues and couldn’t find anything (or linked relevant results below) <!-- https://github.com/search?q=user%3Aremarkjs&type=Issues -->
*   [ ] If applicable, I’ve added docs and tests

### Description of changes

TODO

<!--do not edit: pr-->

Thanks, — bb

github-actions[bot] avatar Apr 01 '22 17:04 github-actions[bot]

Can you fill out the checklist in the template? :)

wooorm avatar Apr 01 '22 18:04 wooorm

  • [x] Sorry, filled out now. :+1:

jablko avatar Apr 01 '22 18:04 jablko

Meh, I feel like they’re semantically a different thing?

  • Severity is the number with meaning
  • Label are word that map to certain of those numbers

What’s the reason you want to make this change? What does it improve?

wooorm avatar Apr 04 '22 08:04 wooorm

Does the difference matter? Outside of the implementation true, 'on', 'warn', and 1 don't feel different? Replacing boolean|Label|Severity with Severity simplifies the types/signatures a little bit.

What does it improve?

Little, admittedly. :grimacing:

I'm happy to let it go if you'd prefer not to.

jablko avatar Apr 04 '22 18:04 jablko