alias:alias

Full name:

de.smartics.maven.plugin:alias-maven-plugin:0.3.4:alias

Description:

Creates an alias script based on the alias configuration.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is thread-safe and supports parallel builds.
  • Binds by default to the lifecycle phase: generate-resources.

Required Parameters

Name Type Since Description
aliasLocation String 1.0 The location of the alias definitions. The contents of the file is required to use the alias XSD.
Default value is: ${basedir}/src/main/resources/alias.xml.
helpAlias String 1.0 The name of the alias to print the help on all defined aliases.
Default value is: h.
scriptLocation String 1.0 The location to write the alias scripts to.
Default value is: ${project.build.directory}/alias-scripts.

Optional Parameters

Name Type Since Description
addInstallationComment boolean 1.0 If set to true instructs the script generator to add a comment after the intro text that informs about the default installation of the script. If set to false no information is added.
Default value is: true.
docUrl String 1.0 A URL to further documentation on this script. This may point to a page in the developer team's wiki or a generated site in the project's documentation.

The URL is presented to the user of the alias script if s/he requests the help listing.
extro String 1.0 The optional text to append to the generated script. No comment markers allowed. This text will be written to the generated file as comments.
intro String 1.0 The optional text to prepend to the generated script. No comment markers allowed. This text will be written to the generated file as comments.
scripts String[] 1.0 The list of scripts to be generated. If not specified all supported script types are generated. Supported scripts are: windows and bash.
skip boolean 1.0 A simple flag to skip alias generation. If set on the command line use -Dalias.skip.
Default value is: false.
User property is: alias.skip.
verbose boolean 1.0 A simple flag to log verbosely. If set on the command line use -Dalias.verbose.
Default value is: false.
User property is: alias.verbose.

Parameter Details

addInstallationComment:

If set to true instructs the script generator to add a comment after the intro text that informs about the default installation of the script. If set to false no information is added.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • Default: true

aliasLocation:

The location of the alias definitions. The contents of the file is required to use the alias XSD.
  • Type: java.lang.String
  • Since: 1.0
  • Required: Yes
  • Default: ${basedir}/src/main/resources/alias.xml

docUrl:

A URL to further documentation on this script. This may point to a page in the developer team's wiki or a generated site in the project's documentation.

The URL is presented to the user of the alias script if s/he requests the help listing.

  • Type: java.lang.String
  • Since: 1.0
  • Required: No

extro:

The optional text to append to the generated script. No comment markers allowed. This text will be written to the generated file as comments.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No

helpAlias:

The name of the alias to print the help on all defined aliases.
  • Type: java.lang.String
  • Since: 1.0
  • Required: Yes
  • Default: h

intro:

The optional text to prepend to the generated script. No comment markers allowed. This text will be written to the generated file as comments.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No

scriptLocation:

The location to write the alias scripts to.
  • Type: java.lang.String
  • Since: 1.0
  • Required: Yes
  • Default: ${project.build.directory}/alias-scripts

scripts:

The list of scripts to be generated. If not specified all supported script types are generated. Supported scripts are: windows and bash.
  • Type: java.lang.String[]
  • Since: 1.0
  • Required: No

skip:

A simple flag to skip alias generation. If set on the command line use -Dalias.skip.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • User Property: alias.skip
  • Default: false

verbose:

A simple flag to log verbosely. If set on the command line use -Dalias.verbose.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • User Property: alias.verbose
  • Default: false