Skip to content

Commit b9f3b58

Browse files
committed
change docsgen to use h3s instead of collapsible common options
1 parent 6611146 commit b9f3b58

4 files changed

Lines changed: 9 additions & 12 deletions

File tree

‎docs_spec.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"collapsibleOptionGroups" : [
2+
"commonGroups" : [
33
"Common Options",
44
"Connection Options"
55
],

‎src/main/java/com/dtsx/astra/cli/core/docs/AsciidocGenerator.java‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@
99
import picocli.CommandLine.Model.CommandSpec;
1010

1111
import java.util.List;
12-
import java.util.stream.Collectors;
1312
import java.util.stream.Stream;
1413

1514
import static com.dtsx.astra.cli.core.docs.AliasUtils.resolveAliasingInformation;
@@ -90,11 +89,11 @@ private DocsPageSections mkDocsPageSections(List<String> commandFullName, Comman
9089
}
9190

9291
private CommandOptions resolveCommandOptions(CommandSpec commandSpec) {
93-
val collapsibleGroups = docsSpec.collapsibleOptionGroups();
92+
val commonGroups = docsSpec.commonGroups();
9493

9594
return new CommandOptions(
96-
commandSpec.argGroups().stream().filter((g) -> g.heading() != null && collapsibleGroups.stream().anyMatch(g.heading()::contains)).toList(),
97-
commandSpec.argGroups().stream().filter((g) -> g.heading() == null || collapsibleGroups.stream().noneMatch(g.heading()::contains)).toList(),
95+
commandSpec.argGroups().stream().filter((g) -> g.heading() != null && commonGroups.stream().anyMatch(g.heading()::contains)).toList(),
96+
commandSpec.argGroups().stream().filter((g) -> g.heading() == null || commonGroups.stream().noneMatch(g.heading()::contains)).toList(),
9897
commandSpec.args().stream().filter((a) -> a.group() == null).toList()
9998
);
10099
}

‎src/main/java/com/dtsx/astra/cli/core/docs/DocsPage.java‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ public String render() {
145145
}
146146
}
147147

148-
public record CommandOptions(List<ArgGroupSpec> hiddenGroups, List<ArgGroupSpec> groupArgs, List<ArgSpec> nonGroupArgs) implements DocsPageSection {
148+
public record CommandOptions(List<ArgGroupSpec> commonGroups, List<ArgGroupSpec> groupArgs, List<ArgSpec> nonGroupArgs) implements DocsPageSection {
149149
@Override
150150
public String render() {
151151
val sb = new StringBuilder("== Options").append(NL).append(NL);
@@ -167,15 +167,13 @@ public String render() {
167167
}
168168
}
169169

170-
for (val group : hiddenGroups) {
170+
for (val group : commonGroups) {
171171
sb.append(NL);
172-
sb.append('.').append(group.heading().replaceAll("%n|:", "")).append(NL);
173-
sb.append("[%collapsible").append("]").append(NL);
174-
sb.append("====").append(NL);
172+
sb.append("=== ").append(group.heading().replaceAll("%n|:", "")).append(NL);
175173
for (val arg : allNestedArgs(group)) {
176174
renderArg(sb, arg);
177175
}
178-
sb.append("====").append(NL);
176+
sb.append("=== ").append(NL);
179177
}
180178

181179
return sb.toString();

‎src/main/java/com/dtsx/astra/cli/core/docs/ExternalDocsSpec.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
import java.util.Map;
77

88
public record ExternalDocsSpec(
9-
@JsonProperty(required = true) List<String> collapsibleOptionGroups,
9+
@JsonProperty(required = true) List<String> commonGroups,
1010
@JsonProperty(required = true) List<String> hideCommands,
1111
@JsonProperty(required = true) Map<String, List<String>> seeAlsoLinks
1212
) {}

0 commit comments

Comments
 (0)