Skip to content

Generates alias shell scripts to provide ease of use for commonly used shell commands. Documentation for the specified aliases is generated and help is available from the shell. This makes it easy for a team to share useful aliases.

Notifications You must be signed in to change notification settings

smartics/alias-maven-plugin

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

91 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Alias Maven Plugin

Project Logo

Generates alias shell scripts to provide ease of use of commonly used shell commands by a team.

##Overview

This plugin for [Maven] (http://maven.apache.org/) creates alias scripts from a configurations file.

So what problem does this plugin solve? Whenever you type a command in a shell, for instance

mvn clean install

you could spare time in simply using an alias like this

i

If you are using license headers that depend on generated build properties, you end up with typing

mvn initialize license:format

In addition to the number of characters to type, it is also inconvenient to remember the name of the plugin and the fact, that the initialize phase has to be called before calling the format Mojo. So an alias comes handy:

l

While creating those aliases in your environment is no rocket science, why should we not share our aliases in our team? By sharing we need to add some comments so that new team members can figure out what aliases exist and what they are good for.

This plugin generates shell scripts that set the aliases you define in an XML file and adds some documentation to it:

  1. By typing 'h' (default key, can be changed), the aliases with their commands are printed.
  2. A URL to a team page on the wiki or CMS is printed for further information.
  3. A report plugin generates a report with the help on each alias to be referenced.

Documentation

Please visit

Related Plugins

About

Generates alias shell scripts to provide ease of use for commonly used shell commands. Documentation for the specified aliases is generated and help is available from the shell. This makes it easy for a team to share useful aliases.

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •