templates.Plugin.groovy Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of plugin Show documentation
A Grace profile to create plugin
There is a newer version: 2023.2.0-M1
@artifact.package@

class @artifact.name@GrailsPlugin {

    // the plugin version
    def version = "@plugin.version@"
    // the version or versions of Grails the plugin is designed for
    def grailsVersion = "@grails.version@ > *"
    // resources that are excluded from plugin packaging
    def pluginExcludes = [
        "app/views/error.gsp"
    ]

    // TODO Fill in these fields
    def title = "@plugin.title@" // Headline display name of the plugin
    def author = "Your name"
    def authorEmail = "[email protected]"
    def description = '''\
Brief summary/description of the plugin.
'''

    // URL to the plugin's documentation
    def documentation = "https://github.com/grace-plugins/@plugin.short.name@"

    // Extra (optional) plugin metadata

    // License: one of 'APACHE', 'GPL2', 'GPL3'
//    def license = "APACHE"

    // Details of company behind the plugin (if there is one)
//    def organization = [ name: "My Company", url: "http://www.my-company.com/" ]

    // Any additional developers beyond the author specified above.
//    def developers = [ [ name: "Your Name", email: "[email protected]" ]]

    // Location of the plugin's issue tracker.
//    def issueManagement = [ system: "GitHub", url: "https://github.com/grace-plugins/@plugin.short.name@/issues" ]

    // Online location of the plugin's browseable source code.
//    def scm = [ url: "https://github.com/grace-plugins/@plugin.short.name@" ]

    def doWithWebDescriptor = { xml ->
        // TODO Implement additions to web.xml (optional), this event occurs before
    }

    def doWithSpring = {
        // TODO Implement runtime spring config (optional)
    }

    def doWithDynamicMethods = { ctx ->
        // TODO Implement registering dynamic methods to classes (optional)
    }

    def doWithApplicationContext = { ctx ->
        // TODO Implement post initialization spring config (optional)
    }

    def onChange = { event ->
        // TODO Implement code that is executed when any artefact that this plugin is
        // watching is modified and reloaded. The event contains: event.source,
        // event.application, event.manager, event.ctx, and event.plugin.
    }

    def onConfigChange = { event ->
        // TODO Implement code that is executed when the project configuration changes.
        // The event is the same as for 'onChange'.
    }

    def onShutdown = { event ->
        // TODO Implement code that is executed when the application shuts down (optional)
    }
}