Arcanist 项目教程

Arcanist 项目教程

1. 项目的目录结构及介绍

Arcanist 项目的目录结构如下：

arcanist/
├── bin/
├── externals/
├── src/
│   ├── arcanist/
│   ├── console/
│   ├── diffusion/
│   ├── files/
│   ├── foundation/
│   ├── future/
│   ├── git/
│   ├── hg/
│   ├── intern/
│   ├── lang/
│   ├── lint/
│   ├── mercurial/
│   ├── parser/
│   ├── repository/
│   ├── shell/
│   ├── test/
│   ├── third-party/
│   ├── tu/
│   ├── unit/
│   ├── xhpast/
│   └── xhprof/
├── support/
└── README.md

目录介绍

• bin/: 包含 Arcanist 的可执行文件。
• externals/: 包含外部依赖库。
• src/: 包含 Arcanist 的核心代码。
  • arcanist/: 包含 Arcanist 的主要功能代码。
  • console/: 包含控制台相关的代码。
  • diffusion/: 包含代码仓库相关的代码。
  • files/: 包含文件处理相关的代码。
  • foundation/: 包含基础类和工具。
  • future/: 包含异步处理相关的代码。
  • git/: 包含 Git 相关的代码。
  • hg/: 包含 Mercurial 相关的代码。
  • intern/: 包含内部工具和辅助函数。
  • lang/: 包含语言处理相关的代码。
  • lint/: 包含代码检查（Lint）相关的代码。
  • mercurial/: 包含 Mercurial 相关的代码。
  • parser/: 包含解析器相关的代码。
  • repository/: 包含仓库管理相关的代码。
  • shell/: 包含 Shell 脚本相关的代码。
  • test/: 包含测试相关的代码。
  • third-party/: 包含第三方库。
  • tu/: 包含类型检查相关的代码。
  • unit/: 包含单元测试相关的代码。
  • xhpast/: 包含 PHP 解析器相关的代码。
  • xhprof/: 包含性能分析相关的代码。
• support/: 包含支持文件和脚本。
• README.md: 项目的介绍文档。

2. 项目的启动文件介绍

Arcanist 的启动文件位于 bin/ 目录下，主要文件是 arc。这个文件是一个 PHP 脚本，用于启动 Arcanist 命令行工具。

#!/usr/bin/env php
<?php

require_once dirname(__FILE__).'/../src/bootstrap/bootstrap_shell.php';

启动文件介绍

• arc: 这是 Arcanist 的主启动文件，用户通过命令行输入 arc 命令时，会执行这个脚本。
• bootstrap_shell.php: 这是引导文件，负责加载必要的依赖和初始化环境。

3. 项目的配置文件介绍

Arcanist 的配置文件通常位于项目的根目录下，名为 .arcconfig。这个文件是一个 JSON 格式的配置文件，用于配置 Arcanist 的行为。

配置文件示例

{
  "phabricator.uri": "https://phabricator.example.com/",
  "repository.callsign": "REPO",
  "history.immutable": false,
  "load": [
    "path/to/custom/library"
  ]
}

配置文件介绍

• phabricator.uri: 指定 Phabricator 服务器的地址。
• repository.callsign: 指定仓库的标识符。
• history.immutable: 指定历史记录是否不可变。
• load: 指定需要加载的自定义库路径。

通过这些配置，可以定制 Arcanist 的行为，使其适应不同的项目需求。