Hard to track changes across multiple versions

[gaeljw]

Hello folks,

I wanted to share with you a problem that I currently face in upgrading scalafmt config files from 2.x to 3.x (or even from 3.2 to 3.9 for instance). Note that we're a bit late in upgrades because it's quite recent that Renovate suggests scalafmt config file version upgrades.

There's no unique page to search for configuration removal or renaming. There was https://scalameta.org/scalafmt/docs/changelog.html before but since 2.7 the changelog is on GitHub and one has to go through many pages to maybe find information about a change.

For instance, I have a config file using unindentTopLevelOperators = true, how can I know that the new setting to use is indent.infix.exemptScope = all?

I need to find out that in:

• 3.4.0, there was a change to indentOperator.exemptScope = all; already page 5 of GitHub releases
• and then in 3.8.4 there was a change to indent.infix.exemptScope = all ; this one is not in the changelog but looking at https://scalameta.org/scalafmt/docs/configuration.html#indentinfix and searching in the page can give you a hint

My suggestion would be to still publish a unique changelog page that we can search in.

Any though about this?

[tgodzik]

It might be easier to remove all settings and then try to add new ones to minimize the diff. Or just not care too much about it and add the commit to ignored by blame. Tracking the changes over so much time, might be difficult even with a full changelog.

[gaeljw]

That's fair. If it was only me, I'd leave almost everything to the default value 😅

[tgodzik]

another option is maybe try copilot for the rewrite? it was basically trained on this stuff.