Closed a-velasco closed 2 months ago
As a general question, will Vale also allow you to make replacement suggestions for words on the naughty list?
@s-makin Yes, that's definitely an option. I considered it, but I had a hard time coming up with context-agnostic suggestions. (Is agnostic another cliché? I see them everywhere now.)
I don't like how uninformative the message "Avoid the phrase %s" is, so it might be nice to add suggestions if we can somehow make them all the same format.
My unofficial list was:
- allows : simply list the options/parameters
- ability to : can
- able to : can
- not only, but also : just list the things
- eliminate : remove
- execute : run
- terminate : stop
- kill : stop? unless referring to PIDs, then killing is fine?
- disrupt : just throw away the whole sentence
- leverage : use
- harness : use
- ecosystem : environment? also overused and poorly defined, but already an improvement
- go forward : advance
- in order to : to
- form factor : hardware
- explosive : bombastic (no clue here)
- use case : dunno, i kinda find this one useful
- end user : user
- linux for human beings : linux
- thing : choose a more specific noun
- next level : "next step", or "improve" if you're *taking* something to the next level
- space : choose a more specific noun
This is great work, thanks for all the thought you have put in to this. I guess ultimately a lot of this comes down to context and we have to let the author/reviewers be the arbiters of whether they use words or not. I was toying with suggesting alternatives or explaining a bit more, but they can just look up the Style guide if they are unsure!
Added Vale rule 20: Cliché words and phrases to avoid
Implementation
Tokens are based on the style guide plus some suggestions:
"space"removedSome regex was added to catch different declinations.
Testing
Tested locally with the following markdown text:
output: