ci: Use dprint to format documentation + TOML files
#3426
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
chipbuster
commented
Jan 13, 2022
5 tasks
matchai
reviewed
Jan 14, 2022
chipbuster
changed the title
dprint to format documentation filesdprint to format documentation + TOML files
matchai
reviewed
Jan 15, 2022
matchai
reviewed
Jan 19, 2022
chipbuster
commented
Jan 19, 2022
|
Okay, I think I've caught all the major whoopsies from the rebase onto latest master. |
Perniciosius
pushed a commit
to Perniciosius/starship
that referenced
this pull request
Feb 21, 2022
Adds Rust-based standardized markdown formatting and a CI step to catch unformatted files.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Adds Rust-based standardized markdown formatting and a CI step to catch unformatted files.
Motivation and Context
Occasionally, a contributor will have a different markdown formatter than the typical one, resulting in lots of changes throughout a document. This has been exacerbated by the fact that many markdown formatters don't support partial formatting, meaning you have to format the entire document to format changes.
Don't know if this link will remain valid in the future, but here is an example of where one such accidental change happened in a PR.
I have gone with a rust-based formatting tool (even though it's less popular than well-established tools like prettier and vscode-markdown) because it's editor agnostic and doesn't require installing a new language runtime, since you already need
cargoto develop. (Thanks matchai for the suggestion!)Screenshots (if appropriate):
How Has This Been Tested?
Checklist: