Show the value that will be used if not customized (#177)

* Show the value that will be used if not customized * enhanced code organization * Update src/template.jl Co-authored-by: Chris de Graaf <[email protected]> * Display default values for plugin options too --------- Co-authored-by: Guillaume Dalle <[email protected]> Co-authored-by: Chris de Graaf <[email protected]>
JuliaCI · Dec 26, 2023 · 46997ed · 46997ed
1 parent 2f97d4c
commit 46997ed
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -32,6 +32,8 @@ using PkgTemplates
 Template(interactive=true)("MyPkg")
 ```
 
+This will prompt you to select options, displaying the default settings in parentheses.
+
 ### Manual creation
 
 Creating a `Template` is as simple as:

diff --git a/src/interactive.jl b/src/interactive.jl
@@ -26,11 +26,15 @@ function interactive(T::Type)
     just_one = length(pairs) == 1
     just_one && push!(pairs, :None => Nothing)
 
-    menu = MultiSelectMenu(
-        collect(map(pair -> string(first(pair)), pairs));
-        pagesize=length(pairs),
-    )
     println("$(nameof(T)) keywords to customize:")
+    opts = map(first.(pairs)) do k
+        if k != :None
+            "$k ($(repr(defaultkw(T, k))))"
+        else
+            "$k"
+        end
+    end
+    menu = MultiSelectMenu(opts; pagesize=length(pairs))
     customize = sort!(collect(request(menu)))
 
     # If the "None" option was selected, don't customize anything.

diff --git a/src/template.jl b/src/template.jl
@@ -205,7 +205,8 @@ function interactive(::Type{Template}; kwargs...)
 
     try
         println("Template keywords to customize:")
-        menu = MultiSelectMenu(map(string, customizable); pagesize=length(customizable))
+        opts = map(k -> "$k ($(repr(defaultkw(Template, k))))" , customizable)
+        menu = MultiSelectMenu(opts; pagesize=length(customizable))
         customize = customizable[sort!(collect(request(menu)))]
         just_one && last(customizable) in customize && return Template(; kwargs...)