Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

reorder_arrays = false is ignored if the key is set to the array. #608

Open
Kladki opened this issue May 6, 2024 · 3 comments · May be fixed by #732
Open

reorder_arrays = false is ignored if the key is set to the array. #608

Kladki opened this issue May 6, 2024 · 3 comments · May be fixed by #732

Comments

@Kladki
Copy link

Kladki commented May 6, 2024

I have the following taplo.toml file:

include = ["**/*.toml"]
[formatting]
reorder_arrays = true

[[rule]]
include = ["bar.toml"]
keys = ["baz"]

[rule.formatting]
reorder_arrays = false

I would assume that the rule listed would prevent the array baz from being re-ordered, but still allow for all other arrays to be sorted.

This is my bar.toml file:

baz = ["foo", "bar", "baz"]

sort_me = ["z", "a"]

However, when running taplo fmt, bar.toml ends up like this:

baz = ["bar", "baz", "foo"]

sort_me = ["a", "z"]

As you can see, all arrays were sorted. When omitting keys, nothing gets formatted, which is not what I want.
@andrewweston
Copy link

I have a similar rule-based formatting issue. The rule works until I add the include property and then it stops being applied. It will work as expected if I use the Taplo cli.

@tv42
Copy link

tv42 commented Sep 13, 2024

It looks like keys is matching table names, not keys within a table. A rust-toolchain.toml of

[toolchain]
targets = ["zz", "x86_64-unknown-linux-gnu"]

gets targets sorted with

[[rule]]
include = ["rust-toolchain.toml"]
keys = ["toolchain"]

[rule.formatting]
reorder_arrays = true

but not with

keys = ["components", "targets"]

or

keys = ["toolchain.components", "toolchain.targets"]

@tv42
Copy link

tv42 commented Sep 13, 2024

Of course, one table might have both a key I want array sorted and a key I don't, so I feel like Taplo must support tablename.keyname there.

@rmburg rmburg mentioned this issue Jan 11, 2025
Open
rmburg added a commit to rmburg/taplo that referenced this issue Jan 11, 2025
@rmburg
Allow rules to target individual entries
9f62e95 
Fixes tamasfe#608
@rmburg rmburg linked a pull request Jan 11, 2025 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Allow rules to target individual entries rmburg/taplo
3 participants
@tv42 @andrewweston @Kladki