Deprecate destinationDir option in API

Fix option to set ToDir internally. Deprecate destinationDir in Options and OptionsBuilder. Add JavaDoc pointing users to use toDir. Fixes asciidoctor#853 Fixes asciidoctor#941
abelsromero · Mar 30, 2023 · f8448fe · f8448fe
1 parent fa43680
commit f8448fe
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 3 deletions.
diff --git a/CHANGELOG.adoc b/CHANGELOG.adoc
@@ -21,6 +21,9 @@ Improvement::
 * Upgrade to asciidoctorj-diagram 2.2.4 (#1140)
 * Upgrade to jruby 9.3.10.0 (#1138) (@alexlevinfr)
 
+Bug Fixes::
+* Fix destinationDir not having effect. Deprecate destinationDir in favour of toDir (@abelsromero) (#853, #941)
+
 Build / Infrastructure::
 
 * Replace use of deprecated 'numbered' attribute by 'sectnums' (#1127) (@abelsromero)

diff --git a/asciidoctorj-api/src/main/java/org/asciidoctor/Options.java b/asciidoctorj-api/src/main/java/org/asciidoctor/Options.java
@@ -1,5 +1,6 @@
 package org.asciidoctor;
 
+import java.io.File;
 import java.io.OutputStream;
 import java.util.ArrayList;
 import java.util.Arrays;
@@ -171,6 +172,14 @@ public void setCompact(boolean compact) {
         this.options.put(COMPACT, compact);
     }
 
+    /**
+     * Destination output directory.
+     *
+     * @param destinationDir
+     *            destination directory.
+     * @deprecated Use {@link #setToDir(String)} instead.
+     */
+    @Deprecated
     public void setDestinationDir(String destinationDir) {
         this.options.put(DESTINATION_DIR, destinationDir);
     }

diff --git a/asciidoctorj-api/src/main/java/org/asciidoctor/OptionsBuilder.java b/asciidoctorj-api/src/main/java/org/asciidoctor/OptionsBuilder.java
@@ -305,13 +305,15 @@ public OptionsBuilder parseHeaderOnly(boolean parseHeaderOnly) {
 
     /**
      * Destination output directory.
-     * 
+     *
      * @param destinationDir
-     *            destination directory.
+     *             destination directory.
      * @return this instance.
+     * @deprecated Use {@link #toDir(File)} instead.
      */
+    @Deprecated
     public OptionsBuilder destinationDir(File destinationDir) {
-        this.options.setDestinationDir(destinationDir.getAbsolutePath());
+        this.options.setToDir(destinationDir.getAbsolutePath());
         return this;
     }