# dev-assistant

**Repository Path**: lvxiucai/dev-assistant

## Basic Information

- **Project Name**: dev-assistant
- **Description**: 开发工程中总结的一些开发常用工具
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 2
- **Created**: 2022-08-16
- **Last Updated**: 2022-08-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 开发助手

![输入图片说明](doc/img/develop-helper.png)

## yaml验证比较工具。

### 工具产生背景
nacos yaml问题需求：

- 各个环境配置信息不好比对，eg：经常上新的环境的时候，缺少配置项, 测试人员经常部署新环境的时候发现缺少配置项；
- yaml格式开发人员自己写的不对，比如该用空格，结果使用了TAB；
- 环境不同，应该配置不同的内容却配置成了相同，比如ip地址之类的；
- 现在开发团队推荐我们每个开发人员都有自己的Nacos，当其他开发人员在中心配置nacos改变配置后，我们需要将变更同步到自己的NACOS中
- 最新的一个版本配置可能有问题，两个配置文件想看配置有啥不一样；
- 其他yaml问题。

由于上面这些内容，加上Beyond Compare、winMerge不能完全满足我的比较需求，所以我开始开发一个工具来帮我解决这些问题。

### 现有功能

- yaml配置项管理

  - 支持本地YAML配置。

  - 支持远程Nacos配置。

- yaml配置格式验证

  - 对单个配置项的格式验证。

- 各yaml配置项交叉比较

  - 按key重排序，防止配置文件中不同环境配置放的位置不同，排序后也更有条理。
  - 不区分本地或远程nacos配置项，可以交叉比较。
  - 上一处不同。
  - 下一处不同。
  - K模式和KV模式切换
    - K模式，只比较YAML格式的键的增减情况。
    - KV模式，在K模式基础上，比较相同键对应的值的变化情况。

### 使用说明

1. 管理配置
![输入图片说明](https://images.gitee.com/uploads/images/2021/0918/090012_338b5c86_1927131.png "configManage.png")

2. 点击”格式验证“，可以对我们的配置文件格式进行校验。
     比如下方验证提示格式的界面，在消息中能看多少行存在什么样的格式问题。

![输入图片说明](https://images.gitee.com/uploads/images/2021/0918/090032_146e0e2e_1927131.png "formatVerify.png")

3. 选择相应配置，然后进行比较。

![输入图片说明](https://images.gitee.com/uploads/images/2021/0918/090044_434d7a34_1927131.png "compare.png")

## 安装教程

1.  release目录中有YamlVerifyCompare-2.4.5可以直接运行，需要JDK8，运行boot.bat即可启动。

## 期待功能

- 按分组一键验证配置；
- 基于界面配置同步配置信息；
  - 支持从某个本地目录同步配置项到配置管理中；
  - 支持从某个nacos同步配置项到配置管理中；
- 按分组一键删除
- 支持其他配置管理平台匹对；
- 表单验证

## 参与贡献

1.  Fork 本仓库
2.  新建 Feat_xxx 分支
3.  提交代码
4.  新建 Pull Request