ci: format TOML files using taplo and enforced CI formatting

[Cyber-Lord]

Pull Request Checklist

Please confirm the following before requesting review:

• I have disclosed my use of
  AI
  in the body of this PR.
• I have read CONTRIBUTING.md and rebased my branch to produce hygienic commits.

In this PR, I have used ChatGPT to research available formatting tools, compared them and identified best fit for this issue #1016
The PR aims to close #1016 by formatting and sorting the TOML files in the repository and introduced a check on CI to enforce formatting. taplo is used for this and ensured consistent whitespace, indentation, and ordering across all TOML files.

Added to the GitHub Actions workflow to run taplo format --check on pull requests and pushes to main. This will ensure future PRs don’t introduce formatting inconsistencies in TOML files.

[nothingmuch]

I verified that formatting with taplo results in almost the same TOML files, the comitted ones additionally sort things (presumably CI enforcement of that is in a followup PR?)

This shouldn't be a problem in CI, but in a local env note that running taplo format with direnv in use will find sources in the nix store which are readonly, and error if any toml files therein are inconsistent, that includes any toml file from any package that might end up in the devshell so it's an annoying false positive. I don't see a straightforward way to ignore .direnv, -o exclude=.direnv or -o exclude=.direnv/**/*.toml don't work, i suspect it needs to be added to a config file and TAPLO_CONFIG set in .envrc in order for it to work out of the box with no additional config.

I just used taplo format $( git ls-files | grep '\.toml$' ). If you want to add taplo to devshell in flake.nix you could additionally include a definition for a taplo flake app, so that nix run .#taplo will do the right thing (either use git ls-files or add an exclusion).

[coveralls]

Pull Request Test Coverage Report for Build 17336950193

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

• For more information on this, see Tracking coverage changes with pull request builds.
• To avoid this issue with future PRs, see these Recommended CI Configurations.
• For a quick fix, rebase this PR at GitHub. Your next report should be accurate.

Details

• 0 of 0 changed or added relevant lines in 0 files are covered.
• No unchanged relevant lines lost coverage.
• Overall coverage remained the same at 85.916%

---

Totals
Change from base Build 17332008623:	0.0%
Covered Lines:	8168
Relevant Lines:	9507

---

💛 - Coveralls

[nothingmuch]

this will probably generate conflicts for some other PRs, to help merge this with minimum friction please also split it into two commits, one to apply the formatting, which includes the precise command to run (look into bitcoin core's scripted diffs for a standard way to do this), and then the small commit to enforce. this way rebasing it can be automated to avoid conflicts (by replacing the pick abc123, the formatting commit, with an exec taplo format $( git ls-files | grep '\.toml$' ) && git commit -a -C abc123)

[Cyber-Lord]

There are some unintended changes caused in some rust files. I will undo then and improve the commits asap

[nothingmuch]

i don't see changes to rust files FWIW, but either way to eliminate the merge commit i would suggest the following:

1. git remote update and then git reset --hard origin/master
2. format all the toml files using taplo format $( git ls-files | grep '\.toml$' ), and git commit -a -C f29970d051a6d62ef6968d14b91a2d2cf8e66f37 (update: oops i wrote this before fixing the config file, git ls-files no longer necessary so the commit message should be updated, and the config file commit should be cherry-picked before this step)
3. git cherry-pick 765cff7ffddf427ef88ee39c368c6bf679ded828

please also add taplo to the packages list in the devshells in flake.nix

since it detects a config file in the workspace root then tere's no need to setup TAPLO_CONFIG env var like i suggested before, and a nix flake app also seems a bit superfluous (though we might want a fmt program that runs rustfmt, taplo, shfmt, and whatever is a la mode for python these days, but that's definitely for a future PR and not this one)

however the config file does need some corrections in order to have the desired effect

[nothingmuch]

see https://github.com/jonatack/bitcoin-development/blob/master/scripted-diffs.md for a description, it just makes it easier to verify that large diffs do exactly what they are supposed to

the first one is not a scripted diff as it can't be recreated by just running the command, if i switch to it reset all the toml files to be as they were in the previous commit apart from the taplo.toml file that is introduced, i still can't reproduce the diff exactly since there is some reordering presumably by cargo sort

sorry to be a stickler about this but there are multiple PRs that are already open that change dependencies and therefore will conflict with this PR, to avoid blocking those PRs i prefer if we wait with merging this one, making it really a scripted diff means it's trivial to rebase this commit without having to deal with conflicts when it's time to do so

if you prefer i could do this for you and rebase it when it's time to merge this (i could also add the flake stuff)

[Cyber-Lord]

Sure @nothingmuch Thank you

[arminsabouri]

Couple weeks without activity on this PR.
@Cyber-Lord / @nothingmuch Are you still planning on working on this?

[nothingmuch]

This PR was effectively folded into #1221... Thanks @Cyber-Lord and sorry for taking so long to merge your changes