README

这是一个实验性仓库，用于简化Contao捆绑包和网站的配置。

请勿在生产环境中使用

摘要

此仓库包含一些针对我们的扩展和网站的高度定制的配置。CQ和CS工具目前假设您的捆绑包或应用程序已根据Symfony最佳实践应用程序或捆绑包设置，这意味着有一个src/目录，其中包含所有应用程序或捆绑包代码，但没有配置。

代码质量和代码风格

此包会自动配置根项目以使用代码质量和代码风格工具。每次在项目中运行composer install或composer update时，它也会自动更新构建工具。以下工具目前可用，可以通过composer run命令执行

代码风格修复器

cs-fixer脚本将根据最新的Contao编码标准修复src/目录中的编码风格。在您的项目中创建一个ecs.php脚本以扩展默认配置。

您可以通过在项目根目录中添加一个ecs.php文件来扩展默认配置。

Rector

rector脚本将自动将代码升级到最新的Contao标准。

您可以通过在项目根目录中添加一个rector.php文件来扩展默认配置。

PHPStan

phpstan脚本将使用PHPStan检查您的代码。

您可以通过在项目根目录中添加一个phpstan.neon文件来扩展默认配置。

Stylelint

stylelint脚本将使用Stylelint检查您的CSS格式。

您可以通过在项目根目录中添加一个.stylelintrc文件来扩展默认配置。

想法

关于可集成额外工具的想法

maglnet/composer-require-checker
https://github.com/VincentLanglet/Twig-CS-Fixer

持续集成

为了确保您的代码始终是最新的，您可能需要一次性运行所有构建工具，但只验证文件而不修复。运行composer run build-tools来完成此操作。

GitHub行动示例

# /.github/workflows/ci.yml
name: CI

on:
    push: ~
    pull_request: ~

permissions: read-all

jobs:
    ci:
        uses: 'terminal42/contao-build-tools/.github/workflows/build-tools.yml@main'

部署Contao网站

我们使用Deployer将Contao网站部署到生产服务器。

要使用Deployer辅助工具，您首先需要在您的composer.json中包含Deployer

{
    "require-dev": {
        "terminal42/contao-build-tools": "dev-main",
        "deployer/deployer": "^7.0"
    }
}

示例deploy.php

<?php

require_once 'vendor/terminal42/contao-build-tools/src/Deployer.php';

use Terminal42\ContaoBuildTools\Deployer;

(new Deployer('example.org', 'ssh-user', '/path/to/php'))
    ->addTarget('prod', '/path/to/deployment', 'https://example.org')
    ->buildAssets()
    ->includeSystemModules()
    ->addUploadPaths(
        // some additional directory
    )
    ->run()
;

terminal42 / contao-build-tools

维护者

详细信息