-
Notifications
You must be signed in to change notification settings - Fork 1
Open
Description
Problem Description
Currently, purposes must have a particular case to be detected / valid, which differs depending on the source:
@markings/source-comments
Requires purposes to be in uppercase to be detected. Anything else will be silently ignored.
β Works:
// TODO: Do a thingβ Silently ignored:
// todo: Do a thing
// Todo: Do a thing@markings/source-react
Requires purposes to be in lowercase, else will throw an error.
β Works:
<Marking purpose="todo" description="Do a thing" />β Throws an error:
<Marking purpose="Todo" description="Do a thing" />
<Marking purpose="TODO" description="Do a thing" />Error: Purpose must be one of question, todo, fixme
Proposal
To reduce user errors and confusion (when comment sources are silently ignored), I propose:
- Make all purposes case insensitive:
// Todo: Do a thing <Marking purpose="TODO" description="Do a thing" />
- Normalise the output of all purposes to lowercase (so
TODObecomestodo, andFixmebecomesfixme, etc)
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels