Enable the ordered imports rule in swift-format

Question

Enable the ordered imports rule in swift-format

Closed this issue a year ago · 9 comments

AFAIK swift-format has a rule to force import statements to be ordered lexicographically. But that rule doesn’t appear to be enabled in this repository. W should enable it.

Answer 1 · 2023-09-01T20:53:40.000Z

Mind if I use this one as a reason to read more about swift-format rules and set it up?

Answer 2 · 2023-09-01T20:55:42.000Z

Sure, go ahead.

Answer 3 · 2023-09-01T21:19:33.000Z

I recall that in one of the PRs with @kimdv and @ahoppen , we discussed how sometimes we skip the return keyword in the codebase, and sometimes we don't. At that time, swift-format didn't have a rule for this, but that's changed. There's now a rule to omit the return keyword whenever possible.

So the question is, do we want to adopt this rule?

Answer 4 · 2023-09-01T21:43:14.000Z

Tracked in Apple’s issue tracker as rdar://114841762

Answer 5 · 2023-09-01T23:34:47.000Z

It would definitely be interesting to see what the code looks like with the implicit return rule enabled. I think I commented somewhere that I‘m personally not a fan of omitting the return but consistency is more important than my personal preference.

Answer 6 · 2023-09-02T21:13:23.000Z

#2145 adds OrderedImports, but I'll push up another commit to it with implicit returns so we can take a look at the code and see if we like it.

Interesting finds:

swift-format will not complain if you make a typo in a rule name. I made a typo OrderedImpora and ran ./format.py and it didnt' output anything, and didn't change any files, of course — would be nice to have a warning form swift-format. I'll file an issue and make a PR.
swift-format dump-configuration dumps the default json config, but does not explain what each rule does. It would be nice to have a comment with each of the config settings that summarizes how it works. Again, easy PR probably.

Answer 7 · 2023-09-02T21:36:06.000Z

Follow-up swift-format issues:

Comments in dump-configuration: swiftlang/swift-format#606
Detect mistakes in the Rules configuration: swiftlang/swift-format#607

Answer 8 · 2023-09-07T01:51:39.000Z

So, the ordered imports rule PR is merged in (#2145). Since omitting returns is unlikely to get merged, I think we should close this issue, @ahoppen.

Both follow-up issues in swift-format have pending pull requests, and I think those are going to get merged in later this week, too. 🥳

Answer 9 · 2023-09-07T06:15:01.000Z

Thanks @natikgadzhi 😁

Resolved by #2145

You can btw write things in PR like "Fixes #issueNumber" or "Resolves #issueNumber". When then merging a PR it will automatically close the issue