Property Detail

• final Property<java.lang.Boolean> all

  What every artefact type falls back to where it says nothing of its own. A shortcut for enabling controllers, services and tagLibs together. Disabled by default.

  An artefact type that states a value keeps it, so a single type can be held back from the shortcut:

   grails {
       compileStatic {
           all = true
           services = false   // every artefact type but services
       }
   }
   

• final Property<java.lang.Boolean> controllers

  Whether every controller under grails-app/controllers should be compiled with @GrailsCompileStatic. Follows all where it is not set.

• final SetProperty<java.lang.String> dynamicTagNamespaces

  Namespaces whose tag libraries are registered while the application runs rather than described when it is compiled. Tags in them are never reported as unknown, however complete the tag library index is, and calls to them keep being dispatched dynamically.

  Since:

  8.0

• final Property<java.lang.Boolean> gsp

  Whether every GSP page under grails-app/views should be compiled statically, by stating the grails.views.gsp.compileStatic configuration setting for both the build and the running application. Disabled by default.

  Deliberately not covered by all. The artefact opt-ins fail on code that is doubtful anyway; this one fails on a page that reads a model variable it has not declared, which describes most pages in an application that has never declared one. Enabling it is a migration, not a switch, so it is never turned on as a side effect of asking for everything.

• final Property<java.lang.Boolean> services

  Whether every service under grails-app/services should be compiled with @GrailsCompileStatic. Follows all where it is not set.

• final Property<java.lang.Boolean> strictGsp

  Whether every page is held to the names it declares, rather than only the pages that declare a model. Disabled by default.

  A page that declares a model is held to it either way: declaring one states what the page is rendered with, so a name outside it is a mistake. This asks for the same of a page that declares nothing, which otherwise reads what it is rendered with the way a dynamically compiled page does. Meaningless unless gsp is enabled.

• final Property<java.lang.Boolean> strictTags

  Whether a tag no compiled tag library declares should fail compilation. Disabled by default, where such a tag is left to resolve at runtime with nothing reported.

  Checked only where the source says a call is a tag: one naming its namespace, as g.message(code: 'x') does, and one written as markup, as <g:message/> is. A call written without a namespace is not checked, because such a name may equally be a method contributed by any of the dynamic mechanisms an application has, and in a page it may be part of the model the page was rendered with.

  Knowing that a namespace holds some compiled tag libraries is not the same as knowing it holds all of them: a plugin built before tag library descriptors existed contributes tags without one, and a tag library registered while an application runs contributes more. Enable this once every tag library an application uses is described, and declare the namespaces that are genuinely filled in at runtime through dynamicTagNamespaces:

   grails {
       compileStatic {
           strictTags = true
           dynamicTagNamespaces = ['legacy']
       }
   }
   

  Since:

  8.0

• final Property<java.lang.Boolean> tagLibs

  Whether every tag library under grails-app/taglib should be compiled with @GrailsCompileStatic. Follows all where it is not set.

• final Property<java.lang.Boolean> unqualifiedTagCalls

  Whether a tag call written without its namespace may be compiled into a direct invocation.

  Off by default. A namespaced call names the tag library it means; a bare name is a tag only when nothing nearer answers to it, and what answers to it is not fully visible when compiling - a method Groovy gives every object, a delegate an enclosing closure is handed, an overload the tag library also declares. Turn this on to compile those calls too, in a project whose tag names are known not to collide.

Constructor Detail

• @javax.inject.Inject
  GrailsCompileStaticOptions(ObjectFactory objects)