[unstable option] report_todo

[scampi]

Tracking issue for report_todo

[tangmi]

I'm unsure if this is the right place for these comments, but I love report_todo and am wondering what work needs to be done to stabilize it?

[topecongiro]

@tangmi Sorry for the late reply, but actually, this option is something that I would like to remove from rustfmt. This option is not related to formatting and can be replaced with other tools like rg TODO.

[tangmi]

@topecongiro Makes sense, based on rustfmt's scope, but sad to see it go. Being able to use report_todo without having to install anything additional in CI scenarios was really handy!

[mathstuf]

Note that it has some eager behaviors today and catches structures and variables named todo today.

[tangmi]

I wonder if something changed (I haven't followed the history pre-crate split)?

Here is where rustfmt matches on the "todo" string:

rustfmt/rustfmt-core/rustfmt-lib/src/issues.rs

Lines 123 to 137 in 1e9af9f

	if is_enabled(self.report_todo) && lower_case_c == TO_DO_CHARS[todo_idx] {
	todo_idx += 1;
	if todo_idx == TO_DO_CHARS.len() {
	return Seeking::Number {
	issue: Issue {
	issue_type: IssueType::Todo,
	missing_number: if let ReportTactic::Unnumbered = self.report_todo {
	true
	} else {
	false
	},
	},
	part: NumberPart::OpenParen,
	};
	}

... and where it calls into that code:

rustfmt/rustfmt-core/rustfmt-lib/src/formatting.rs

Line 523 in 1e9af9f

if let Some(issue) = self.issue_seeker.inspect(c) {

It seems like in formatting.rs/issue.rs needs to keep track of whether or not the TODO exists in a comment (or if doing something like unimplemented!("TODO(#1234): ...") or todo!("TODO(#1234): ...") is intended behavior...

[karyon]

Reopening, 2.0 is not happening and current docs are still pointing to this issue.

This has been implemented by clippy in the meantime: https://rust-lang.github.io/rust-clippy/master/#todo

[calebcartwright]

Reopening, 2.0 is not happening and current docs are still pointing to this issue.

This has been implemented by clippy in the meantime: https://rust-lang.github.io/rust-clippy/master/#todo

Thanks @karyon. Couple minor additions/tweaks, I don't want to convey that 2.0 will never happen, it's just increasingly unlikely that it will happen outside an entire Rust ecosystem 2.0, and certainly going to happen any time soon, refs #5018

Additionally, this option and the associated behavior is a bit different from the clippy lint, as rustfmt actually looks for textual TODOs in comments, whereas clippy is just looking for the macro usage.

I think there's still a strong argument for us to drop this from rustfmt (it's quite orthogonal to formatting of code) and we may still do so

[calebcartwright]

Going to close this because stabilization doesn't make sense given our intent to deprecate and remove the option, refs #5101