terminal42 / contao-build-tools
Highly opinionated build tool setup for Contao websites.
Fund package maintenance!
terminal42
Other
Installs: 7 795
Dependents: 50
Suggesters: 0
Security: 0
Stars: 3
Watchers: 3
Forks: 0
Open Issues: 0
Type:composer-plugin
Requires
- composer-plugin-api: ^2.0
- composer/semver: ^3.0
- symfony/filesystem: ^3 || ^4 || ^5 || ^6 || ^7
- symfony/process: ^4.2 || ^5 || ^6 || ^7
Requires (Dev)
- composer/composer: ^1.1 || ^2.0
- deployer/deployer: ^7.0 || ^8.0
Conflicts
- deployer/deployer: < 7.0 || >= 9.0
This package is auto-updated.
Last update: 2024-12-19 09:11:32 UTC
README
This is an experimental repository to ease configuration of Contao bundles and websites.
DO NOT USE IN PRODUCTION
Summary
This repo contains some highly opinionated configurations for our extensions and websites.
The CQ and CS tools currently assume that your bundle or application is set up according to
Symfony Best Practice for applications or bundles, meaning there is an src/
directory where all your application or bundle code lives in, but none of the configuration.
Code Quality and Code Style
This package automatically configures the root project for code quality and code style tools.
Whenever you run composer install
or composer update
on the project, it will also update
the build tools automatically. The following tools are currently available and can be executed
through the composer run
command:
Code Style Fixer
The cs-fixer
script will fix the coding style in the src/
directory according to the
latest Contao coding standards. Create an ecs.php
script in your project
to extend the default configuration.
You can extend the default configuration by adding a ecs.php
file to your project root.
Rector
The rector
script will automatically upgrade the code to match the latest Contao standards.
You can extend the default configuration by adding a rector.php
file to your project root.
PHPStan
The phpstan
script will check your code with PHPStan.
You can extend the default configuration by adding a phpstan.neon
file to your project root.
Stylelint
The stylelint
script will check your CSS formatting with Stylelint.
You can extend the default configuration by adding a .stylelintrc
file to your project root.
Ideas
Ideas for additional tools that could be integrated:
- maglnet/composer-require-checker
- https://github.com/VincentLanglet/Twig-CS-Fixer
Continuous Integration
To make sure your code is always up-to-date, you might want
to run all build tools at once but only verify and not fix files.
Run composer run build-tools
to do this.
Example GitHub Action
# /.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'
Deploying Contao websites
We use Deployer do deploy Contao website to live servers.
To use the Deployer helper, you first need to require Deployer in your composer.json
{ "require-dev": { "terminal42/contao-build-tools": "dev-main", "deployer/deployer": "^7.0" } }
Example 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() ;