Remove single asterisk in usage example completion

[n1kolas]

Hey,

noticed a small bug in the form- and render- snippet (sorry :D).

 * Usage example:
 * @code
 * $form['author'] = [
 *   '#type' => 'details',
 *   '#title' => $this->t('Author'),
 * ];
 *
 * $form['author']['name'] = [
 *   '#type' => 'textfield',
 *   '#title' => $this->t('Name'),
 * ];
 * @endcode

In the current main branch, when there are multiple examples like above, the "*" doesn't get stripped (between the form arrays).
So currently there's an asterisk between.

This MR should fix that so render-details works properly.
Maybe you could double check. So far I haven't found a snippet that looked wrong.

[jdrupal-dev]

Nice catch. I would like to use Regex though as it will be easier to extend the pattern if we find other edge cases in the future.

You can use this function which I have tested locally:

    /// 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;
        }

        let comment_text = self.get_node_text(comment_node);
        let start_tag = "@code";
        let end_tag = "@endcode";

        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(),
                );
            }
        }
        None
    }

[n1kolas]

Sounds good thanks, pushed the change and tested it locally.