docs: 更新部分版本信息、忽略配置

afkT · Jun 29, 2023 · 18822e5 · 18822e5
1 parent 44aa9ef
commit 18822e5
Show file tree

Hide file tree

Showing 6 changed files with 618 additions and 3 deletions.
diff --git a/src/main/java/javadoc/dev_utils/ApiConfig.java b/src/main/java/javadoc/dev_utils/ApiConfig.java
@@ -48,8 +48,17 @@ private ApiConfig() {
 
  // DevUtils Readme 文件保存路径
  public static final String DEV_UTILS_README_FILE_SAVE_PATH = API_FILE_SAVE_PATH;
- // DevUtils Template Readme
- public static final String DEV_UTILS_TEMPLATE = JAVADOC_TEMPLATE_PACKAGE_PATH + "/Dev_README.md";
+ // DevUtils Readme
+ public static final String DEV_UTILS_README = JAVADOC_TEMPLATE_PACKAGE_PATH + "/Dev_README.md";
+ // DevUtils 完整 API Readme
+ public static final String DEV_UTILS_README_API = JAVADOC_TEMPLATE_PACKAGE_PATH + "/DEV_README_API.md";
+ // DevUtils 原始 Readme
+ public static final String DEV_UTILS_README_ORIGINAL = JAVADOC_TEMPLATE_PACKAGE_PATH + "/DEV_README_ORIGINAL.md";
+
+ // DevUtils 完整 API fileName
+ public static final String README_FILE_NAME_API = "README_API.md";
+ // DevUtils 原始 Readme fileName
+ public static final String README_FILE_NAME_ORIGINAL = "README_ORIGINAL.md";
 
  // ==========
  // = DevApp =

diff --git a/src/main/java/javadoc/dev_utils/readme/Dev_READMEMain.java b/src/main/java/javadoc/dev_utils/readme/Dev_READMEMain.java
@@ -22,7 +22,7 @@ private Dev_READMEMain() {
  public static String createREADME() {
  StringBuilder builder = new StringBuilder();
  // template readme content
- byte[] bytes = FileUtils.readFileBytes(ApiConfig.DEV_UTILS_TEMPLATE);
+ byte[] bytes = FileUtils.readFileBytes(ApiConfig.DEV_UTILS_README);
  String templateContent = new String(bytes);
 
  // 保存 README 内容

diff --git a/src/main/java/javadoc/dev_utils/readme/Dev_READMEMain_API.java b/src/main/java/javadoc/dev_utils/readme/Dev_READMEMain_API.java
@@ -0,0 +1,74 @@
+package javadoc.dev_utils.readme;
+
+import java.io.File;
+import java.text.MessageFormat;
+
+import dev.utils.common.FileUtils;
+import javadoc.dev_utils.ApiConfig;
+
+/**
+ * detail: 创建 README Main 方法
+ * @author Ttt
+ */
+final class Dev_READMEMain_API {
+
+ private Dev_READMEMain_API() {
+ }
+
+ /**
+ * 创建 README 文件
+ * @return Create Result
+ */
+ public static String createREADME() {
+ StringBuilder builder = new StringBuilder();
+ // template readme content
+ byte[] bytes = FileUtils.readFileBytes(ApiConfig.DEV_UTILS_README_API);
+ String templateContent = new String(bytes);
+
+ // 保存 README 内容
+ builder.append(MessageFormat.format(
+ // MessageFormat 会移除单引号, 所以需要加上双引号处理
+ templateContent.replaceAll("'", "''"),
+ ApiConfig.DEV_APP_VERSION,
+ ApiConfig.DEV_APP_VERSION,
+ ApiConfig.DEV_ASSIST_VERSION,
+ ApiConfig.DEV_BASE_VERSION,
+ ApiConfig.DEV_BASE_MVVM_VERSION,
+ ApiConfig.DEV_ENGINE_VERSION,
+ ApiConfig.DEV_HTTP_CAPTURE_VERSION,
+ ApiConfig.DEV_HTTP_CAPTURE_VERSION,
+ ApiConfig.DEV_HTTP_CAPTURE_VERSION,
+ ApiConfig.DEV_HTTP_MANAGER_VERSION,
+ ApiConfig.DEV_RETROFIT_VERSION,
+ ApiConfig.DEV_WIDGET_VERSION,
+ ApiConfig.DEV_ENVIRONMENT_VERSION,
+ ApiConfig.DEV_ENVIRONMENT_VERSION,
+ ApiConfig.DEV_ENVIRONMENT_VERSION,
+ ApiConfig.DEV_ENVIRONMENT_VERSION,
+ ApiConfig.DEV_JAVA_VERSION
+ ));
+
+ // 保存 README
+ FileUtils.saveFile(
+ new File(
+ ApiConfig.DEV_UTILS_README_FILE_SAVE_PATH,
+ ApiConfig.README_FILE_NAME_API
+ ).getAbsolutePath(), builder.toString().getBytes()
+ );
+
+ StringBuilder resultBuilder = new StringBuilder();
+ resultBuilder.append("\n");
+ resultBuilder.append("\n==================");
+ resultBuilder.append("\n= 保存 Readme 成功 =");
+ resultBuilder.append("\n==================");
+ resultBuilder.append("\n");
+ resultBuilder.append("\n");
+ resultBuilder.append("保存地址: " + ApiConfig.DEV_UTILS_README_FILE_SAVE_PATH + ApiConfig.README_FILE_NAME_API);
+ resultBuilder.append("\n");
+ return resultBuilder.toString();
+ }
+
+ public static void main(String[] args) {
+ System.out.println(Dev_READMEMain_API.createREADME());
+ }
+}
diff --git a/src/main/java/javadoc/dev_utils/readme/Dev_READMEMain_Original.java b/src/main/java/javadoc/dev_utils/readme/Dev_READMEMain_Original.java
@@ -0,0 +1,74 @@
+package javadoc.dev_utils.readme;
+
+import java.io.File;
+import java.text.MessageFormat;
+
+import dev.utils.common.FileUtils;
+import javadoc.dev_utils.ApiConfig;
+
+/**
+ * detail: 创建 README Main 方法
+ * @author Ttt
+ */
+final class Dev_READMEMain_Original {
+
+ private Dev_READMEMain_Original() {
+ }
+
+ /**
+ * 创建 README 文件
+ * @return Create Result
+ */
+ public static String createREADME() {
+ StringBuilder builder = new StringBuilder();
+ // template readme content
+ byte[] bytes = FileUtils.readFileBytes(ApiConfig.DEV_UTILS_README_ORIGINAL);
+ String templateContent = new String(bytes);
+
+ // 保存 README 内容
+ builder.append(MessageFormat.format(
+ // MessageFormat 会移除单引号, 所以需要加上双引号处理
+ templateContent.replaceAll("'", "''"),
+ ApiConfig.DEV_APP_VERSION,
+ ApiConfig.DEV_APP_VERSION,
+ ApiConfig.DEV_ASSIST_VERSION,
+ ApiConfig.DEV_BASE_VERSION,
+ ApiConfig.DEV_BASE_MVVM_VERSION,
+ ApiConfig.DEV_ENGINE_VERSION,
+ ApiConfig.DEV_HTTP_CAPTURE_VERSION,
+ ApiConfig.DEV_HTTP_CAPTURE_VERSION,
+ ApiConfig.DEV_HTTP_CAPTURE_VERSION,
+ ApiConfig.DEV_HTTP_MANAGER_VERSION,
+ ApiConfig.DEV_RETROFIT_VERSION,
+ ApiConfig.DEV_WIDGET_VERSION,
+ ApiConfig.DEV_ENVIRONMENT_VERSION,
+ ApiConfig.DEV_ENVIRONMENT_VERSION,
+ ApiConfig.DEV_ENVIRONMENT_VERSION,
+ ApiConfig.DEV_ENVIRONMENT_VERSION,
+ ApiConfig.DEV_JAVA_VERSION
+ ));
+
+ // 保存 README
+ FileUtils.saveFile(
+ new File(
+ ApiConfig.DEV_UTILS_README_FILE_SAVE_PATH,
+ ApiConfig.README_FILE_NAME_ORIGINAL
+ ).getAbsolutePath(), builder.toString().getBytes()
+ );
+
+ StringBuilder resultBuilder = new StringBuilder();
+ resultBuilder.append("\n");
+ resultBuilder.append("\n==================");
+ resultBuilder.append("\n= 保存 Readme 成功 =");
+ resultBuilder.append("\n==================");
+ resultBuilder.append("\n");
+ resultBuilder.append("\n");
+ resultBuilder.append("保存地址: " + ApiConfig.DEV_UTILS_README_FILE_SAVE_PATH + ApiConfig.README_FILE_NAME_ORIGINAL);
+ resultBuilder.append("\n");
+ return resultBuilder.toString();
+ }
+
+ public static void main(String[] args) {
+ System.out.println(Dev_READMEMain_Original.createREADME());
+ }
+}