Add taplo pre-commit hook to format and sort toml files

[user27182]

Overview

toml files are not currently formatted or sorted. This enables things like:

pyvista/pyproject.toml

Lines 69 to 74 in a71e027

	typing= [
	'pyvista[pinned]',
	'numpy>=2.0.0',
	'mypy<1.14.0',
	'npt-promote==0.1',
	]

Where spaces around = are not enforced and where alphabetical sorting is not enforced (we have n->m->n order in the example)

This PR uses https://github.com/pappasam/toml-sort https://github.com/tamasfe/taplo to fix and enforce the formatting and sorting.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.49%. Comparing base (654782a) to head (d0eb514).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #6781   +/-   ##
=======================================
  Coverage   97.49%   97.49%           
=======================================
  Files         143      143           
  Lines       28177    28177           
=======================================
  Hits        27472    27472           
  Misses        705      705           

[user27182]

If it's desirable to have separate PRs, one for formatting and another for sorting, we can remove sort_inline_arrays = true and add this line in a separate PR

[pyvista-bot]

🚀 Deployed on https://6733dd6f9423ca045b96fe0e--pyvista-dev.netlify.app

[tkoyama010]

+100 sorting TOML files. However, could you consider whether using Taplo might be a better option compared to toml-sort?

[user27182]

+100 sorting TOML files. However, could you consider whether using Taplo might be a better option compared to toml-sort?

I have no preference, taplo seems to have similar options https://taplo.tamasfe.dev/configuration/formatter-options.html, so we could probably use it instead

[user27182]

With fb0df95 I opted not to use indent_string, so the default indent of 2 spaces is used. This is also the default for toml-sort. I think it's okay to use the default 2 spaces, but we can use 4 if preferred

Suggested change

	args: [--option, "reorder_arrays=true"]
	args: [--option, "reorder_arrays=true", --option, "indent_string= "]

Have a look at the other options, are there any else we should include (can also add options in a separate PR)

[user27182]

The diff is better with "indent_string= " enabled if that's desired (i.e. fewer formatting changes). It's easier to see the sorting that way.

[tkoyama010]

+1 using default.

[tkoyama010]

pre-commit.ci autofix

[tkoyama010]

LGTM

[user27182]

Is this a bug with the sorting? We have p before e, not a huge deal but not expected either.

Edit: looks like the comment between items may have thrown it off

[tkoyama010]

Following #6782, let's move comment inline. Additionally, it may be helpful to consider submitting an issue to Taplo regarding why the sorting functionality is not working as expected.

[user27182]

Following #6782, let's move comment inline.

Fixed in d0eb514

Additionally, it may be helpful to consider submitting an issue to Taplo regarding why the sorting functionality is not working as expected.

Apparently having full-line comments split up the sorting is the expected behaviour, see tamasfe/taplo#675

So we should generally avoid using any full-line comments in any toml files with this tool.

[tkoyama010]

Following #6782, let's move comment inline. Additionally, it may be helpful to consider submitting an issue to Taplo regarding why the sorting functionality is not working as expected.