clojurephant · ajoberstar · Aug 21, 2022 · Aug 21, 2022
diff --git a/docs/modules/reference/pages/dsl/clojurescriptbuild.adoc b/docs/modules/reference/pages/dsl/clojurescriptbuild.adoc
@@ -31,6 +31,10 @@ Represents ClojureScript source code that should be compiled as a unit.
 |compiler
 |xref:dsl/clojurescriptcompileoptions.adoc[]
 |Configure the ClojureScript compiler for the build's xref:tasks/clojurescriptcompile.adoc[] task
+
+|figwheel
+|xref:dsl/figwheeloptions.adoc[]
+|Configure Figwheel options for use by xref:clojurephant-tooling::index.adoc[clojurephant-tooling]
 |===
 
 == Methods
@@ -42,6 +46,9 @@ Represents ClojureScript source code that should be compiled as a unit.
 
 |void compiler(Action<? super ClojureScriptCompilerOptions> action)
 |Allows configuring the compiler options in a block
+
+|void figwheel(Action<? super FigwheelOptions> action)
+|Allows configuring the figwheel options in a block
 |===
 
 == Example

diff --git a/docs/modules/reference/pages/dsl/figwheeloptions.adoc b/docs/modules/reference/pages/dsl/figwheeloptions.adoc
@@ -0,0 +1,132 @@
+= FigwheelOptions
+
+**Source:** link:https://github.com/clojurephant/clojurephant/blob/{page-origin-refname}/src/main/java/dev/clojurephant/plugin/clojurescript/tasks/FigwheelOptions.java[`dev.clojurephant.plugin.clojurescript.tasks.FigwheelOptions`]
+
+Options for Figwheel (see link:https://figwheel.org/config-options[Figwheel's documentation]).
+
+== Properties
+
+NOTE: Not all Figwheel options are supported yet. Open an issue or submit a PR if there's one you'd like added.
+
+[cols="2*m,1a", options="header"]
+|===
+|Property
+|Type
+|Description
+
+|targetDir
+|link:https://docs.gradle.org/current/javadoc/org/gradle/api/file/DirectoryProperty.html[DirectoryProperty]
+|Defaults to the build's `outputDir`
+
+|watchDirs
+|link:https://docs.gradle.org/current/javadoc/org/gradle/api/file/ConfigurableFileCollection.html[ConfigurableFileCollection]
+|
+
+|cssDirs
+|link:https://docs.gradle.org/current/javadoc/org/gradle/api/file/ConfigurableFileCollection.html[ConfigurableFileCollection]
+|
+
+|ringHandler
+|link:https://docs.gradle.org/current/javadoc/org/gradle/api/provider/Property.html[Property<String>]
+|
+
+|ringServerOptions
+|link:https://docs.gradle.org/current/javadoc/org/gradle/api/provider/MapProperty.html[MapProperty<String, Object>]
+|
+
+|rebelReadline
+|link:https://docs.gradle.org/current/javadoc/org/gradle/api/provider/Property.html[Property<Boolean>]
+|Defaults to `false` (overriding Figwheel's default)
+
+|pprintConfig
+|link:https://docs.gradle.org/current/javadoc/org/gradle/api/provider/Property.html[Property<Boolean>]
+|
+
+|openFileCommand
+|link:https://docs.gradle.org/current/javadoc/org/gradle/api/provider/Property.html[Property<String>]
+|
+
+|figwheelCore
+|link:https://docs.gradle.org/current/javadoc/org/gradle/api/provider/Property.html[Property<Boolean>]
+|
+
+|hotReloadCljs
+|link:https://docs.gradle.org/current/javadoc/org/gradle/api/provider/Property.html[Property<Boolean>]
+|
+
+|connectUrl
+|link:https://docs.gradle.org/current/javadoc/org/gradle/api/provider/Property.html[Property<String>]
+|
+
+|openUrl
+|link:https://docs.gradle.org/current/javadoc/org/gradle/api/provider/Property.html[Property<Object>]
+|
+
+|reloadCljFiles
+|link:https://docs.gradle.org/current/javadoc/org/gradle/api/provider/Property.html[Property<String>]
+|
+
+|logFile
+|link:https://docs.gradle.org/current/javadoc/org/gradle/api/file/RegularFileProperty.html[RegularFileProperty]
+|
+
+|logLevel
+|link:https://docs.gradle.org/current/javadoc/org/gradle/api/provider/Property.html[Property<String>]
+|
+
+|clientLogLevel
+|link:https://docs.gradle.org/current/javadoc/org/gradle/api/provider/Property.html[Property<String>]
+|
+
+|logSyntaxErrorStyle
+|link:https://docs.gradle.org/current/javadoc/org/gradle/api/provider/Property.html[Property<String>]
+|
+
+|loadWarningedCode
+|link:https://docs.gradle.org/current/javadoc/org/gradle/api/provider/Property.html[Property<Boolean>]
+|
+
+|ansiColorOutput
+|link:https://docs.gradle.org/current/javadoc/org/gradle/api/provider/Property.html[Property<Boolean>]
+|
+
+|validateConfig
+|link:https://docs.gradle.org/current/javadoc/org/gradle/api/provider/Property.html[Property<Boolean>]
+|
+
+|validateCli
+|link:https://docs.gradle.org/current/javadoc/org/gradle/api/provider/Property.html[Property<Boolean>]
+|
+
+|launchNode
+|link:https://docs.gradle.org/current/javadoc/org/gradle/api/provider/Property.html[Property<Boolean>]
+|
+
+|inspectNode
+|link:https://docs.gradle.org/current/javadoc/org/gradle/api/provider/Property.html[Property<Boolean>]
+|
+
+|nodeCommand
+|link:https://docs.gradle.org/current/javadoc/org/gradle/api/provider/Property.html[Property<String>]
+|
+
+|launchJs
+|link:https://docs.gradle.org/current/javadoc/org/gradle/api/provider/Property.html[Property<String>]
+|
+
+|cljsDevtools
+|link:https://docs.gradle.org/current/javadoc/org/gradle/api/provider/Property.html[Property<Boolean>]
+|
+
+|helpfulClasspaths
+|link:https://docs.gradle.org/current/javadoc/org/gradle/api/provider/Property.html[Property<Boolean>]
+|Defaults to `false` (overriding Figwheel's default)
+|===
+
+== Methods
+
+_None_
+
+== Example
+
+See xref:dsl/clojurescriptextension.adoc[].
diff --git a/src/main/java/dev/clojurephant/plugin/clojurescript/ClojureScriptBasePlugin.java b/src/main/java/dev/clojurephant/plugin/clojurescript/ClojureScriptBasePlugin.java
@@ -89,6 +89,11 @@ private void configureBuildDefaults(Project project, SourceSetContainer sourceSe
         module.getBaseOutputDirectory().set(build.getCompiler().getBaseOutputDirectory());
       });
 
+      build.getFigwheel().getTargetDir().set(build.getOutputDir());
+      build.getFigwheel().getWatchDirs().from(build.getSourceRoots());
+      build.getFigwheel().getRebelReadline().set(false);
+      build.getFigwheel().getHelpfulClasspaths().set(false);
+
       String compileTaskName = build.getTaskName("compile");
       TaskProvider<ClojureScriptCompile> compileTask = project.getTasks().register(compileTaskName, ClojureScriptCompile.class, task -> {
         task.setDescription(String.format("Compiles the ClojureScript source for the %s build.", build.getName()));

diff --git a/src/main/java/dev/clojurephant/plugin/clojurescript/ClojureScriptBuild.java b/src/main/java/dev/clojurephant/plugin/clojurescript/ClojureScriptBuild.java
@@ -1,6 +1,7 @@
 package dev.clojurephant.plugin.clojurescript;
 
 import dev.clojurephant.plugin.clojurescript.tasks.ClojureScriptCompileOptions;
+import dev.clojurephant.plugin.clojurescript.tasks.FigwheelOptions;
 import org.apache.commons.text.WordUtils;
 import org.gradle.api.Action;
 import org.gradle.api.Named;
@@ -38,6 +39,13 @@ public void compiler(Action<? super ClojureScriptCompileOptions> configureAction
     configureAction.execute(getCompiler());
   }
 
+  @Nested
+  public abstract FigwheelOptions getFigwheel();
+
+  public void figwheel(Action<? super FigwheelOptions> configureAction) {
+    configureAction.execute(getFigwheel());
+  }
+
   String getTaskName(String task) {
     if ("main".equals(getName())) {
       return String.format("%sClojureScript", task);

diff --git a/src/main/java/dev/clojurephant/plugin/clojurescript/ClojureScriptPlugin.java b/src/main/java/dev/clojurephant/plugin/clojurescript/ClojureScriptPlugin.java
@@ -11,5 +11,16 @@ public class ClojureScriptPlugin implements Plugin<Project> {
   public void apply(Project project) {
     project.getPlugins().apply(ClojureScriptBasePlugin.class);
     project.getPlugins().apply(ClojureCommonPlugin.class);
+    configureFigwheel(project);
+  }
+
+  public void configureFigwheel(Project project) {
+    ClojureScriptExtension extension = project.getExtensions().getByType(ClojureScriptExtension.class);
+    ClojureScriptBuild main = extension.getBuilds().getByName("main");
+    ClojureScriptBuild test = extension.getBuilds().getByName("test");
+    ClojureScriptBuild dev = extension.getBuilds().getByName("dev");
+
+    dev.getFigwheel().getWatchDirs().from(main.getSourceRoots());
+    dev.getFigwheel().getWatchDirs().from(test.getSourceRoots());
   }
 }
diff --git a/src/main/java/dev/clojurephant/plugin/clojurescript/tasks/FigwheelOptions.java b/src/main/java/dev/clojurephant/plugin/clojurescript/tasks/FigwheelOptions.java
@@ -0,0 +1,102 @@
+package dev.clojurephant.plugin.clojurescript.tasks;
+
+import java.util.HashMap;
+import java.util.Map;
+
+import org.gradle.api.Project;
+import org.gradle.api.file.ConfigurableFileCollection;
+import org.gradle.api.file.Directory;
+import org.gradle.api.file.DirectoryProperty;
+import org.gradle.api.file.RegularFileProperty;
+import org.gradle.api.provider.MapProperty;
+import org.gradle.api.provider.Property;
+import org.gradle.api.provider.Provider;
+import org.gradle.api.tasks.Input;
+import org.gradle.api.tasks.InputFiles;
+import org.gradle.api.tasks.OutputDirectory;
+import org.gradle.api.tasks.OutputFile;
+
+public abstract class FigwheelOptions {
+  @OutputDirectory
+  public abstract DirectoryProperty getTargetDir();
+
+  @InputFiles
+  public abstract ConfigurableFileCollection getWatchDirs();
+
+  @InputFiles
+  public abstract ConfigurableFileCollection getCssDirs();
+
+  @Input
+  public abstract Property<String> getRingHandler();
+
+  @Input
+  public abstract MapProperty<String, Object> getRingServerOptions();
+
+  @Input
+  public abstract Property<Boolean> getRebelReadline();
+
+  @Input
+  public abstract Property<Boolean> getPprintConfig();
+
+  @Input
+  public abstract Property<String> getOpenFileCommand();
+
+  @Input
+  public abstract Property<Boolean> getFigwheelCore();
+
+  @Input
+  public abstract Property<Boolean> getHotReloadCljs();
+
+  @Input
+  public abstract Property<String> getConnectUrl();
+
+  @Input
+  public abstract Property<Object> getOpenUrl();
+
+  @Input
+  public abstract Property<String> getReloadCljFiles();
+
+  @OutputFile
+  public abstract RegularFileProperty getLogFile();
+
+  @Input
+  public abstract Property<String> getLogLevel();
+
+  @Input
+  public abstract Property<String> getClientLogLevel();
+
+  @Input
+  public abstract Property<String> getLogSyntaxErrorStyle();
+
+  @Input
+  public abstract Property<Boolean> getLoadWarningedCode();
+
+  @Input
+  public abstract Property<Boolean> getAnsiColorOutput();
+
+  @Input
+  public abstract Property<Boolean> getValidateConfig();
+
+  @Input
+  public abstract Property<Boolean> getValidateCli();
+
+  @Input
+  public abstract Property<Boolean> getLaunchNode();
+
+  @Input
+  public abstract Property<Boolean> getInspectNode();
+
+  @Input
+  public abstract Property<String> getNodeCommand();
+
+  @Input
+  public abstract Property<String> getLaunchJs();
+
+  @Input
+  public abstract Property<Boolean> getCljsDevtools();
+
+  @Input
+  public abstract Property<Boolean> getHelpfulClasspaths();
+
+  // skipping remaining options for now
+}
diff --git a/src/main/java/dev/clojurephant/plugin/common/internal/Edn.java b/src/main/java/dev/clojurephant/plugin/common/internal/Edn.java
@@ -18,6 +18,7 @@
 import dev.clojurephant.plugin.clojure.tasks.ClojureCompileOptions;
 import dev.clojurephant.plugin.clojurescript.ClojureScriptBuild;
 import dev.clojurephant.plugin.clojurescript.tasks.ClojureScriptCompileOptions;
+import dev.clojurephant.plugin.clojurescript.tasks.FigwheelOptions;
 import dev.clojurephant.plugin.clojurescript.tasks.ForeignLib;
 import dev.clojurephant.plugin.clojurescript.tasks.Module;
 import org.gradle.api.NamedDomainObjectCollection;
@@ -40,6 +41,8 @@ public class Edn {
 
   private static final Printer.Fn<File> FILE_PRINTER = (self, printer) -> printer.printValue(self.getAbsolutePath());
 
+  private static final Printer.Fn<RegularFile> REGULAR_FILE_PRINTER = (self, printer) -> printer.printValue(self.getAsFile());
+
   private static final Printer.Fn<Directory> DIRECTORY_PRINTER = (self, printer) -> printer.printValue(self.getAsFile());
 
   private static final Printer.Fn<FileCollection> FILE_COLLECTION_PRINTER = (self, printer) -> {
@@ -78,6 +81,7 @@ public class Edn {
     root.put(newKeyword("source-paths"), self.getSourceRoots());
     root.put(newKeyword("output-dir"), self.getOutputDir().map(Directory::getAsFile).getOrNull());
     root.put(newKeyword("compiler"), self.getCompiler());
+    root.put(newKeyword("figwheel"), self.getFigwheel());
     printer.printValue(root);
   };
 
@@ -167,10 +171,44 @@ private static Map<Symbol, Symbol> parseGlobalExports(Map<String, String> global
     printer.printValue(map);
   };
 
+  private static final Printer.Fn<FigwheelOptions> FIGWHEEL_PRINTER = (figwheel, printer) -> {
+    Map<Object, Object> map = new LinkedHashMap<>();
+    map.put(newKeyword("target-dir"), figwheel.getTargetDir());
+    map.put(newKeyword("watch-dirs"), figwheel.getWatchDirs());
+    map.put(newKeyword("css-dirs"), figwheel.getCssDirs());
+    map.put(newKeyword("ring-handler"), figwheel.getRingHandler());
+    map.put(newKeyword("ring-server-options"), figwheel.getRingServerOptions());
+    map.put(newKeyword("rebel-readline"), figwheel.getRebelReadline());
+    map.put(newKeyword("pprint-config"), figwheel.getPprintConfig());
+    map.put(newKeyword("open-file-command"), figwheel.getOpenFileCommand());
+    map.put(newKeyword("figwheel-core"), figwheel.getFigwheelCore());
+    map.put(newKeyword("hot-reload-cljs"), figwheel.getHotReloadCljs());
+    map.put(newKeyword("connect-url"), figwheel.getConnectUrl());
+    map.put(newKeyword("open-url"), figwheel.getOpenUrl());
+    map.put(newKeyword("reload-clj-files"), figwheel.getReloadCljFiles());
+    map.put(newKeyword("log-file"), figwheel.getLogFile());
+    map.put(newKeyword("log-level"), figwheel.getLogLevel());
+    map.put(newKeyword("client-log-level"), figwheel.getClientLogLevel());
+    map.put(newKeyword("log-syntax-error-style"), figwheel.getLogSyntaxErrorStyle());
+    map.put(newKeyword("load-warninged-code"), figwheel.getLoadWarningedCode());
+    map.put(newKeyword("ansi-color-output"), figwheel.getAnsiColorOutput());
+    map.put(newKeyword("validate-config"), figwheel.getValidateConfig());
+    map.put(newKeyword("validate-cli"), figwheel.getValidateCli());
+    map.put(newKeyword("launch-node"), figwheel.getLaunchNode());
+    map.put(newKeyword("inspect-node"), figwheel.getInspectNode());
+    map.put(newKeyword("node-command"), figwheel.getNodeCommand());
+    map.put(newKeyword("launch-js"), figwheel.getLaunchJs());
+    map.put(newKeyword("cljs-devtools"), figwheel.getCljsDevtools());
+    map.put(newKeyword("helpful-classpaths"), figwheel.getHelpfulClasspaths());
+    Edn.removeEmptyAndNulls(map);
+    printer.printValue(map);
+  };
+
   private static final Protocol<Printer.Fn<?>> PROTOCOL = Printers.prettyProtocolBuilder()
       // Core Printers
       .put(Enum.class, ENUM_PRINTER)
       .put(File.class, FILE_PRINTER)
+      .put(RegularFile.class, REGULAR_FILE_PRINTER)
       .put(Directory.class, DIRECTORY_PRINTER)
       .put(FileCollection.class, FILE_COLLECTION_PRINTER)
       .put(NamedDomainObjectCollection.class, NAMED_DOMAIN_PRINTER)
@@ -183,6 +221,7 @@ private static Map<Symbol, Symbol> parseGlobalExports(Map<String, String> global
       .put(ClojureScriptCompileOptions.class, CLOJURESCRIPT_COMPILE_OPTIONS_PRINTER)
       .put(ForeignLib.class, FOREIGN_LIB_PRINTER)
       .put(Module.class, MODULE_PRINTER)
+      .put(FigwheelOptions.class, FIGWHEEL_PRINTER)
       .build();
 
   public static String print(Object value) {
@@ -196,6 +235,7 @@ public static <V> Map<Keyword, V> keywordize(Map<String, V> map) {
 
   private static <K, V> void removeEmptyAndNulls(Map<K, V> map) {
     map.values().removeIf(Objects::isNull);
+    map.values().removeIf(obj -> (obj instanceof Provider) && !((Provider<?>) obj).isPresent());
     map.values().removeIf(obj -> (obj instanceof Collection) && ((Collection<?>) obj).isEmpty());
     map.values().removeIf(obj -> (obj instanceof Map) && ((Map<?, ?>) obj).isEmpty());
     map.values().removeIf(obj -> (obj instanceof FileCollection) && ((FileCollection) obj).isEmpty());