Arkitect 项目使用教程

Arkitect 项目使用教程

arkitectPut your architectural rules under test!项目地址:https://gitcode.com/gh_mirrors/ar/arkitect

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

Arkitect 项目的目录结构如下：

arkitect/
├── src/
│   ├── Console/
│   ├── Rules/
│   ├── Utils/
│   └── ...
├── tests/
│   ├── Console/
│   ├── Rules/
│   ├── Utils/
│   └── ...
├── .gitignore
├── composer.json
├── LICENSE
├── README.md
└── ...

目录结构介绍

• src/：包含项目的核心源代码，分为多个子目录，如 Console、Rules 和 Utils 等。
• tests/：包含项目的测试代码，结构与 src/ 目录相对应，确保每个功能都有相应的测试。
• .gitignore：指定 Git 版本控制系统中需要忽略的文件和目录。
• composer.json：Composer 依赖管理文件，定义了项目的依赖关系和其他配置。
• LICENSE：项目的开源许可证文件。
• README.md：项目的介绍文档，通常包含项目的基本信息、安装和使用说明。

2. 项目的启动文件介绍

Arkitect 项目的启动文件位于 src/Console/Application.php。该文件定义了命令行应用程序的入口点，并注册了所有可用的命令。

namespace Arkitect\Console;

use Symfony\Component\Console\Application as BaseApplication;

class Application extends BaseApplication
{
    public function __construct()
    {
        parent::__construct('Arkitect', '1.0.0');

        // 注册命令
        $this->add(new CheckCommand());
        // 其他命令...
    }
}

启动文件介绍

• Application 类继承自 Symfony 的 BaseApplication 类，用于创建和管理命令行应用程序。
• 在构造函数中，通过 add 方法注册了所有可用的命令，例如 CheckCommand。

3. 项目的配置文件介绍

Arkitect 项目的主要配置文件是 composer.json，它定义了项目的依赖关系、脚本和其他配置。

{
    "name": "phparkitect/arkitect",
    "description": "Put your architectural rules under test",
    "type": "library",
    "license": "MIT",
    "require": {
        "php": "^7.4 || ^8.0",
        "symfony/console": "^5.2",
        "nikic/php-parser": "^4.10"
    },
    "require-dev": {
        "phpunit/phpunit": "^9.5"
    },
    "autoload": {
        "psr-4": {
            "Arkitect\\": "src/"
        }
    },
    "autoload-dev": {
        "psr-4": {
            "Arkitect\\Tests\\": "tests/"
        }
    },
    "scripts": {
        "check": "vendor/bin/phparkitect check"
    }
}

配置文件介绍

• name：项目的名称。
• description：项目的简短描述。
• type：项目的类型，这里是 library。
• license：项目的开源许可证，这里是 MIT。
• require：定义了项目运行所需的依赖包。
• require-dev：定义了开发环境所需的依赖包。
• autoload 和 autoload-dev：定义了自动加载的规则，使用 PSR-4 标准。
• scripts：定义了可执行的脚本命令，例如 check 命令。

通过以上介绍，您可以更好地理解和使用 Arkitect 项目。希望这份教程对您有所帮助！

arkitectPut your architectural rules under test!项目地址:https://gitcode.com/gh_mirrors/ar/arkitect