# revise

**Repository Path**: foril/revise

## Basic Information

- **Project Name**: revise
- **Description**: refactoring visualization front end
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-03-30
- **Last Updated**: 2024-03-02

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 基于 AST 的 Java 重构可视化平台 

![revise](https://img.foril.fun/revise_icon64.png)

本项目是 「基于AST（抽象语法树）的 Java 代码重构可视化工具 `Revise`」。

它利用静态代码分析技术，无需编译代码，即可在 AST 级别上检测 15 种重构类型。本工具能够对 Java 代码进行重构变更的可视化展示，并已在 JUnit、Spring 等开源项目的提交历史上进行了测试。

本项目是前端部分内容，`/public` 目录下包括后端 `Spring Boot` 项目的 jar 包，可以直接使用 `jar -jar revise-web-1.0-SNAPSHOT` 运行后端 web 服务，后端项目地址为：[refactoring-vis](https://gitee.com/foril/refactoring-vis)，后端项目可以单独使用 CLI 借口使用。

## 功能特点

- 在 AST 级别上检测 15 种 Java 代码重构类型。
- 无需编译代码，直接进行静态代码分析。
- 自上而下、自下而上两种代码元素匹配方式。
- 多种相似度算法组合。
- 使用 React+Electron 技术栈，支持编译为 Windows、Linux、MacOS 的多平台原生应用。

<img alt="revise界面" src="https://img.foril.fun/revise界面.png" width=600px style="display: block; margin:10px auto"/>

<img alt="响应式界面" src="https://img.foril.fun/响应式界面.gif" width=600px style="display: block; margin:10px auto"/>


<img alt="展示 3" src="https://img.foril.fun/展示 3.gif" width=600px style="display: block; margin:10px auto"/>


<img alt="展示 2" src="https://img.foril.fun/展示 2.gif" width=600px style="display: block; margin:10px auto"/>

<img alt="展示 4" src="https://img.foril.fun/展示 4.gif" width=600px style="display: block; margin:10px auto"/>

## 开发环境设置

确保您的开发环境中已安装 Node.js 和 Yarn 包管理器。

1. 克隆仓库到本地：

```bash
git clone https://gitee.com/foril/revise.git
cd revise
```

2. 安装项目依赖：

```bash
yarn install
```

### 启动Electron应用

在本地开发启动 Electron 应用：

```bash
yarn electron
```

### 打包Electron应用

将 Electron 应用打包为当前平台下的可执行程序：

```bash
yarn package
```

### 制作安装程序

为 Electron 应用创建安装程序，支持多平台：

```bash
yarn make
```

生成的安装程序位于 `out/make` 目录下。

## 贡献

欢迎通过 Pull Requests 或 Issues 参与贡献。对于更大的变更，请先开 Issue 讨论您想要更改的内容。

## 许可证

本项目采用[MIT许可证](LICENSE)。

---

请根据您的实际项目信息（如仓库URL、项目目录名等）修改上述模板中的占位符。希望这个README模板对您的项目有所帮助！