CI: Fix MongoDB version + Makefile and PHPStan for local/CI dev experience (#503)

HecFranco · web-flow · commit 6f5b9e773dd1 · 2026-03-10T21:40:48.000+01:00
* chore: Update MongoDB service configuration in GitHub Actions workflow

- Upgraded MongoDB image from version 4.0 to 4.4 for improved features and security.
- Enhanced health check options for the MongoDB service to ensure better reliability during CI runs.

* chore: Add PHPStan for static analysis and update composer dependencies

- Introduced PHPStan as a development dependency for static code analysis.
- Updated composer.json to include PHPStan version 2.0 in the require-dev section.
- Created phpstan.neon.dist configuration file with specified analysis parameters and paths.

* feat: Add Makefile for Docker command management

- Introduced a Makefile to streamline Docker commands for the LexikTranslationBundle.
- Added commands for starting/stopping services, building images, running tests, and managing dependencies.
- Enhanced developer experience by providing a centralized help command for available operations.

* chore: Update project configuration and dependencies

- Enhanced .gitignore to include additional directories for Composer dependencies, IDE configurations, and cache files.
- Removed deprecated .php_cs configuration file and replaced it with .php-cs-fixer.dist.php for PHP-CS-Fixer setup.
- Updated composer.json to include friendsofphp/php-cs-fixer as a development dependency and adjusted other dependencies.
- Modified Makefile to use the new PHP-CS-Fixer configuration file.
- Updated Dockerfile to use PHP 8.3 instead of 8.4 for compatibility.
- Refactored LexikTranslationBundle.php to reorder use statements for better organization.

* chore: Update PHP version and adjust dependencies in composer files

- Set PHP platform version to 8.2.0 in composer.json for compatibility.
- Updated composer.lock to reflect changes in package versions, including downgrading doctrine/instantiator to 2.0.0 and symfony packages to 7.4.x versions.
- Adjusted PHP requirements for several packages to ensure compatibility with the new PHP version.

* chore: Update MongoDB extension version in composer files

- Added ext-mongodb version 2.1.4 to composer.json and platform-overrides in composer.lock for compatibility.
- Downgraded mongodb/mongodb package version to 2.1.2 and updated related references in composer.lock.
- Adjusted rector/rector version to 2.1.4 and updated vimeo/psalm version to 6.5.* in composer.lock.

* chore: Update .gitignore and remove .php-cs-fixer.cache

- Commented out the .php-cs-fixer.cache entry in .gitignore to prevent tracking of the cache file.
- Deleted the .php-cs-fixer.cache file to clean up the project and avoid unnecessary cache tracking.

* chore: Uncomment .php-cs-fixer.cache entry in .gitignore

- Restored the .php-cs-fixer.cache entry in .gitignore to ensure the cache file is ignored during version control, preventing unnecessary tracking.

* chore: Update .gitignore for improved clarity and consistency

- Translated comments in .gitignore to English for better understanding.
- Ensured consistency in formatting and terminology across all entries.

* docs: Add development setup instructions and Makefile details

- Updated README.md to include a new section on development setup, detailing the use of the Makefile for common tasks.
- Created docs/development.md to provide comprehensive instructions for running development tooling, including cross-platform usage with Docker Compose.
- Included commands for testing, static analysis, and code style management to enhance developer experience.
diff --git a/.github/workflows/php.yml b/.github/workflows/php.yml
@@ -23,12 +23,17 @@ jobs:
           - 3306:3306
         options: --health-cmd="mysqladmin ping" --health-interval=10s --health-timeout=5s --health-retries=3
       mongo:
-        image: library/mongo:4.0
+        image: mongo:4.4
         ports:
           - 27017:27017
         env:
           MONGO_INITDB_ROOT_USERNAME: admin
           MONGO_INITDB_ROOT_PASSWORD: secret
+        options: >-
+          --health-cmd "mongo mongodb://admin:secret@localhost:27017/admin --eval 'db.adminCommand(\"ping\")'"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
 
     strategy:
       matrix:
diff --git a/.gitignore b/.gitignore
@@ -1,9 +1,20 @@
+# Composer dependencies (installed with composer install)
 vendor
-composer.lock
+
+# PhpStorm IDE configuration and cache
 .idea
 
+# Test application temporary directory
 Tests/app/tmp/
+
+# PHPUnit result cache
 .phpunit.result.cache
 
+# PHP-CS-Fixer cache
+.php-cs-fixer.cache
+
+# Generated documentation
 .docs
-.demo
+
+# Demo or demonstration environment
+.demo
diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
@@ -0,0 +1,21 @@
+<?php
+
+$finder = PhpCsFixer\Finder::create()
+    ->exclude('bin')
+    ->exclude('vendor')
+    ->in(__DIR__);
+
+return (new PhpCsFixer\Config())
+    ->setRules([
+        '@PSR12' => true,
+        'array_syntax' => ['syntax' => 'short'],
+        'binary_operator_spaces' => true,
+        'blank_line_after_opening_tag' => true,
+        'concat_space' => ['spacing' => 'one'],
+        'no_extra_blank_lines' => true,
+        'no_leading_import_slash' => true,
+        'no_trailing_comma_in_singleline' => true,
+        'no_unused_imports' => true,
+        'ordered_imports' => true,
+    ])
+    ->setFinder($finder);
diff --git a/Dockerfile b/Dockerfile
@@ -1,4 +1,4 @@
-FROM php:8.4-cli-bullseye
+FROM php:8.3-cli-bullseye
 
 ENV COMPOSER_ALLOW_SUPERUSER=1
 
diff --git a/LexikTranslationBundle.php b/LexikTranslationBundle.php
@@ -2,10 +2,10 @@
 
 namespace Lexik\Bundle\TranslationBundle;
 
-use Symfony\Component\HttpKernel\Bundle\Bundle;
-use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Lexik\Bundle\TranslationBundle\DependencyInjection\Compiler\RegisterMappingPass;
 use Lexik\Bundle\TranslationBundle\DependencyInjection\Compiler\TranslatorPass;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\HttpKernel\Bundle\Bundle;
 
 /**
  * Bundle main class.
diff --git a/Makefile b/Makefile
@@ -0,0 +1,55 @@
+.PHONY: up down build test rector cs-fix phpstan ensure-up help cache-clear install update
+
+DOCKER_RUN = docker compose run --rm lexik_translation
+
+.DEFAULT_GOAL := help
+
+help:
+	@echo "LexikTranslationBundle - Available commands:"
+	@echo ""
+	@echo "  make up           Start services in the background"
+	@echo "  make ensure-up   Start services and install dependencies (composer)"
+	@echo "  make down        Stop and remove containers"
+	@echo "  make build       Build Docker images"
+	@echo "  make test        Run test suite (PHPUnit)"
+	@echo "  make rector      Run Rector (refactoring)"
+	@echo "  make cs-fix      Apply PHP-CS-Fixer (code style)"
+	@echo "  make phpstan     Run PHPStan (static analysis)"
+	@echo "  make cache-clear Clear Composer cache"
+	@echo "  make install     Install dependencies (composer install)"
+	@echo "  make update      Update dependencies (composer update)"
+	@echo "  make help        Show this help"
+
+up:
+	docker compose up -d
+
+ensure-up:
+	docker compose up -d
+	$(DOCKER_RUN) composer install --prefer-dist --no-progress
+
+down:
+	docker compose down
+
+build:
+	docker compose build
+
+test: ensure-up
+	$(DOCKER_RUN) composer test
+
+rector: ensure-up
+	$(DOCKER_RUN) vendor/bin/rector process
+
+cs-fix: ensure-up
+	$(DOCKER_RUN) vendor/bin/php-cs-fixer fix --config=.php-cs-fixer.dist.php
+
+phpstan: ensure-up
+	$(DOCKER_RUN) vendor/bin/phpstan analyse --memory-limit=512M
+
+cache-clear: ensure-up
+	$(DOCKER_RUN) composer clear-cache
+
+install: ensure-up
+	$(DOCKER_RUN) composer install --prefer-dist --no-progress
+
+update: ensure-up
+	$(DOCKER_RUN) composer update --no-progress
diff --git a/README.md b/README.md
@@ -33,6 +33,15 @@ Here is a little screen shot of the edition page :)
 
 ![edition page screen](https://github.com/lexik/LexikTranslationBundle/raw/master/Resources/doc/screen/grid.jpg)
 
+Development
+===========
+
+The project provides a **Makefile** for common tasks (tests, static analysis, code style). See **[docs/development.md](docs/development.md)** for:
+
+* How to use the Makefile (requires [GNU Make](https://www.gnu.org/software/make/), usually pre-installed on Linux and macOS).
+* **Cross-platform**: running the same commands on Windows (without Make) using Docker Compose.
+* Cache files (e.g. `.php-cs-fixer.cache`) are listed in `.gitignore` and are not committed; you can remove them locally if needed.
+
 TESTING
 =======
 
diff --git a/composer.json b/composer.json
@@ -43,11 +43,12 @@
         "doctrine/doctrine-bundle": "^2.2",
         "doctrine/mongodb-odm": "^2.7",
         "doctrine/mongodb-odm-bundle": "^5.0",
+        "friendsofphp/php-cs-fixer": "^3.64",
         "mikey179/vfsstream": "^1.6",
         "mongodb/mongodb": "^1.21.0 || ^2.0.0",
+        "phpstan/phpstan": "^2.0",
         "phpunit/phpunit": "^9.5|^10.0",
-        "rector/jack": "^0.2.3",
-        "rector/rector": "^0.14.8|^0.15",
+        "rector/rector": "^2.0",
         "symfony/var-exporter": "^6.4|^7.0"
     },
     "autoload": {
@@ -70,6 +71,10 @@
         "test": "vendor/bin/phpunit"
     },
     "config": {
+        "platform": {
+            "php": "8.2.0",
+            "ext-mongodb": "2.1.4"
+        },
         "sort-packages": true
     }
 }
diff --git a/composer.lock b/composer.lock
diff --git a/docs/development.md b/docs/development.md
diff --git a/phpstan.neon.dist b/phpstan.neon.dist
diff --git a/rector.php b/rector.php

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-FROM php:8.4-cli-bullseye`
	`1`	`+FROM php:8.3-cli-bullseye`
`2`	`2`
`3`	`3`	`ENV COMPOSER_ALLOW_SUPERUSER=1`
`4`	`4`