Format markdown files and rust code blocks in markdown files #5909

The only implementaiton of the `FormatHandler` trait is the one implemented for `Session`, and in that implementation we pass the `ParseSess` to `source_file::write_file`, which also takes the `ParseSess` as an optional argument. looking at the implementation of `source_file::write_file`, the `ParseSess` is optionally used to determine the file's original line ending instead of reading the file from the file system again to do so. Given the above explanation, I don't think there's any issue changing the signature of `FormatHandler::handle_formatted_file` and the implementation of `FormatHandler for Session`.

The visibility of several private items in comments.rs were updated to `pub(crate)`. These items will help when adding support for formatting rust code blocks in markdown files.

A helper method used to determine if the code block contains rust code that should be formatted. This will help when implementing rust code block formatting in markdown files.

The `rewrite_markdown` function will take markdown as input and apply rustfmt on rust code blocks. Because of how `pulldown-cmark-to-cmark` is implemented there will be some light rewriting of the markdown file outside of code block reformatting. This mostly relates to updating newlines after markdown elements like headers and lists, and possibly updating the indentation of indented code blocks. In the future we may even consider implementing doc comment rewriting in terms of `rewrite_markdown`.

Now users can envoke rustfmt directly with a markdown file and the rust code within that file will be reformatted e.g. `rustfmt README.md`

This will make it easeir to write tests for markdown codeblock reformatting.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Format markdown files and rust code blocks in markdown files #5909

Format markdown files and rust code blocks in markdown files #5909

Commits on Sep 12, 2023

Format markdown files and rust code blocks in markdown files #5909

Are you sure you want to change the base?

Format markdown files and rust code blocks in markdown files #5909

Commits on Sep 12, 2023