DevOther_READMEMain.java

package javadoc.dev_utils.readme;

import java.io.File;
import java.util.HashMap;
import java.util.List;

import dev.utils.common.FileUtils;
import javadoc.dev_utils.ApiConfig;
import javadoc.dev_utils.assist.APIGenerate;
import javadoc.dev_utils.assist.PackageCatalog;

/**
 * detail: 创建 README Main 方法
 * @author Ttt
 */
final class DevOther_READMEMain {

    private DevOther_READMEMain() {
    }

    /**
     * 创建 DevOther - 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<String, String> mapCatalog,
            final String templatePath
    ) {
        // 不增加锚链接 -> 一级目录
        String catalog = PackageCatalog.apiCatalog(false, path, packageName, mapCatalog);
        // 增加锚链接 -> 二级目录
        String apiCatalog = PackageCatalog.apiCatalog(true, path, packageName, mapCatalog);

        // template readme content
        byte[] bytes           = FileUtils.readFileBytes(templatePath);
        String templateContent = new String(bytes);

        // 保存 README 内容
        builder.append(String.format(
                templateContent, catalog, apiCatalog
        ));
    }

    /**
     * 创建 README 文件
     * @return Create Result
     */
    public static String createREADME() {
        // 包名
        final String packageName = ApiConfig.DEV_OTHER_PACKAGE;
        // 本地文件路径
        final String path = ApiConfig.DEV_OTHER_PATH;
        // Github 链接地址
        final String githubUrl = ApiConfig.DEV_OTHER_GITHUB_URL;

        // 方法名匹配存储 Map<类名, List<方法名>>
        final HashMap<String, List<String>> methodNameMatchesMap = new HashMap<>();
        // 方法名重复记录存储
        final StringBuilder methodRepeatBuilder = new StringBuilder();
        // 方法没有注释记录存储
        final StringBuilder methodNotAnnotateBuilder = new StringBuilder();
        // 类不存在方法记录存储
        final StringBuilder notMethodBuilder = new StringBuilder();

        // ===========
        // = 生成 API =
        // ===========

        // 最终的数据
        StringBuilder builder = new StringBuilder();
        // 添加头部信息
        createREADMEHead(
                builder, path, packageName, ApiConfig.sCatalogMap_Other,
                ApiConfig.DEV_OTHER_TEMPLATE
        );

        // 生成 API 目录
        String otherAPI = APIGenerate.apiGenerate(
                "", path, packageName, githubUrl,
                ApiConfig.sFilterClassSet_Other,
                ApiConfig.sFilterMethodMap_Other,
                ApiConfig.sMethodNameRegex,
                methodNameMatchesMap, methodRepeatBuilder,
                methodNotAnnotateBuilder, notMethodBuilder
        );

        builder.append(otherAPI);

        // 解决 API 文档 Markdown 部分语法问题
        String apiContent = builder.toString().replaceAll(
                "-            ", "- src.main   "
        );

        // 保存合成后的 API README
        FileUtils.saveFile(
                new File(
                        ApiConfig.DEV_OTHER_API_FILE_SAVE_PATH,
                        ApiConfig.README_FILE_NAME
                ).getAbsolutePath(), apiContent.getBytes()
        );

//        // 方法名重复记录存储
//        Utils.saveFile(ApiConfig.DEV_OTHER_API_FILE_SAVE_PATH, "readme_method_repeat_api.md", methodRepeatBuilder.toString());
//        // 方法没有注释记录存储
//        Utils.saveFile(ApiConfig.DEV_OTHER_API_FILE_SAVE_PATH, "readme_method_not_annotate_api.md", methodNotAnnotateBuilder.toString());
//        // 类不存在方法记录存储
//        Utils.saveFile(ApiConfig.DEV_OTHER_API_FILE_SAVE_PATH, "readme_not_method_api.md", notMethodBuilder.toString());

        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_OTHER_API_FILE_SAVE_PATH + ApiConfig.README_FILE_NAME);
        resultBuilder.append("\n");
        return resultBuilder.toString();
    }

    public static void main(String[] args) {
        System.out.println(DevOther_READMEMain.createREADME());
    }
}