内容简介:Yesterday, I releasedWay too often, we let leftover TODOs slip into our main branch, which leaves your coworkers puzzles, looking at it a year from now.They’re thinking – what did I mean by “TODO: Move this to the users package”? What is the users package?
Yesterday, I released todocheck – a new kind of static code analyser for annotated TODOs.
Way too often, we let leftover TODOs slip into our main branch, which leaves your coworkers puzzles, looking at it a year from now.
They’re thinking – what did I mean by “TODO: Move this to the users package”? What is the users package? It doesn’t seem to exist anymore.
todocheck helps you fix this by forcing you to mark all your TODOs against an existing, open issue in your issue tracker.
That way, if you, at some point, close the issue, thinking you’re done, the CI pipeline will sparkle in red as there is an open, unaddressed TODO in your main branch.
No longer can developers close a half-baked issue, rushing for the weekly sprint review to say “I’m done!”.
How todocheck works
You run todocheck as a standalone binary from the root of your project and it looks for issues with the following format:
// TODO J123: Fix this typo func fuu() { ... }
In case the linked issue J123
is open, todocheck
will not report any error. In case you close the issue or it doesn’t exist, todocheck will show an error:
ERROR: Issue is closed. myproject/main.go:12: // TODO J123: Fix this typo ERROR: Issue doesn't exist. myproject/main.go:14: // TODO J321: A non-existent issue
If there is an unannotated TODO
in your code base, todocheck will also report it as a malformed TODO
:
ERROR: Malformed todo. myproject/main.go:16: // TODO - This is not a valid annotated todo
Only TODO
s with valid, open issues are allowed to exist in the codebase.
By integrating todocheck in your development workflow & CI pipeline, you can ensure that there will be no half-baked issue closed with pending TODO
s in the codebase.
Does todocheck work with my language?
You can see the list of supported programming languages here .
There is also support for various public & private issue trackers. See the list here .
But your favorite language/issue tracker is not in the list?
Then feel free to open an issue & describe your needs. Oftentimes, adding support for new languages/issue trackers is a matter of configuration, so you might see your tool in the above lists pretty soon. Here is an example of such a request.
Conclusion
If you want to learn more about included features & configurations, consult the project’s README .
Why don’t you give todocheck a try right now? Download the latest release & check out the Quickstart section to get started in no-time.
Like the project? Show some love by :star:-ing it on GitHub .
以上所述就是小编给大家介绍的《Eliminate the undocumented TODOs with todocheck》,希望对大家有所帮助,如果大家有任何疑问请给我留言,小编会及时回复大家的。在此也非常感谢大家对 码农网 的支持!
猜你喜欢:本站部分资源来源于网络,本站转载出于传递更多信息之目的,版权归原作者或者来源机构所有,如转载稿涉及版权问题,请联系我们。
Thinking Recursively
Eric S. Roberts / Wiley / 1986-1-17 / USD 85.67
The process of solving large problems by breaking them down into smaller, more simple problems that have identical forms. Thinking Recursively: A small text to solve large problems. Concentrating on t......一起来看看 《Thinking Recursively》 这本书的介绍吧!