Skip to content

Commit

Permalink
docs: 更新部分版本信息、忽略配置
Browse files Browse the repository at this point in the history
  • Loading branch information
afkT committed May 15, 2024
1 parent 1314d7d commit 7534f3c
Show file tree
Hide file tree
Showing 7 changed files with 167 additions and 26 deletions.
3 changes: 3 additions & 0 deletions file/task_generate_version_file.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,9 @@ tasks.register('generateVersionsGradle') {
// DevMVVM - DataBinding 工具类库
content = formatVersion(content, "DevMVVM", versions.dev_mvvm_versionCode)

// DevSimple - DataBinding 工具类库
content = formatVersion(content, "DevSimple", versions.dev_simple_versionCode)

// DevEngine - 第三方框架解耦、一键替换第三方库、同类库多 Engine 组件化混合使用
content = formatVersion(content, "DevEngine", versions.dev_engine_versionCode)

Expand Down
8 changes: 6 additions & 2 deletions file/versions.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ ext {
// ===========

// DevApp - Android 工具类库
dev_app_versionCode : 245,
dev_app_versionName : "2.4.5",
dev_app_versionCode : 246,
dev_app_versionName : "2.4.6",

// DevAssist - 封装逻辑代码, 实现多个快捷功能辅助类、以及 Engine 兼容框架等
dev_assist_versionCode : 141,
Expand All @@ -25,6 +25,10 @@ ext {
dev_mvvm_versionCode : 103,
dev_mvvm_versionName : "1.0.3",

// DevSimple - 简单敏捷开发库
dev_simple_versionCode : 100,
dev_simple_versionName : "1.0.0",

// DevEngine - 第三方框架解耦、一键替换第三方库、同类库多 Engine 组件化混合使用
dev_engine_versionCode : 113,
dev_engine_versionName : "1.1.3",
Expand Down
4 changes: 4 additions & 0 deletions file/versions_template.txt
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@ ext {
dev_mvvm_versionCode : 【DevMVVM】,
dev_mvvm_versionName : "【DevMVVM-vn】",

// DevSimple - 简单敏捷开发库
dev_simple_versionCode : 【DevSimple】,
dev_simple_versionName : "【DevSimple-vn】",

// DevEngine - 第三方框架解耦、一键替换第三方库、同类库多 Engine 组件化混合使用
dev_engine_versionCode : 【DevEngine】,
dev_engine_versionName : "【DevEngine-vn】",
Expand Down
134 changes: 134 additions & 0 deletions src/main/java/javadoc/dev_utils/ApiConfig.java
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
package javadoc.dev_utils;

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

/**
* detail: 配置信息
Expand Down Expand Up @@ -128,6 +130,24 @@ private ApiConfig() {
// DevBaseMVVM Template Readme
public static final String DEV_BASE_MVVM_TEMPLATE = JAVADOC_TEMPLATE_PACKAGE_PATH + "/DevBaseMVVM_README.md";

// ===========
// = DevMVVM =
// ===========

// DevMVVM 版本号
public static final String DEV_MVVM_VERSION = DevVersion.DEV_MVVM_VERSION;
// 包目录名
public static final String DEV_MVVM_PACKAGE = "dev.mvvm";

// =============
// = DevSimple =
// =============

// DevSimple 版本号
public static final String DEV_SIMPLE_VERSION = DevVersion.DEV_SIMPLE_VERSION;
// 包目录名
public static final String DEV_SIMPLE_PACKAGE = "dev.simple";

// =============
// = DevEngine =
// =============
Expand Down Expand Up @@ -423,6 +443,8 @@ private static void initCatalogMap() {
sCatalogMap_APP.put(".app.assist.exif", "图片 EXIF 读写辅助类");
sCatalogMap_APP.put(".app.assist.floating", "悬浮窗实现方案辅助类");
sCatalogMap_APP.put(".app.assist.lifecycle", "Activity 生命周期监听辅助类");
sCatalogMap_APP.put(".app.assist.lifecycle.current", "当前 Activity、Fragment 生命周期辅助类");
sCatalogMap_APP.put(".app.assist.lifecycle.fragment", "Fragment 生命周期辅助类");
sCatalogMap_APP.put(".app.assist.record", "文件记录分析类");
sCatalogMap_APP.put(".app.assist.url", "Url 携带信息解析");

Expand Down Expand Up @@ -829,4 +851,116 @@ private static void initMethodNameRegex() {
// // 属于 xxx2x xx数字
// sMethodNameRegex = "[A-Za-z]+[2][A-Za-z][A-Za-z0-9]+";
}

// ============
// = 版本格式化 =
// ============

// 所有库名
private static final List<String> sAllLibName = Arrays.asList(
// DevApp - Android 工具类库
"DevApp",
// DevAssist - 封装逻辑代码, 实现多个快捷功能辅助类、以及 Engine 兼容框架等
"DevAssist",
// DevBase - Base ( Activity、Fragment )、MVP、ViewBinding、ContentLayout 基类库
"DevBase",
// DevBaseMVVM - MVVM ( ViewDataBinding + ViewModel ) 基类库
"DevBaseMVVM",
// DevMVVM - DataBinding 工具类库
"DevMVVM",
// DevSimple - DataBinding 工具类库
"DevSimple",
// DevEngine - 第三方框架解耦、一键替换第三方库、同类库多 Engine 组件化混合使用
"DevEngine",
// DevHttpCapture - OkHttp 抓包工具库
"DevHttpCapture",
// DevHttpManager - OkHttp 管理库 ( Retrofit 多 BaseUrl 管理、Progress 监听 )
"DevHttpManager",
// DevRetrofit - Retrofit + Kotlin Coroutines 封装
"DevRetrofit",
// DevWidget - 自定义 View UI 库
"DevWidget",
// DevEnvironment - Android 环境配置切换库
"DevEnvironment",
// DevJava - Java 工具类库 ( 不依赖 android api )
"DevJava"
);

/**
* 格式化全部版本处理
* @param content 待格式化内容
* @return 格式化后内容
*/
public static String formatAllVersion(final String content) {
String result = content;
for (String value : sAllLibName) {
result = formatVersion(result, value);
}
return result;
}

/**
* 格式化版本处理
* @param content 待格式化内容
* @param tag 库名 Tag
* @return 格式化后内容
*/
private static String formatVersion(
final String content,
final String tag
) {
String vn = "【" + tag + "-vn】";
String versionName = returnVersionName(tag);
return content.replaceAll(vn, versionName);
}

/**
* 返回库名对应库版本
* @param tag 库名 Tag
* @return 库名对应库版本
*/
private static String returnVersionName(final String tag) {
switch (tag) {
// DevApp - Android 工具类库
case "DevApp":
return ApiConfig.DEV_APP_VERSION;
// DevAssist - 封装逻辑代码, 实现多个快捷功能辅助类、以及 Engine 兼容框架等
case "DevAssist":
return ApiConfig.DEV_ASSIST_VERSION;
// DevBase - Base ( Activity、Fragment )、MVP、ViewBinding、ContentLayout 基类库
case "DevBase":
return ApiConfig.DEV_BASE_VERSION;
// DevBaseMVVM - MVVM ( ViewDataBinding + ViewModel ) 基类库
case "DevBaseMVVM":
return ApiConfig.DEV_BASE_MVVM_VERSION;
// DevMVVM - DataBinding 工具类库
case "DevMVVM":
return ApiConfig.DEV_MVVM_VERSION;
// DevSimple - DataBinding 工具类库
case "DevSimple":
return ApiConfig.DEV_SIMPLE_VERSION;
// DevEngine - 第三方框架解耦、一键替换第三方库、同类库多 Engine 组件化混合使用
case "DevEngine":
return ApiConfig.DEV_ENGINE_VERSION;
// DevHttpCapture - OkHttp 抓包工具库
case "DevHttpCapture":
return ApiConfig.DEV_HTTP_CAPTURE_VERSION;
// DevHttpManager - OkHttp 管理库 ( Retrofit 多 BaseUrl 管理、Progress 监听 )
case "DevHttpManager":
return ApiConfig.DEV_HTTP_MANAGER_VERSION;
// DevRetrofit - Retrofit + Kotlin Coroutines 封装
case "DevRetrofit":
return ApiConfig.DEV_RETROFIT_VERSION;
// DevWidget - 自定义 View UI 库
case "DevWidget":
return ApiConfig.DEV_WIDGET_VERSION;
// DevEnvironment - Android 环境配置切换库
case "DevEnvironment":
return ApiConfig.DEV_ENVIRONMENT_VERSION;
// DevJava - Java 工具类库 ( 不依赖 android api )
case "DevJava":
return ApiConfig.DEV_JAVA_VERSION;
}
return null;
}
}
12 changes: 12 additions & 0 deletions src/main/java/javadoc/dev_utils/DevVersion.java
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,10 @@ private DevVersion() {
static final String DEV_BASE_VERSION;
// DevBaseMVVM 版本号
static final String DEV_BASE_MVVM_VERSION;
// DevMVVM 版本号
static final String DEV_MVVM_VERSION;
// DevSimple 版本号
static final String DEV_SIMPLE_VERSION;
// DevEngine 版本号
static final String DEV_ENGINE_VERSION;
// DevHttpCapture 版本号
Expand Down Expand Up @@ -81,6 +85,14 @@ private DevVersion() {
DEV_BASE_MVVM_VERSION = getProperty(
prop, "dev_base_mvvm_versionName"
);
// DevMVVM 版本号
DEV_MVVM_VERSION = getProperty(
prop, "dev_mvvm_versionName"
);
// DevSimple 版本号
DEV_SIMPLE_VERSION = getProperty(
prop, "dev_simple_versionName"
);
// DevEngine 版本号
DEV_ENGINE_VERSION = getProperty(
prop, "dev_engine_versionName"
Expand Down
24 changes: 2 additions & 22 deletions src/main/java/javadoc/dev_utils/readme/Dev_READMEMain.java
Original file line number Diff line number Diff line change
Expand Up @@ -25,28 +25,8 @@ public static String createREADME() {
byte[] bytes = FileUtils.readFileBytes(ApiConfig.DEV_UTILS_README);
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 全部版本内容
builder.append(ApiConfig.formatAllVersion(templateContent));

// 保存 README
FileUtils.saveFile(
Expand Down
8 changes: 6 additions & 2 deletions versions.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ ext {
// ===========

// DevApp - Android 工具类库
dev_app_versionCode : 245,
dev_app_versionName : "2.4.5",
dev_app_versionCode : 246,
dev_app_versionName : "2.4.6",

// DevAssist - 封装逻辑代码, 实现多个快捷功能辅助类、以及 Engine 兼容框架等
dev_assist_versionCode : 141,
Expand All @@ -25,6 +25,10 @@ ext {
dev_mvvm_versionCode : 103,
dev_mvvm_versionName : "1.0.3",

// DevSimple - 简单敏捷开发库
dev_simple_versionCode : 100,
dev_simple_versionName : "1.0.0",

// DevEngine - 第三方框架解耦、一键替换第三方库、同类库多 Engine 组件化混合使用
dev_engine_versionCode : 113,
dev_engine_versionName : "1.1.3",
Expand Down

0 comments on commit 7534f3c

Please sign in to comment.