Skip to content

Commit

Permalink
GRAILS-5841 - document the plugin location property
Browse files Browse the repository at this point in the history
  • Loading branch information
Jeff Brown committed Feb 3, 2010
1 parent 5ecc760 commit b71fc40
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions grails-doc/src/guide/12.1 Creating and Installing Plug-ins.gdoc
Expand Up @@ -92,5 +92,24 @@ Although the [create-plugin|commandLine] command creates certain files for you s

If you need artefacts within @WEB-INF@ it is recommended you use the @_Install.groovy@ script (covered later), which is executed when a plug-in is installed, to provide such artefacts. In addition, although @UrlMappings.groovy@ is excluded you are allowed to include a @UrlMappings@ definition with a different name, such as @FooUrlMappings.groovy@.

h4. Modular Application Development With Plugins

An application can load plugins from anywhere on the file system, even if they have not been installed. Simply add the location of the (unpacked) plugin to the application's @grails-app/conf/BuildConfig.groovy@ file:

{code:java}
// Useful to test plugins you are developing.
grails.plugin.location.jsecurity = "/home/dilbert/dev/plugins/grails-jsecurity"

// Useful for modular applications where all plugins and
// applications are in the same directory.
grails.plugin.location.'grails-ui' = "../grails-grails-ui"
{code}

This is particularly useful in two cases:

* You are developing a plugin and want to test it in a real application without packaging and installing it first.
* You have split an application into a set of plugins and an application, all in the same "super-project" directory.




0 comments on commit b71fc40

Please sign in to comment.