You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@servicecomb.apache.org by ni...@apache.org on 2019/06/21 07:09:31 UTC
[servicecomb-toolkit] 15/49: Optimize the type of document format
This is an automated email from the ASF dual-hosted git repository.
ningjiang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/servicecomb-toolkit.git
commit d3d7035200a47ab759dd92f35c07be40193b7e0c
Author: MabinGo <bi...@huawei.com>
AuthorDate: Fri May 24 15:33:28 2019 +0800
Optimize the type of document format
Signed-off-by: MabinGo <bi...@huawei.com>
---
.../toolkit/docgen/ContractsAsciidocGenerator.java | 14 +++++++++++++-
.../toolkit/docgen/ContractsSwaggerUIGenerator.java | 8 +++++---
.../org/apache/servicecomb/toolkit/cli/DocGenerate.java | 6 +++---
3 files changed, 21 insertions(+), 7 deletions(-)
diff --git a/doc-generator/src/main/java/org/apache/servicecomb/toolkit/docgen/ContractsAsciidocGenerator.java b/doc-generator/src/main/java/org/apache/servicecomb/toolkit/docgen/ContractsAsciidocGenerator.java
index a653ee4..7009653 100755
--- a/doc-generator/src/main/java/org/apache/servicecomb/toolkit/docgen/ContractsAsciidocGenerator.java
+++ b/doc-generator/src/main/java/org/apache/servicecomb/toolkit/docgen/ContractsAsciidocGenerator.java
@@ -42,7 +42,9 @@ public class ContractsAsciidocGenerator implements DocGenerator {
private static final Logger LOGGER = LoggerFactory.getLogger(ContractsAsciidocGenerator.class);
- private final static String DOC_FORMAT = "asciidoc";
+ private final static String DOC_FORMAT = "asciidoc-html";
+
+ private final static String DOC_SUFFIX = ".html";
@Override
public boolean canProcess(String type) {
@@ -75,6 +77,7 @@ public class ContractsAsciidocGenerator implements DocGenerator {
.asMap();
String asciidocResult = asciidoctor.convert(markup, optionsMap);
try {
+ outputPath = correctPath(outputPath);
Files.write(Paths.get(outputPath), asciidocResult.getBytes());
} catch (IOException e) {
LOGGER.error(e.getMessage());
@@ -82,4 +85,13 @@ public class ContractsAsciidocGenerator implements DocGenerator {
return asciidocResult;
}
+
+ private String correctPath(String filepath) {
+
+ if (!filepath.endsWith(DOC_SUFFIX)) {
+ return filepath + "-" + DOC_FORMAT + DOC_SUFFIX;
+ }
+
+ return filepath;
+ }
}
diff --git a/doc-generator/src/main/java/org/apache/servicecomb/toolkit/docgen/ContractsSwaggerUIGenerator.java b/doc-generator/src/main/java/org/apache/servicecomb/toolkit/docgen/ContractsSwaggerUIGenerator.java
index 26a0aa1..8d16173 100755
--- a/doc-generator/src/main/java/org/apache/servicecomb/toolkit/docgen/ContractsSwaggerUIGenerator.java
+++ b/doc-generator/src/main/java/org/apache/servicecomb/toolkit/docgen/ContractsSwaggerUIGenerator.java
@@ -35,7 +35,9 @@ public class ContractsSwaggerUIGenerator implements DocGenerator {
private static Pattern variablePattern = Pattern.compile("(?<=\\{\\{)[a-zA-Z0-9_-]*(?=\\}\\})");
- private final static String DOC_FORMAT = "html";
+ private final static String DOC_FORMAT = "swagger-ui";
+
+ private final static String DOC_SUFFIX = ".html";
@Override
@@ -71,8 +73,8 @@ public class ContractsSwaggerUIGenerator implements DocGenerator {
private String correctPath(String filepath) {
- if (!filepath.endsWith("." + DOC_FORMAT)) {
- return filepath + DOC_FORMAT;
+ if (!filepath.endsWith(DOC_SUFFIX)) {
+ return filepath + "-" + DOC_FORMAT + DOC_SUFFIX;
}
return filepath;
diff --git a/toolkit-cli/src/main/java/org/apache/servicecomb/toolkit/cli/DocGenerate.java b/toolkit-cli/src/main/java/org/apache/servicecomb/toolkit/cli/DocGenerate.java
index 85fc0e6..f3089e9 100755
--- a/toolkit-cli/src/main/java/org/apache/servicecomb/toolkit/cli/DocGenerate.java
+++ b/toolkit-cli/src/main/java/org/apache/servicecomb/toolkit/cli/DocGenerate.java
@@ -41,8 +41,8 @@ public class DocGenerate implements Runnable {
@Option(name = {"-f", "--format"}, title = "document format", required = false,
- description = "format of document, as html or asciidoc (html by default)")
- private String format = "html";
+ description = "format of document, as swagger-ui or asciidoc-html (swagger-ui by default)")
+ private String format = "swagger-ui";
@Option(name = {"-o", "--output"}, title = "output directory",
description = "location of the generated document (current dir by default)")
@@ -62,7 +62,7 @@ public class DocGenerate implements Runnable {
DocGeneratorManager.generate(SwaggerUtils.parseSwagger(file.toUri().toURL()),
output + File.separator + file.toFile().getName().substring(0, file.toFile().getName().indexOf(".")),
- "html");
+ format);
return super.visitFile(file, attrs);
}
});