Skip to content

[docs] Sorted doc outputs and clean up duplicated CliOptions #5046

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
jimschubert merged 6 commits into from
Jan 20, 2020
Merged

[docs] Sorted doc outputs and clean up duplicated CliOptions #5046

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
57237f8
[config-help] Sort all outputs
jimschubert Jan 19, 2020
103c035
Remove old/stale generator docs (these have been renamed previously)
jimschubert Jan 19, 2020
3a2ad7a
Sort config doc outputs, making it easier to find relevant info
jimschubert Jan 19, 2020
f7e1584
Fixes cliOptions duplicates
jimschubert Jan 19, 2020
16a25d3
Add --github-nested-index for generating docs/generators/README.md
jimschubert Jan 19, 2020
943fd19
:memo: Regenerate generator docs
jimschubert Jan 19, 2020
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
Next Next commit
[config-help] Sort all outputs
  • Loading branch information
@jimschubert
jimschubert committed Jan 19, 2020
commit 57237f85f2f9c433323a19220902f6e46d8141e3
77 changes: 58 additions & 19 deletions modules/openapi-generator-cli/src/main/java/org/openapitools/codegen/cmd/ConfigHelp.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@
import java.nio.file.Paths;
import java.util.Locale;
import java.util.Map;
import java.util.TreeMap;
import java.util.function.Function;
import java.util.stream.Collectors;

