A sample rebar plugin, written in LFE

This is a sample rebar plugin written in LFE. It's provided in order to encourage folks to create rebar plugins using LFE.

This project assumes that you have rebar installed somwhere in your $PATH.

This project depends upon the following, which installed to the deps directory of this project when you run make deps:

• LFE (Lisp Flavored Erlang; needed only to compile)
• lfeunit (needed only to run the unit tests)

Installation assumes you have created your LFE rebar plugin project using lfetool.

In order to use this plugin, you will need to do the following:

• Update your project's rebar.config to add the following:

{plugins, ['lfe-sample-rebar-plugin']}.

• Update the deps section of your project's rebar.config to add the following:

{'lfe-sample-rebar-plugin',
    ".*",
    {git, "git://github.com/oubiwann/lfe-sample-rebar-plugin.git",
          "master"}}

After that, you'll need to make compile, and you should be all set to use it.

Once you've got the sample plugin compiled, you can run the plugin's functions. This sample plugin provides the follwoing commands (which both only print to stdout, they don't perform any changes to the system):

• list-plugins
• commands
• demo-run-in-basedir
• demo-run-in-other-dirs

The are displayed below "in action". Note that these commands are run in the working directory (git clone of lfe-sample-rebar-plugin) after a make compile has been done:

$ ERL_LIBS=. rebar commands
==> lfe (commands)
==> lfeunit (commands)
==> lfe-utils (commands)
==> rebar (commands)
==> lfe-sample-rebar-plugin (commands)

clean                                Clean
compile                              Compile sources
.
.
.
Commands for the 'lfe-sample-rebar-plugin` rebar plugin:

  demo-run-in-basedir            Display a demo message while processing the current dir
  demo-run-in-other-dirs         Displa a demo message while processing deps dirs
  list-plugins               List all the plugins defined for the current dir
  commands               List both the default commands and those for the plugins

$ ERL_LIBS=. rebar list-plugins
==> lfe (list-plugins)
==> lfeunit (list-plugins)
==> lfe-utils (list-plugins)
==> rebar (list-plugins)
==> lfe-sample-rebar-plugin (list-plugins)
['lfe-sample-rebar-plugin']

$ ERL_LIBS=. rebar demo-run-in-basedir
==> lfe (run-in-basedir)
==> lfeunit (run-in-basedir)
==> lfe-utils (run-in-basedir)
==> rebar (run-in-basedir)
==> lfe-sample-rebar-plugin (run-in-basedir)
Just ran the 'run-in-basedir' plugin command!

All plugins will iterate through the set of deps and base directories, calling the given plugin function. In this case, the function called only operates on the base directory.

$ ERL_LIBS=. rebar demo-run-in-other-dirs
==> lfe (run-in-other-dirs)
Just ran the 'run-in-other-dirs' plugin command!
==> lfeunit (run-in-other-dirs)
Just ran the 'run-in-other-dirs' plugin command!
==> lfe-utils (run-in-other-dirs)
Just ran the 'run-in-other-dirs' plugin command!
==> rebar (run-in-other-dirs)
Just ran the 'run-in-other-dirs' plugin command!
==> lfe-sample-rebar-plugin (run-in-other-dirs)

As you can see, this plugin function does just the opposite: it executes on every directory other than the base directory.

To add new plugin commands, simply do the following:

1. create a command function that takes rebar-config and app-file as parameters
2. update the get-commands-help function with the new command function you added