TODO & FIXME

[lfaoro]

Why does the linter checks for TODO/FIXME statements? I thought you guys are using GitHub's Swift Style Guide as a guideline which has all rules explained.

If you add rules of your own, please document the reasoning behind it.

[keith]

If you'd like to disable this for your project you can add this to your .swiftlint.yml

disabled_rules:
  - todo

[keith]

Also the readme says:

loosely based on GitHub's Swift Style Guide

So I don't think it's a huge deal as more rules are added to SwiftLint. Especially since they can be easily disabled.

[lfaoro]

I know how to disable it, thank you though.
What I'd like to know is: Where is the reasoning behind this decision documented?

[jpsim]

What I'd like to know is: Where is the reasoning behind this decision documented?

I added that in because IMO the role of a linter is to show you the parts of your code that need your attention and ultimately need to be fixed. TODOs and FIXMEs are one way to do this.

[isadon]

@jpsim I'm not sure I understand. Are you saying the reason for the warning is to actually show and bring the todo to your attention so that you may implement the actual todo? I ask because the warning given by swift-lint seems to be to not use TODO's.

[jpsim]

Yes.

[isadon]

@jpsim The message given by Swift lint does not imply that though:

SwiftLint displays: "Todo Violation: TODOs should be avoided...."

[jpsim]

If you have an improvement in mind, feel free to file a PR.

[isadon]

@jpsill Will do!

[sbohmann]

I also first thought that it discourages using TODOs but it actually encourages them by supporting them and making them more useful through this rule :D Maybe the message should be changed to "consider doing / fixing what the TODO suggests", though ^^

[isadon]

Pull Request #2069 has been added to fix this issue.

[Andy0570]

The author's intent in adding todo to lint is that code or functionality annotated via TODO or FIXME should be refined or implemented, so by way of a warning you are reminded that there is unfinished functionality in your project.

If you want to suppress this warning, you can turn off this rule, which is on by default, in disabled_rules, and you can also use 'notaTODO' and 'notaFIXME' instead;