import static org.apache.commons.lang3.StringEscapeUtils.escapeHtml4;
import static org.apache.commons.lang3.StringUtils.isEmpty;
Expand Down Expand Up @@ -164,12 +167,18 @@ private void generateMarkdownHelp(StringBuilder sb, CodegenConfig config) {
sb.append("| Option | Description | Values | Default |").append(newline);
sb.append("| ------ | ----------- | ------ | ------- |").append(newline);

for (CliOption langCliOption : config.cliOptions()) {
Map<String, CliOption> langCliOptions = config.cliOptions()
.stream()
.collect(Collectors.toMap(CliOption::getOpt, Function.identity(), (a, b) -> {
throw new IllegalStateException();
}, TreeMap::new));

langCliOptions.forEach((key, langCliOption) -> {
// start
sb.append("|");

// option
sb.append(escapeHtml4(langCliOption.getOpt())).append("|");
sb.append(escapeHtml4(key)).append("|");
// description
sb.append(escapeHtml4(langCliOption.getDescription())).append("|");

Expand All @@ -193,7 +202,7 @@ private void generateMarkdownHelp(StringBuilder sb, CodegenConfig config) {
sb.append(escapeHtml4(langCliOption.getDefault())).append("|");

sb.append(newline);
}
});


if (Boolean.TRUE.equals(importMappings)) {
Expand All @@ -205,10 +214,14 @@ private void generateMarkdownHelp(StringBuilder sb, CodegenConfig config) {
sb.append("| Type/Alias | Imports |").append(newline);
sb.append("| ---------- | ------- |").append(newline);

config.importMapping().forEach((key, value)-> {
sb.append("|").append(escapeHtml4(key)).append("|").append(escapeHtml4(value)).append("|");
sb.append(newline);
});
config.importMapping()
.entrySet()
.stream()
.sorted(Map.Entry.comparingByKey())
.forEachOrdered(kvp -> {
sb.append("|").append(escapeHtml4(kvp.getKey())).append("|").append(escapeHtml4(kvp.getValue())).append("|");
sb.append(newline);
});

sb.append(newline);
}
Expand All @@ -222,10 +235,14 @@ private void generateMarkdownHelp(StringBuilder sb, CodegenConfig config) {
sb.append("| Type/Alias | Instantiated By |").append(newline);
sb.append("| ---------- | --------------- |").append(newline);

config.instantiationTypes().forEach((key, value)-> {
sb.append("|").append(escapeHtml4(key)).append("|").append(escapeHtml4(value)).append("|");
sb.append(newline);
});
config.instantiationTypes()
.entrySet()
.stream()
.sorted(Map.Entry.comparingByKey())
.forEachOrdered(kvp -> {
sb.append("|").append(escapeHtml4(kvp.getKey())).append("|").append(escapeHtml4(kvp.getValue())).append("|");
sb.append(newline);
});

sb.append(newline);
}
Expand All @@ -236,7 +253,10 @@ private void generateMarkdownHelp(StringBuilder sb, CodegenConfig config) {
sb.append(newline);
sb.append(newline);
sb.append("<ul data-columns=\"2\" style=\"list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto\">");
config.languageSpecificPrimitives().forEach(s -> sb.append("<li>").append(escapeHtml4(s)).append("</li>").append(newline));
config.languageSpecificPrimitives()
.stream()
.sorted(String::compareTo)
.forEach(s -> sb.append("<li>").append(escapeHtml4(s)).append("</li>").append(newline));
sb.append("</ul>");
sb.append(newline);
}
Expand All @@ -247,7 +267,10 @@ private void generateMarkdownHelp(StringBuilder sb, CodegenConfig config) {
sb.append(newline);
sb.append(newline);
sb.append("<ul data-columns=\"2\" style=\"list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto\">");
config.reservedWords().forEach(s -> sb.append("<li>").append(escapeHtml4(s)).append("</li>").append(newline));
config.reservedWords()
.stream()
.sorted(String::compareTo)
.forEach(s -> sb.append("<li>").append(escapeHtml4(s)).append("</li>").append(newline));
sb.append("</ul>");
sb.append(newline);
}
Expand Down Expand Up @@ -294,21 +317,32 @@ private void generatePlainTextHelp(StringBuilder sb, CodegenConfig config) {
String optIndent = "\t";
String optNestedIndent = "\t ";

for (CliOption langCliOption : config.cliOptions()) {
sb.append(optIndent).append(langCliOption.getOpt());
Map<String, CliOption> langCliOptions = config.cliOptions()
.stream()
.collect(Collectors.toMap(CliOption::getOpt, Function.identity(), (a, b) -> {
throw new IllegalStateException();
}, TreeMap::new));

langCliOptions.forEach((key, langCliOption) -> {
sb.append(optIndent).append(key);
sb.append(newline);
sb.append(optNestedIndent).append(langCliOption.getOptionHelp()
.replaceAll("\n", System.lineSeparator() + optNestedIndent));
sb.append(newline);
sb.append(newline);
}
});

if (Boolean.TRUE.equals(importMappings)) {
sb.append(newline);
sb.append("IMPORT MAPPING");
sb.append(newline);
sb.append(newline);
Map<String, String> map = config.importMapping();
Map<String, String> map = config.importMapping()
.entrySet()
.stream()
.collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue, (a, b) -> {
throw new IllegalStateException();
}, TreeMap::new));
writePlainTextFromMap(sb, map, optIndent, optNestedIndent, "Type/Alias", "Imports");
sb.append(newline);
}
Expand All @@ -318,7 +352,12 @@ private void generatePlainTextHelp(StringBuilder sb, CodegenConfig config) {
sb.append("INSTANTIATION TYPES");
sb.append(newline);
sb.append(newline);
Map<String, String> map = config.instantiationTypes();
Map<String, String> map = config.instantiationTypes()
.entrySet()
.stream()
.collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue, (a, b) -> {
throw new IllegalStateException();
}, TreeMap::new));
writePlainTextFromMap(sb, map, optIndent, optNestedIndent, "Type/Alias", "Instantiated By");
sb.append(newline);
}
Expand Down Expand Up @@ -389,7 +428,7 @@ private void writePlainTextFromArray(StringBuilder sb, String[] arr, String optI
for (int i = 0; i < arr.length; i++) {
String current = arr[i];
sb.append(optIndent).append(String.format(Locale.ROOT, format, current));
if (i % columns == 0) {
if ((i + 1) % columns == 0) {
sb.append(newline);
}
}
Expand Down