feat(action): add github action for cargo.toml formating

[gwen-lg]

Note: this is a first version for comments

It's great to have Cargo.toml (by example) formatted on save in VSCode. But If it's not checked in CI, this is dependent of developer use Even Better TOML and process.

TODO:

• manage config with indent_string=" " for Cargo.toml (like Even Better TOML)
• convert output to display beautiful error/warning in github
• feature for allow automatic patch commits ?

#470

Work inspired from https://github.com/marketplace/actions/typos-action

[tobiasdiez]

Thanks, great initiative! A few suggestions from a cursory read of the diff.

[tobiasdiez]

I think it would be more universally useful to make the files required and don't specify a default.

[tobiasdiez]

Would be great to also have support for taplo check. And perhaps rename format to fmt (at least the docs seem to prefer fmt).

[gwen-lg]

as fmt is an alias for format, it's seems most logical to me to use format unless fmt presented as preferred way ?
I haven't explored the check/lint functionality, what it the interest in CI ? What you think it's should do ? How should it be integrated ?

[tobiasdiez]

I cannot say anything about the preference of fmt vs format except that the docs seem to only mention fmt

The check would work similarly as for fmt: run taplo check, if it reports a problem fail. So my proposal would be to add two boolean toggles (both defaulting to true?), each for enabling/disabling the the fmt and check run.

[gwen-lg]

I have managed --check option of format command. There is a difference between format --check and check ?

[panekj]

Commands:
  lint         Lint TOML documents [aliases: check, validate]
  format       Format TOML documents [aliases: fmt]

[tobiasdiez]

See also https://taplo.tamasfe.dev/cli/usage/validation.html

[gwen-lg]

Ok, thanks.

[panekj]

Taplo is already usable in GHA via uses: docker://tamasfe/taplo

[JounQin]

Does it work for Windows?

[gwen-lg]

I haven't tested, but It's inspired from typos GHA, so it's should be.

[gwen-lg]

Taplo is already usable in GHA via uses: docker://tamasfe/taplo

Do you prefer a GitHub Action based on docker image, instead of release files ?

I found no documentation about how to use taplo in GitHub Workflow. So a dedicated GitHub Action might be helpful to users.

[tobiasdiez]

Docker-based actions are not available for macos and windows (based on https://docs.github.com/en/actions/sharing-automations/creating-actions/about-custom-actions#types-of-actions)

[panekj]

If it's going to be action then it should just run taplo, adding commands checking and file arguments is super awkward when the configuration is supposed to live in /taplo.toml (or /.taplo.toml)

- uses: taplo
  with:
    format: true/false
    lint: true/false

[panekj]

Although I think I'd prefer it to be in NodeJS and not shell

[gwen-lg]

If it's going to be action then it should just run taplo, adding commands checking and file arguments is super awkward when the configuration is supposed to live in /taplo.toml (or /.taplo.toml)

- uses: taplo
  with:
    format: true/false
    lint: true/false

I'm ok with this, I can update action in this direction.

Although I think I'd prefer it to be in NodeJS and not shell

I am not against it, but I haven't the knowledge to do this. So unless it's really simple and has examples to guide me, someone else will have to do it.

[gwen-lg]

@panekj : I have updated with simpler version.
I have keep the setup of version, and format_write_changes this second can also be removed if it's preferred.
I have add a small part for doc in README.md, I haven't take time to create a page in website documentation, perhaps it's better/or complementary to README.md.