use a formatter / have formatting guidelines?

[msparkles]

Please check existing knowledge before opening an issue

• I have checked the documentation
• I have searched through existing issues and discussions.

Describe the new functionality

(could not find a suitable template, could not make an issue without a template, apologies in advance.)

We're looking to implement some feature for multi-scrobbler, but could not find a formatter config file or some formatting guideline, or any documentation on code formatting.

Can we use some kind of formatter so the code can be both consistent and not manually formatted?

Configuration Example

Will you help implement it?

• I am willing to contribute code towards completing this feature
• I am willing to help test preview builds for this feature

[FoxxMD]

I've created two branches with different solutions

• https://github.com/FoxxMD/multi-scrobbler/tree/formatting-biome
• https://github.com/FoxxMD/multi-scrobbler/tree/formatting-eslint (uses prettier for formatting)

After trying both I prefer biome since I can replace eslint as well but the vscode extension seems to have an issue where formatting selection within a class just formats the entire file instead, which is inconvenient.

Do you have any suggestions for other tools or configurations of either of these?

I realize I should have had something from the beginning but the problem I have with adding a formatter into an existing project is that blaming lines becomes useless after a whole-project format, or even individual file formats, since so many lines get changed.

[msparkles]

but the problem I have with adding a formatter into an existing project is that blaming lines becomes useless after a whole-project format, or even individual file formats, since so many lines get changed.

Yeah, for that it is quite inconvenient, but it does (hopefully) make future blames more consistently useful, given that a specific format is used. The allowed chars-per-line might need to be tweaked though, if the lines get shifted around too much currently.

I haven't used biome before, I've stuck to prettier since it has been working for me. Maybe you can ask contributors, if there's any persistent contributors to the project.
You can use prettier without eslint afaik, there's also a vscode extension for just prettier and no eslint integration.

Adjusting the line width might be helpful for keeping the lines more intact, or changing the git diff algorithm used (this can be set per repo, I think you can also match on the file path like in .gitignore) so the blame can make more sense after the formatting changes.

[FoxxMD]

Saving this for later... https://medium.com/@ramunarasinga/git-blame-ignore-revs-to-ignore-bulk-formatting-changes-f20ac23e6155