Skip to content

Remove single asterisk in usage example completion #5

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.

Sign up for GitHub

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

Merged
jdrupal-dev merged 2 commits into from
Apr 25, 2025
Merged

Remove single asterisk in usage example completion #5

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f40908d
fix: remove single asterisk at start of usage example
n1kolas Apr 25, 2025
15b4a47
refactor: use regex for usage example extraction
n1kolas Apr 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 19 additions & 15 deletions src/parser/php.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -375,7 +375,7 @@ impl PhpParser {
node.utf8_text(self.source.as_bytes()).unwrap_or("")
}

/// Helper function to extract usage example from the preceding comment
/// Helper function to extract usage example from the preceding comment.
fn extract_usage_example_from_comment(&self, comment_node: &Node) -> Option<String> {
if comment_node.kind() != "comment" {
return None;
Expand All @@ -385,22 +385,26 @@ impl PhpParser {
let start_tag = "@code";
let end_tag = "@endcode";

if let Some(start_index) = comment_text.find(start_tag) {
if let Some(end_index) = comment_text.find(end_tag) {
if end_index > start_index {
let code_start = start_index + start_tag.len();
let example = comment_text[code_start..end_index].trim();
let cleaned_example = example
.lines()
.map(|line| line.trim_start().strip_prefix("* ").unwrap_or(line))
.collect::<Vec<&str>>();

let result = &cleaned_example[..cleaned_example.len() - 1]
if let (Some(start_index), Some(end_index)) =
(comment_text.find(start_tag), comment_text.find(end_tag))
{
if end_index > start_index {
let code_start = start_index + start_tag.len();
let example = comment_text[code_start..end_index].trim();

// Regex to replace "* " or "*" from the beginning of a line.
let re = Regex::new(r"^\s*\*\s?").unwrap();
let cleaned_example = example
.lines()
.map(|line| re.replace(line, "").to_string())
.collect::<Vec<String>>();

return Some(
cleaned_example[..cleaned_example.len() - 1]
.join("\n")
.trim()
.to_string();
return Some(result.to_string());
}
.to_string(),
);
}
}
None
Expand Down