Webdiff 项目使用教程

1. 项目目录结构及介绍

Webdiff 是一个基于 Web 的两列式 Git 差分工具，它允许用户在任何支持 Web 浏览器的平台上查看 Git 差分。以下是项目的目录结构及其简单介绍：

• /.circleci/: 包含持续集成配置文件。
• /.github/: 包含 GitHub 工作流和模板。
• /images/: 存放项目相关的图片文件。
• /testdata/: 包含测试数据。
• /tests/: 包含单元测试代码。
• /ts/: 包含 TypeScript 源代码。
• /.gitignore: 指定 Git 忽略的文件。
• /CHANGELOG: 记录项目历史更新和变更。
• /LICENSE: 项目使用的 Apache-2.0 许可证文件。
• /README.md: 项目说明文件。
• /poetry.lock: 包含项目依赖的锁定文件。
• /pyproject.toml: 包含项目 Python 依赖的配置文件。
• /test-gitwebdiff.sh: 用于测试 git webdiff 命令的脚本文件。
• /test.sh: 用于测试项目的脚本文件。

2. 项目的启动文件介绍

webdiff 的启动主要是通过 Python 脚本 app.py 来实现的。以下是启动项目的基本步骤：

1. 安装项目依赖：poetry install
2. 进入 TypeScript 目录：cd ts
3. 安装 TypeScript 依赖：yarn
4. 在根目录下运行启动脚本：poetry run webdiff/app.py testdata/dygraphsjs/{left,right}

如果需要以调试模式启动，可以使用以下命令：

./test.sh $(pwd)/testdata/manyfiles/{left,right}

3. 项目的配置文件介绍

webdiff 的配置主要通过 Git 配置命令 git config 来实现。以下是一些可配置的选项：

• webdiff.theme: 设置语法高亮主题。
• webdiff.port: 设置服务端口。
• webdiff.host: 设置服务主机名。
• webdiff.maxDiffWidth: 设置差分显示的最大行长度。
• webdiff.unified: 设置默认显示的上下文行数。
• webdiff.extraDirDiffArgs: 设置目录差分的额外参数。
• webdiff.extraFileDiffArgs: 设置文件差分的额外参数。
• webdiff.openBrowser: 设置是否在启动时自动打开浏览器。
• webdiff.maxLinesForSyntax: 设置语法高亮的最大行数。

配置示例如下：

git config webdiff.theme rainbow
git config webdiff.port 8000

确保根据实际需求调整配置，以获得最佳的使用体验。