[unstable option] `imports_granularity`

[9999years]

Tracking issue for unstable option: imports_granularity.

Option documentation.

See Processes.md, "Stabilising an Option":

• Is the default value correct?
• The design and implementation of the option are sound and clean.
• The option is well tested, both in unit tests and, optimally, in real usage.
• There is no open bug about the option that prevents its use.
  • Import sorting does not handle uppercase/lowercase consistently #5269
  • fix(import_granularity): do not merge aliases #6028
  • bug: imports_granularity = "One" deletes aliases #6027
  • imports_granularity is not respected for #[cfg]'d items #6666
  • imports_granularity=One removes macro imports that share names with modules #6717
  • imports_granularity = "Module" merges top-level modules into a single use statement #6191
  • imports_granularity=Item removes #[cfg()] attribute from imports #5030
  • imports_granularity = "Module" causes compile error when path contains self #4681
  • fix: imports_granularity module with path containing self #5253
  • imports_granularity = "Module" doesn't work if module path is too long #6164
  • import_granularity: Don't normalize imports with comments #5311
  • Backport 4406 + 4536 #5296
  • Formatting pre and post cast comments enhancements #4406
  • fix: between span derivation on cast exprs #4536
  • Rustfmt removes comments in uses #3984
  • Do not remove comment from an import with a single item #3999
  • Group imports together with imports_granularity results in non-idempotent formatting #6195
  • group_imports reorders use statements arounds comments, changing their meaning #6241
  • strange behavior for duplicate imports with imports_granularity="Module"  #6243

[Tamschi]

When using

unstable_features = true
imports_granularity = "Crate"

, cargo +nightly fmt will currently remove comments like this:

use triomphe::{
	Arc,
	// This crate walks along the graph a whole lot and normally doesn't do much refcounting,
	// so the offset version is likely a bit better here.
	//
	// This is unbenched though. Someone might want to check.
	OffsetArc,
};

❯ cargo +nightly fmt --version
rustfmt 1.4.37-nightly (a8f2463c 2021-10-09)

(I wasn't sure whether this deserves its own issue.)

[calebcartwright]

The dropping of comments with the various options that manipulate imports is a known issue, and one of the hurdles that will have to be overcome before the options, including this one, can be stabilized.

It is good to have an inline example here too though, so thank you @Tamschi

[Xuanwo]

Hi, is there any progress to make this option stable?

[calebcartwright]

Hi, is there any progress to make this option stable?

The absence of updates should be explicitly interpreted as meaning that there are no updates. The process and requirements for stabilizing an option are both linked, and enumerated with checkboxes, in the issue description and will be updated as-and-when there are updates to share

I appreciate the interest folks have in being able to use an option on stable. However, this remains a relatively new option with many well known bugs, and as stated above, is not going to be eligible for stabilization any time soon.

[Nutomic]

For what its worth, we have been using imports_granularity="Crate" in Lemmy for over a year without any problems. Though we dont put any comments around imports.