README

A CLI tool to initialize coding standards configuration for PHP/Symfony projects. Generates ready-to-use configuration files for code quality tools, CI/CD pipelines, and development environments.

Installation

composer require enabel/coding-standard --dev

Usage

Interactive Mode

Run the init command without options for interactive configuration:

vendor/bin/coding-standard init

You'll be prompted to configure:

• Project name and PHP version
• Symfony version (if applicable)
• Database type and version (MariaDB, MySQL, PostgreSQL)
• Code quality tools (PHP-CS-Fixer, PHPStan, Rector, PHPUnit)
• CI provider (GitLab CI, GitHub Actions, Azure DevOps)
• Development environment (Symfony CLI, Docker Compose, Local PHP)

Non-Interactive Mode

Use CLI options for automated setup:

vendor/bin/coding-standard init \
    --project-name=my-project \
    --php-version=8.4 \
    --symfony=8.0 \
    --database=postgresql \
    --database-version=17 \
    --ci=gitlab \
    --no-interaction

CLI Options

Generated Files

Code Quality Tools

CI/CD Pipelines

Development Environment

Database Support

The following databases are supported with their recent versions:

When a database is configured:

• CI pipelines include a database service container
• Correct PHP extensions are installed (pdo_mysql or pdo_pgsql)
• DATABASE_URL is configured for Doctrine

Post-Installation

After running init:

1. Install Tool Dependencies

composer install -d tools/php-cs-fixer
composer install -d tools/phpstan
composer install -d tools/rector

Or use the Makefile:

make install

2. Configure Database Connection (Symfony projects)

If you configured a database, you need to set the DATABASE_URL environment variable in your .env.local file:

MariaDB:

DATABASE_URL="mysql://user:password@127.0.0.1:3306/my_database?serverVersion=11.4-MariaDB"

MySQL:

DATABASE_URL="mysql://user:password@127.0.0.1:3306/my_database?serverVersion=8.4"

PostgreSQL:

DATABASE_URL="postgresql://user:password@127.0.0.1:5432/my_database?serverVersion=17&charset=utf8"

Note: The CI pipelines are pre-configured with test database credentials. The DATABASE_URL in CI uses db as the database name because Symfony automatically appends _test suffix in test environment.

Available Make Commands

License

MIT