Deprecate *[eE]xtensions in favour of *[dD]Extensions (asciidoctor#347)

README.adoc

@@ -157,12 +157,12 @@ attributeProvider:: Register an additional provider of attributes.
   Attribute providers are a means of adding attributes that will not affect the up-to-date status of tasks.
 epubVersion:: {asciidoctorj-epub-name} version.
   If not specified asciidoctorj-epub will not be on the classpath. If you plan to use the EPUB backend, then you need to set a version here.
-extensions:: Groovy DSL extensions.
-  Use `extensions` to add one or more extensions. Use `setExtensions` to replace the current set of extensions with a new set.
+docExtensions:: Groovy DSL extensions.
+  Use `docExtensions` to add one or more extensions. Use `setDocExtensions` to replace the current set of extensions with a new set.
   Extensions can be any kind of object that is serialisable, although in most cases they will be strings or files.
   If extensions are detached dependencies, they will not be serialised, but rather will be placed on the classpath in
   order that {asciidoctorj-name} can pick them up automatically.
-fatalWarnings: Patterns for {asciidoctorj-name} log messages that shuold be treated as fatal errors.
+fatalWarnings: Patterns for {asciidoctorj-name} log messages that should be treated as fatal errors.
   The list is empty be default. Use `setFatalWarnings` to clear any existing patterns or to decouple a task's configuration from the global
   configuration. Use `fatalWarnings` to add more patterns. Pass `missingIncludes()` to add the common use-case of
   missing include files.
@@ -911,7 +911,7 @@ plugins {
 }
 
 asciidoctorj {
-    extensions project(':extension')
+    docExtensions project(':extension')
 }
 ----
 
@@ -922,13 +922,13 @@ In the less-common case where extension is not supplied via the default configur
 
 The next option is to define extensions directly in the build script.
 This approach is based on the project asciidoctorj-groovy-dsl that allows to define Asciidoctor extensions in Groovy.
-An extension is registered via the `extensions` element.
+An extension is registered via the `docExtensions` element.
 
 [source,groovy]
 .build.gradle
 ----
 asciidoctorj {
-    extensions {
+    docExtensions {
         block(name: "BIG", contexts: [":paragraph"]) {
             parent, reader, attributes ->
             def upperLines = reader.readLines()
@@ -949,7 +949,7 @@ Groovy extensions can also be included as files.
 .build.gradle
 ----
 asciidoctorj {
-    extensions file('big.groovy')
+    docExtensions file('big.groovy')
 }
 ----
 

asciidoctor-gradle-jvm-slides/src/main/groovy/org/asciidoctor/gradle/jvm/slides/AsciidoctorJRevealJSTask.groovy

@@ -152,7 +152,7 @@ class AsciidoctorJRevealJSTask extends AbstractAsciidoctorTask {
 
     /** Name one or more reveal.js plugins to activate.
      *
-     * Plugins must match bundle names registered in the {@code revealjsPlugins} extensions.
+     * Plugins must match bundle names registered in the {@code revealjsPlugins} docExtensions.
      * If selected plugins from a bundle is requires then they can be specified as {@code 'bundleName/pluginName'}.
      *
      * @param p List of plugins. Must be convertible to string.
@@ -163,7 +163,7 @@ class AsciidoctorJRevealJSTask extends AbstractAsciidoctorTask {
 
     /** Name one or more reveal.js plugins to activate.
      *
-     * Plugins must match bundle names registered in the {@code revealjsPlugins} extensions.
+     * Plugins must match bundle names registered in the {@code revealjsPlugins} docExtensions.
      * If selected plugins from a bundle is requires then they can be specified as {@code 'bundleName/pluginName'}.
      *
      * @param p List of plugins. Must be convertible to string.
@@ -174,7 +174,7 @@ class AsciidoctorJRevealJSTask extends AbstractAsciidoctorTask {
 
     /** Set reveal.js plugins to activate.
      *
-     * Plugins must match bundle names registered in the {@code revealjsPlugins} extensions.
+     * Plugins must match bundle names registered in the {@code revealjsPlugins} docExtensions.
      * If selected plugins from a bundle is requires then they can be specified as {@code 'bundleName/pluginName'}.
      *
      * @param p List of plugins. Must be convertible to string.

asciidoctor-gradle-jvm/src/gradleTest/extension-in-subproject/docs-using-configuration/build.gradle

@@ -13,6 +13,6 @@ asciidoctorj {
 }
 
 asciidoctor {
-    configurations 'asciidocExt'
+    docExtensions 'asciidocExt'
     inProcess JAVA_EXEC
 }

asciidoctor-gradle-jvm/src/gradleTest/extension-in-subproject/docs-using-project-direct/build.gradle

@@ -5,7 +5,7 @@ repositories {
 }
 
 asciidoctorj {
-    extensions project(':extension')
+    docExtensions project(':extension')
 }
 
 asciidoctor {

asciidoctor-gradle-jvm/src/intTest/groovy/org/asciidoctor/gradle/jvm/ExtensionsFunctionalSpec.groovy

@@ -48,7 +48,7 @@ class ExtensionsFunctionalSpec extends FunctionalSpecification {
             model.processMode, model.version, """
 asciidoctor {
     asciidoctorj {
-         extensions {
+         docExtensions {
             block(name: "BIG", contexts: [":paragraph"]) {
                 parent, reader, attributes ->
                 def upperLines = reader.readLines()*.toUpperCase()
@@ -92,7 +92,7 @@ asciidoctor {
 asciidoctor {
 
     asciidoctorj {
-        extensions '''
+        docExtensions '''
 block(name: 'BIG', contexts: [':paragraph']) {
         parent, reader, attributes ->
         def upperLines = reader.readLines()
@@ -136,7 +136,7 @@ block('small') {
             model.processMode, model.version, """
 asciidoctor {
     asciidoctorj {
-        extensions file('src/docs/asciidoc/blockMacro.groovy')
+        docExtensions file('src/docs/asciidoc/blockMacro.groovy')
     }
 }
 """)
@@ -164,7 +164,7 @@ asciidoctor {
         getBuildFile(
             model.processMode, model.version, '''
         asciidoctorj {
-            extensions {
+            docExtensions {
                 postprocessor { document, output ->
                     return "Hi, Mom" + output 
                 }
@@ -203,7 +203,7 @@ asciidoctor {
             model.processMode, model.version, """
 asciidoctor {
     asciidoctorj {
-        extensions '''
+        docExtensions '''
             postprocessor {
                 document, output ->
                     if (output.contains("blacklisted")) {

asciidoctor-gradle-jvm/src/main/groovy/org/asciidoctor/gradle/compat/AsciidoctorCompatibilityTask.groovy

@@ -67,7 +67,7 @@ import static org.ysb33r.grolifant.api.StringUtils.stringize
 class AsciidoctorCompatibilityTask extends DefaultTask {
     private static final String PATH_SEPARATOR = OperatingSystem.current().pathSeparator
     private static
-    final String MIGRATE_GEMS_MSG = 'When upgrading GEMs, \'requires\' will need to be set via the asciidoctorj project and task extensions. Use  setGemPaths method in extension(s) to set GEM paths.'
+    final String MIGRATE_GEMS_MSG = 'When upgrading GEMs, \'requires\' will need to be set via the asciidoctorj project and task docExtensions. Use  setGemPaths method in extension(s) to set GEM paths.'
 
     private static final String DEFAULT_BACKEND = AsciidoctorBackend.HTML5.id
     private boolean baseDirSetToNull
@@ -294,7 +294,7 @@ class AsciidoctorCompatibilityTask extends DefaultTask {
      */
     @Deprecated
     void extensions(Object... exts) {
-        migrationMessage('extensions', 'Extensions will need to be set via the asciidoctorj project and task extensions')
+        migrationMessage('docExtensions', 'Extensions will need to be set via the asciidoctorj project and task docExtensions')
         if (!exts) return // null check
         asciidoctorExtensions.addAll(exts as List)
     }
@@ -307,7 +307,7 @@ class AsciidoctorCompatibilityTask extends DefaultTask {
     @SuppressWarnings('ConfusingMethodName')
     @Deprecated
     void gemPath(Object... f) {
-        migrationMessage('gemPath', 'GEM paths will need to be set via the asciidoctorj project and task extensions using the gemPaths method')
+        migrationMessage('gemPath', 'GEM paths will need to be set via the asciidoctorj project and task docExtensions using the gemPaths method')
         if (!f) return // null check
         this.gemPaths.addAll(f as List)
     }

asciidoctor-gradle-jvm/src/main/groovy/org/asciidoctor/gradle/internal/ExecutorConfiguration.groovy

@@ -71,7 +71,7 @@ JRuby:
 Asciidoctor:
   ${options.size()} options
   ${attributes.size()} attributes
-  ${asciidoctorExtensions?.size() ?: 0} extensions
+  ${asciidoctorExtensions?.size() ?: 0} docExtensions
   logDocuments = ${logDocuments}, copyResources = ${copyResources}, safeMode = ${safeModeLevel}
 """
     }

asciidoctor-gradle-jvm/src/main/groovy/org/asciidoctor/gradle/jvm/AbstractAsciidoctorTask.groovy

@@ -111,12 +111,12 @@ class AbstractAsciidoctorTask extends DefaultTask {
      * conversion in parallel.
      *
      * When running sequential, the worker classloader, Asciidoctor instances
-     * and Asciidoctor extensions will be shared across all of the conversions.
+     * and Asciidoctor docExtensions will be shared across all of the conversions.
      * When running parallel each conversion will be in a separate classloader,
      * with a new Asciidoctor instance being initialised for every conversion.
      *
      * Sequential work might execute slightly faster, but if you have backend-specific
-     * extensions you might want to consider parallel mode (or use another Asciidoctor
+     * docExtensions you might want to consider parallel mode (or use another Asciidoctor
      * task instance).
      *
      * Default is parallel.
@@ -448,7 +448,7 @@ class AbstractAsciidoctorTask extends DefaultTask {
 
     /** Returns all of the specified configurations as a collections of files.
      *
-     * If any extensions are dependencies then they will be included here too.
+     * If any docExtensions are dependencies then they will be included here too.
      *
      * @return FileCollection
      */
@@ -721,7 +721,7 @@ class AbstractAsciidoctorTask extends DefaultTask {
      */
     @Internal
     protected List<Object> getAsciidoctorJExtensions() {
-        asciidoctorj.extensions
+        asciidoctorj.docExtensions
     }
 
     /** Obtains a source tree based on patterns.
@@ -948,7 +948,7 @@ class AbstractAsciidoctorTask extends DefaultTask {
 
     @SuppressWarnings('Instanceof')
     private FileCollection findDependenciesInExtensions() {
-        List<Dependency> deps = asciidoctorj.extensions.findAll {
+        List<Dependency> deps = asciidoctorj.docExtensions.findAll {
             it instanceof Dependency
         } as List<Dependency>
 
@@ -957,7 +957,7 @@ class AbstractAsciidoctorTask extends DefaultTask {
         }
 
         if (!closurePaths.empty) {
-            // Jumping through hoops to make extensions based upon closures to work.
+            // Jumping through hoops to make docExtensions based upon closures to work.
             closurePaths.add(getClassLocation(org.gradle.internal.scripts.ScriptOrigin))
             closurePaths.addAll(ifNoGroovyAddLocal(deps))
         }
@@ -1025,7 +1025,7 @@ class AbstractAsciidoctorTask extends DefaultTask {
     }
 
     private List<Closure> findExtensionClosures() {
-        asciidoctorj.extensions.findAll {
+        asciidoctorj.docExtensions.findAll {
             it instanceof Closure
         } as List<Closure>
     }