com.github.danielflower.mavenplugins.gitlog.renderers.MarkdownLinkConverter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gitlog-maven-plugin Show documentation

Generates a changelog based on commits to a git repository in text and HTML format showing the changes that are included in each version. A possible use of this is to include these changelogs when packaging your maven project so that you have an accurate list of commits that the current package includes.

The newest version!

package com.github.danielflower.mavenplugins.gitlog.renderers;

import java.util.regex.Matcher;
import java.util.regex.Pattern;

import org.apache.maven.plugin.logging.Log;

/**
 * Helper class to convert a HTML link into a markdown link.
 * 
 * It searches for a ...Text... and the
 * URL and text is used to build afterwards the markdown link.
 * The markdown links goes like [...Text...](...URL...).
 *
 */
public class MarkdownLinkConverter {

	private Pattern pattern;
	private final Log log;
	
	public MarkdownLinkConverter(Log log) {
		this.log = log;
		// see http://stackoverflow.com/questions/26323/regex-to-parse-hyperlinks-and-descriptions
		// limited to double quotes (removed the single quote),
		// because the Converters will use double quotes.
		this.pattern = Pattern.compile("(.*?)");
	}
	
	public String formatCommitMessage(String original) {
		try {
			Matcher matcher = pattern.matcher(original);
			String result = matcher.replaceAll("[$3]($2)");
			return result;
		} catch (Exception e) {
			// log, but don't let this small setback fail the build
			log.info("Unable to convert a HTML link into markdown link: " + original, e);
		}
		return original;
	}
	
}