Skip to content

php-fast-forward/dev-tools

Repository files navigation

FastForward\DevTools

A Composer plugin and console toolkit designed to unify and standardize development workflows. Built to provide a seamless interface for PHPUnit, PHP-CS-Fixer, Rector, EasyCodingStandard (ECS), and phpDocumentor.

✨ Features

  • Aggregates multiple development tools into a single command
  • Automates execution of tests, static analysis, and code styling
  • First-class support for automated refactoring and docblock generation
  • Integrates seamlessly as a Composer plugin without boilerplate
  • Configures default setups for QA tools out of the box

🚀 Installation

composer require --dev fast-forward/dev-tools

🛠️ Usage

Once installed, the plugin automatically exposes the dev-tools command via Composer.

# Run all standard checks (refactoring, code styling, docs, tests, and reports)
composer dev-tools

# Automatically fix code standards issues where applicable
composer dev-tools -- --fix

You can also run individual commands for specific development tasks:

# Run PHPUnit tests
composer dev-tools tests

# Check and fix code style using ECS and Composer Normalize
composer dev-tools code-style

# Refactor code using Rector
composer dev-tools refactor

# Check and fix PHPDoc comments
composer dev-tools phpdoc

# Generate HTML API documentation using phpDocumentor
composer dev-tools docs

# Generate Markdown documentation for the wiki
composer dev-tools wiki

# Generate documentation frontpage and related reports
composer dev-tools reports

📄 License

This package is licensed under the MIT License. See the LICENSE file for more details.

🔗 Links