# EasyWork

**Repository Path**: xysghub-home-developer/easy-work

## Basic Information

- **Project Name**: EasyWork
- **Description**: EasyWork 是一个轻量级的自动化文档整理工具，用于：
- 自动读取并整理目标文件夹的文档结构
- 梳理代码项目架构，定位核心代码位置
- 导出树形结构的 markdown 文件（文件目录.md）
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2026-04-08
- **Last Updated**: 2026-04-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<!--
 * @Author: Chen_陈工
 * @Date: 2026-04-08 17:43:56
 * @LastEditors: Do not edit
 * @LastEditTime: 2026-04-08 17:46:12
 * @FilePath: \easy-work\README.md
-->
# EasyWork

#### 介绍
EasyWork 是一个轻量级的自动化文档整理工具，用于：
- 自动读取并整理目标文件夹的文档结构
- 梳理代码项目架构，定位核心代码位置
- 导出树形结构的 markdown 文件（文件目录.md）

#### 软件架构
本项目采用三语言架构：

| 语言 | 角色 | 用途 |
|------|------|------|
| **JavaScript** | 主 | 主入口、调度协调、Markdown生成、打包exe |
| **Go** | 辅 | 高性能并发文件扫描 |
| **Python 3** | 辅 | 深度代码分析（AST解析、复杂度计算） |

架构流程：`JS调度 → Go扫描 → Python分析 → JS生成Markdown`

JS 主程序有备用机制：Go/Python 不可用时自动切换到 JS 内置实现。

#### 安装教程

1.  安装 Node.js（v16+）
2.  安装 Bun：`npm install -g bun`（用于打包 exe）
3.  克隆项目：`git clone https://gitee.com/xysghub-home-developer/easy-work.git`
4.  安装依赖：`npm install`

#### 使用说明

1.  运行工具：`npm start`
2.  扫描指定目录：`npm start <path>`
3.  打包为 exe：`npm run build`

#### 项目结构

```
src/              → JavaScript 主程序（入口、调度、生成）
go/scanner/       → Go 高性能扫描模块
python/analyzer/  → Python AST 代码分析模块
bin/              → 编译后的二进制文件
dist/             → 最终打包输出
```

#### 参与贡献

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

#### 许可证

本项目采用 Apache 许可证，详见 [LICENSE](LICENSE) 文件。