package javadoc.dev_utils.readme; import java.io.File; import java.util.HashMap; import dev.utils.common.FileUtils; import javadoc.dev_utils.ApiConfig; import javadoc.dev_utils.assist.PackageCatalog; /** * detail: 创建 README Main 方法 * @author Ttt */ final class DevHttpCapture_READMEMain { private DevHttpCapture_READMEMain() { } /** * 创建 DevHttpCapture - README 头部前缀 * @param builder 拼接 Builder * @param path 文件路径 * @param packageName 包名 * @param mapCatalog 对应目录的注释 * @param templatePath Readme 模板路径 */ private static void createREADMEHead( final StringBuilder builder, final String path, final String packageName, final HashMap mapCatalog, final String templatePath ) { // 不增加锚链接 -> 一级目录 String catalog = PackageCatalog.apiCatalog(false, path, packageName, mapCatalog); // template readme content byte[] bytes = FileUtils.readFileBytes(templatePath); String templateContent = new String(bytes); // 保存 README 内容 builder.append(String.format( templateContent, ApiConfig.DEV_HTTP_CAPTURE_VERSION, catalog )); } /** * 创建 README 文件 * @return Create Result */ public static String createREADME() { // 包名 final String packageName = ApiConfig.DEV_HTTP_CAPTURE_PACKAGE; // 本地文件路径 final String path = ApiConfig.DEV_HTTP_CAPTURE_PATH; // Github 链接地址 final String githubUrl = ApiConfig.DEV_HTTP_CAPTURE_GITHUB_URL; // =========== // = 生成 API = // =========== // 最终的数据 StringBuilder builder = new StringBuilder(); // 添加头部信息 createREADMEHead( builder, path, packageName, ApiConfig.sCatalogMap_HttpCapture, ApiConfig.DEV_HTTP_CAPTURE_TEMPLATE ); // 保存合成后的 API README FileUtils.saveFile( new File( ApiConfig.DEV_HTTP_CAPTURE_API_FILE_SAVE_PATH, ApiConfig.README_FILE_NAME ).getAbsolutePath(), builder.toString().getBytes() ); StringBuilder resultBuilder = new StringBuilder(); resultBuilder.append("\n"); resultBuilder.append("\n==================="); resultBuilder.append("\n= 保存 JavaDoc 成功 ="); resultBuilder.append("\n==================="); resultBuilder.append("\n"); resultBuilder.append("\n"); resultBuilder.append("保存地址: " + ApiConfig.DEV_HTTP_CAPTURE_API_FILE_SAVE_PATH + ApiConfig.README_FILE_NAME); resultBuilder.append("\n"); return resultBuilder.toString(); } public static void main(String[] args) { System.out.println(DevHttpCapture_READMEMain.createREADME()); } }