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.

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

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

Open
ebma opened this issue Oct 2, 2024 · 2 comments
Open

Comments

@ebma
Copy link
Member

ebma commented Oct 2, 2024

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.
@ebma
Copy link
Member Author

ebma commented Oct 2, 2024

@pendulum-chain/product similar to #490, this is a nice-to-have addition improving the developer experience.

@prayagd
Copy link
Collaborator

prayagd commented Oct 11, 2024

Hey team! Please add your planning poker estimate with Zenhub @b-yap @ebma @gianfra-t @TorstenStueber

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants