Package com.github.koraktor.mavanagaiata.mojo

Class ContributorsMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.github.koraktor.mavanagaiata.mojo.AbstractGitMojo

com.github.koraktor.mavanagaiata.mojo.AbstractGitOutputMojo

com.github.koraktor.mavanagaiata.mojo.ContributorsMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="contributors",
      defaultPhase=PROCESS_RESOURCES,
      threadSafe=true)
public class ContributorsMojo
extends AbstractGitOutputMojo

This goal allows to generate a list of contributors for the currently checked out branch of the Git repository. It will list all authors of the commits in this branch. It can be configured to display the changelog or save it to a file.

Since:

0.2.0

Author:

Sebastian Staudt

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) class	ContributorsMojo.Contributor
(package private) class	ContributorsMojo.ContributorsWalkAction

Field Summary

Fields

Modifier and Type	Field	Description
(package private) String	contributorPrefix	The string to prepend to every contributor name
(package private) boolean	escapeHtml
(package private) boolean	escapeMarkdown
(package private) String	header	The header to print above the changelog
private MailMap	mailMap
private static Map<CharSequence,CharSequence>	MARKDOWN_TRANSLATION_MAP
private static org.apache.commons.text.translate.CharSequenceTranslator	MARKDOWN_TRANSLATOR
(package private) File	outputFile	The file to write the contributors list to
(package private) boolean	showCounts	Whether the number of contributions should be listed
(package private) boolean	showEmail	Whether the email addresses of contributors should be listed
(package private) String	sort	The method used to sort contributors

Fields inherited from class com.github.koraktor.mavanagaiata.mojo.AbstractGitOutputMojo

encoding, footer, printStream

Fields inherited from class com.github.koraktor.mavanagaiata.mojo.AbstractGitMojo

baseDir, dateFormat, dirtyFlag, dirtyIgnoreUntracked, failGracefully, gitDir, head, project, propertyPrefixes, skip, skipNoGit

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor	Description
ContributorsMojo()

Method Summary

Modifier and Type	Method	Description
private String	escapeName(String name)	Returns an escaped form of the contributor name
File	getOutputFile()	Returns the output file for the generated contributors list
protected void	initConfiguration()	Selects the attribute to use for sorting contributors
void	setOutputFile(File outputFile)	Sets the output file for the generated contributors list
protected void	writeOutput(GitRepository repository)	Walks through the history of the currently checked out branch of the Git repository and builds a list of contributors from the authors of the commits.

Methods inherited from class com.github.koraktor.mavanagaiata.mojo.AbstractGitOutputMojo

createPrintStream, generateOutput, init, run, unescapeFormatNewlines

Methods inherited from class com.github.koraktor.mavanagaiata.mojo.AbstractGitMojo

addProperty, execute, initRepository, prepareParameters

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MARKDOWN_TRANSLATION_MAP

private static final Map<CharSequence,CharSequence> MARKDOWN_TRANSLATION_MAP

MARKDOWN_TRANSLATOR

private static final org.apache.commons.text.translate.CharSequenceTranslator MARKDOWN_TRANSLATOR

contributorPrefix

@Parameter(property="mavanagaiata.contributors.contributorPrefix",
           defaultValue=" * ")
String contributorPrefix

The string to prepend to every contributor name

escapeHtml

@Parameter(property="mavanagaiata.contributors.escapeHtml",
           defaultValue="false")
boolean escapeHtml

escapeMarkdown

@Parameter(property="mavanagaiata.contributors.escapeMarkdown",
           defaultValue="false")
boolean escapeMarkdown

header

@Parameter(property="mavanagaiata.contributors.header",
           defaultValue="Contributors\n============\n")
String header

The header to print above the changelog

mailMap

private MailMap mailMap

outputFile

@Parameter(property="mavanagaiata.contributors.outputFile")
File outputFile

The file to write the contributors list to

showCounts

@Parameter(property="mavanagaiata.contributors.showCounts",
           defaultValue="true")
boolean showCounts

Whether the number of contributions should be listed

showEmail

@Parameter(property="mavanagaiata.contributors.showEmail",
           defaultValue="false")
boolean showEmail

Whether the email addresses of contributors should be listed

sort

@Parameter(property="mavanagaiata.contributors.sort",
           defaultValue="count")
String sort

The method used to sort contributors

Available values are count, date and name.

Constructor Detail

ContributorsMojo

public ContributorsMojo()

Method Detail

initConfiguration

protected void initConfiguration()

Selects the attribute to use for sorting contributors

Overrides:

initConfiguration in class AbstractGitOutputMojo

writeOutput

protected void writeOutput(GitRepository repository)
                    throws MavanagaiataMojoException

Walks through the history of the currently checked out branch of the Git repository and builds a list of contributors from the authors of the commits.

Specified by:

writeOutput in class AbstractGitOutputMojo

Parameters:

repository - The repository the mojo is running in

Throws:

MavanagaiataMojoException - if retrieving information from the Git repository fails

escapeName

private String escapeName(String name)

Returns an escaped form of the contributor name

Depending on the escapeHtml and escapeMarkdown fields this methods escapes HTML tags and/or Markdown link brackets.

Parameters:

name - The name of the contributor

Returns:

An escaped form of the contributor

getOutputFile

public File getOutputFile()

Returns the output file for the generated contributors list

Specified by:

getOutputFile in class AbstractGitOutputMojo

Returns:

The output file for the generated contributors list

setOutputFile

public void setOutputFile(File outputFile)

Sets the output file for the generated contributors list

Specified by:

setOutputFile in class AbstractGitOutputMojo

Parameters:

outputFile - The output file for the generated contributors list