Skip to content

fix: align genadoc.java aesh version and add --format option #2699

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
maxandersen merged 1 commit into from
Nov 4, 2026
Merged

fix: align genadoc.java aesh version and add --format option #2699

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 22 additions & 7 deletions docs/genadoc.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
///usr/bin/env jbang "$0" "$@" ; exit $?
//DEPS org.aesh:aesh:3.16.4
//DEPS org.aesh:aesh:3.18.1
///COMPILE_OPTIONS -proc:none
//JAVA 17+

Expand All @@ -14,14 +14,15 @@
* Generates AsciiDoc CLI reference pages from aesh command metadata.
* Delegates to aesh's built-in DocumentationGenerator.
*
* Usage: jbang docs/genadoc.java -d docs/modules/cli --force dev.jbang.cli.JBang
* Usage: jbang docs/genadoc.java -d docs/modules/cli [--format asciidoc|markdown|skill] --force dev.jbang.cli.JBang
*/
public class genadoc {

public static void main(String[] args) throws Exception {
String outDir = ".";
String crossRefPrefix = "jbang:cli:";
String className = null;
DocFormat format = DocFormat.ASCIIDOC;

for (int i = 0; i < args.length; i++) {
switch (args[i]) {
Expand All @@ -37,6 +38,18 @@ public static void main(String[] args) throws Exception {
case "-f":
// force is always on with the new generator (overwrites existing files)
break;
case "--format":
if (i + 1 >= args.length) {
System.err.println("Error: --format requires a value (asciidoc, markdown, skill)");
System.exit(2);
}
try {
format = DocFormat.valueOf(args[++i].toUpperCase());
} catch (IllegalArgumentException e) {
System.err.println("Error: unknown format '" + args[i] + "'. Supported: asciidoc, markdown, skill");
System.exit(2);
}
break;
case "--component-root":
if (i + 1 >= args.length) {
System.err.println("Error: --component-root requires a value");
Expand All @@ -50,7 +63,7 @@ public static void main(String[] args) throws Exception {
}

if (className == null) {
System.err.println("Usage: genadoc [-d outdir] [--force] [--component-root prefix] <commandClass>");
System.err.println("Usage: genadoc [-d outdir] [--format asciidoc|markdown|skill] [--force] [--component-root prefix] <commandClass>");
System.exit(2);
}

Expand All @@ -60,13 +73,15 @@ public static void main(String[] args) throws Exception {
Path pagesDir = Paths.get(outDir, "pages");
Files.createDirectories(pagesDir);

DocumentationGenerator.builder()
DocumentationGenerator.Builder builder = DocumentationGenerator.builder()
.commandClass(cmdClass)
.outputDir(pagesDir.toFile())
.crossRefPrefix(crossRefPrefix)
.navFile(Paths.get(outDir, "nav.adoc").toFile())
.format(DocFormat.ASCIIDOC)
.generate();
.format(format);
if (format == DocFormat.ASCIIDOC) {
builder.navFile(Paths.get(outDir, "nav.adoc").toFile());
}
builder.generate();

System.out.println("Documentation generated in " + outDir);
}
Expand Down
Loading