We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
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.
<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
To reduce user errors and confusion (when comment sources are silently ignored), I propose:
// Todo: Do a thing <Marking purpose="TODO" description="Do a thing" />
TODO
todo
Fixme
fixme
The text was updated successfully, but these errors were encountered:
No branches or pull requests
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:
@markings/source-react
Requires purposes to be in lowercase, else will throw an error.
✅ Works:
❌ Throws an error:
Proposal
To reduce user errors and confusion (when comment sources are silently ignored), I propose:
TODO
becomestodo
, andFixme
becomesfixme
, etc)The text was updated successfully, but these errors were encountered: