Property Detail

• static final java.lang.String DEFAULT_BOM

  The default Grails BOM artifact name applied when bom is not overridden. Resolved as org.apache.grails:grails-bom:$grailsVersion.

• final Property<java.lang.String> bom

  The Grails BOM that the Grails Gradle plugin automatically applies as a Gradle platform() (or enforcedPlatform() for the Micronaut variants) on every declarable project configuration, alongside the org.apache.grails.gradle.bom-property-overrides plugin for property-based version overrides.

  The value is the BOM artifact name within the org.apache.grails group; the plugin resolves it as org.apache.grails:$bom:$grailsVersion. Exactly one BOM is ever applied.

  Defaults to grails-bom. Set it to a different curated variant when the application needs that BOM instead - for example:

   grails {
       bom = 'grails-micronaut-bom'   // applied as an enforcedPlatform
   }
   

  Set it to null (or use the deprecated grails { springDependencyManagement = false }) to suppress the automatic BOM application entirely - for example when you want to declare the platform()/enforcedPlatform() by hand (and apply org.apache.grails.gradle.bom-property-overrides explicitly if you still want gradle.properties / ext['...'] overrides):

   grails {
       bom = null
   }
   

  The Micronaut variants (grails-micronaut-bom, grails-hibernate5-micronaut-bom, and grails-hibernate7-micronaut-bom) are applied as an enforcedPlatform because the Micronaut platform would otherwise override their managed versions via conflict resolution. All other BOMs are applied as a regular platform.

  Since:

  8.0

• final GrailsCompileStaticOptions compileStatic

  Lazy opt-ins for compiling controllers, services and tag libraries with @GrailsCompileStatic automatically, configured through the nested compileStatic block. Each flag is a lazy Property (read at compile time, not configuration time) and defaults to false:

   grails {
       compileStatic {
           controllers = true
           services = true
           tagLibs = true
       }
   }
   

  Use compileStatic { all = true } as a shortcut to enable all three at once. A per-class @CompileDynamic (or @CompileStatic/@GrailsCompileStatic) annotation always wins over these defaults.

• boolean importGrailsCommonAnnotations

  Whether grails annotation packages and common validation annotations should be default import packages. When enabled, automatically imports: - jakarta.validation.constraints.* - grails.gorm.annotation.* (if grails-datamapping-core is in classpath) - grails.plugin.scaffolding.annotation.* (if grails-scaffolding is in classpath)

• boolean importJavaTime

  Whether java.time.* package should be a default import package

• final Property<java.lang.Boolean> indy

  Whether to enable Groovy's invokedynamic (indy) bytecode instruction for dynamic Groovy method dispatch. Disabled by default to improve performance (see GitHub issue #15293). When enabled, Groovy uses JVM invokedynamic instead of traditional callsite caching. To enable invokedynamic in build.gradle: grails { indy = true }

• boolean micronautAutoSetup

  Whether the Micronaut auto-setup should run when the `grails-micronaut` plugin is detected. When enabled, the Grails Gradle plugin:

  • validates that a Micronaut-compatible Grails BOM is applied as `enforcedPlatform` and fails the build at configuration time with an actionable error if not;
  • keeps Micronaut dependency management aligned with the Grails BOM variant selected by the application.
  Disabling this is rarely appropriate; consumer projects should normally apply the BOM as `enforcedPlatform` so that the Micronaut platform cannot override grails-bom-managed versions.

• boolean native2ascii

  Whether to invoke native2ascii on resource bundles

• boolean native2asciiAnt

  Whether to use Ant to do the conversion

• boolean packageAssets

  Whether assets should be packaged in META-INF/assets for plugins

• PluginDefiner pluginDefiner

• final Property<java.lang.Boolean> preserveParameterNames

  Keep method and constructor parameter names in class files, allowing frameworks such as Spring to use parameter names for dependency resolution, including autowiring by name without requiring annotations such as @Qualifier.

• Project project

• @java.lang.Deprecated
  boolean springDependencyManagement

  deprecated:

  The Spring Dependency Management plugin has been replaced with Gradle's native platform() support plus lightweight property-based version overrides supplied by the org.apache.grails.gradle.bom-property-overrides plugin. Set version overrides in gradle.properties or via ext['property.name'] instead. For backward compatibility, setting this property to false is still honored as bom = null so existing opt-outs (which previously prevented the Spring Dependency Management BOM from being applied) continue to disable the automatic Grails BOM platform() application. New builds should set bom directly.

• java.util.List<java.lang.String> starImports

  Custom star imports to add to Groovy compilation configuration. Users can add their own package imports that will be combined with imports added by importJavaTime and importGrailsCommonAnnotations flags.

Constructor Detail

• GrailsExtension(Project project)

Method Detail

• void compileStatic(@groovy.lang.DelegatesTo(value: GrailsCompileStaticOptions, strategy: Closure.DELEGATE_FIRST)
  groovy.lang.Closure<?> configureClosure)

  Configures the nested compileStatic opt-ins.

  Parameters:

  configureClosure - a closure applied to the GrailsCompileStaticOptions

• DependencyHandler getPlugins()

• boolean isDevelopmentRun()

• void plugins(@groovy.lang.DelegatesTo(value: DependencyHandler)
  groovy.lang.Closure configureClosure)

  Allows defining plugins in the available scopes

• void setBom(java.lang.String value)

  DSL setter for bom. A null or blank value clears the property so that no BOM is applied automatically; any other value is used verbatim as the BOM artifact name.

• void setIndy(boolean enabled)

• @java.lang.Deprecated
  void setSpringDependencyManagement(boolean enabled)

  Backward-compatible setter for the deprecated springDependencyManagement flag. Disabling it clears bom (equivalent to grails { bom = null }) so projects that still opt out via grails { springDependencyManagement = false } do not unexpectedly receive the Grails BOM platform() after the migration away from the Spring Dependency Management plugin.