Skip to content

Add 'taplo' to the CI workflow to check the formatting of Cargo.toml files #497

@ebma

Description

@ebma

Context

There is a tool called taplo that can check and format TOML files. Since different IDEs by default have different rules for formatting TOML files, we want to streamline the formatting by using this tool.

TODO

There is no precommit hook for the pendulum repository yet and it's probably good enough to check for the formatting in the CI and leave it to the developers to run taplo fmt locally before creating the PR.

  • Add taplo to the automated build checks in the Github CI workflow. Only check for wrong formatting with taplo fmt --check but don't correct the formatting in the CI
  • Add a configuration file. We can put it into .config/taplo.toml and draw inspiration from the one used for the polkadot-sdk here
  • Add instructions to install and use taplo to the README.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions