rust/crates/ra_lsp_server/src/markdown.rs

52 lines
1.4 KiB
Rust
Raw Normal View History

pub(crate) fn format_docs(src: &str) -> String {
let mut processed_lines = Vec::new();
let mut in_code_block = false;
2019-06-08 11:16:05 +00:00
for line in src.lines() {
2019-07-30 18:25:51 +00:00
if in_code_block && code_line_ignored_by_rustdoc(line) {
continue;
}
if line.starts_with("```") {
2019-06-08 11:16:05 +00:00
in_code_block ^= true
}
let line = if in_code_block && line.starts_with("```") && !line.contains("rust") {
2019-06-08 11:16:05 +00:00
"```rust"
} else {
2019-06-08 11:16:05 +00:00
line
};
processed_lines.push(line);
}
2019-06-08 11:16:05 +00:00
processed_lines.join("\n")
}
2019-07-30 18:25:51 +00:00
fn code_line_ignored_by_rustdoc(line: &str) -> bool {
let trimmed = line.trim();
trimmed == "#" || trimmed.starts_with("# ") || trimmed.starts_with("#\t")
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_format_docs_adds_rust() {
let comment = "```\nfn some_rust() {}\n```";
assert_eq!(format_docs(comment), "```rust\nfn some_rust() {}\n```");
}
#[test]
fn test_format_docs_skips_comments_in_rust_block() {
2019-07-30 18:25:51 +00:00
let comment =
"```rust\n # skip1\n# skip2\n#stay1\nstay2\n#\n #\n # \n #\tskip3\n\t#\t\n```";
assert_eq!(format_docs(comment), "```rust\n#stay1\nstay2\n```");
}
#[test]
fn test_format_docs_keeps_comments_outside_of_rust_block() {
2019-07-30 18:25:51 +00:00
let comment = " # stay1\n# stay2\n#stay3\nstay4\n#\n #\n # \n #\tstay5\n\t#\t";
assert_eq!(format_docs(comment), comment);
}
}