Skip to content

Commit 4eda46e

Browse files
committed
Add REAME.md
1 parent b74704c commit 4eda46e

1 file changed

Lines changed: 61 additions & 0 deletions

File tree

README.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# FastForward\DevTools
2+
3+
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.
4+
5+
## ✨ Features
6+
7+
- Aggregates multiple development tools into a single command
8+
- Automates execution of tests, static analysis, and code styling
9+
- First-class support for automated refactoring and docblock generation
10+
- Integrates seamlessly as a Composer plugin without boilerplate
11+
- Configures default setups for QA tools out of the box
12+
13+
## 🚀 Installation
14+
15+
```bash
16+
composer require --dev fast-forward/dev-tools
17+
```
18+
19+
## 🛠️ Usage
20+
21+
Once installed, the plugin automatically exposes the `dev-tools` command via Composer.
22+
23+
```bash
24+
# Run all standard checks (refactoring, code styling, docs, tests, and reports)
25+
composer dev-tools
26+
27+
# Automatically fix code standards issues where applicable
28+
composer dev-tools -- --fix
29+
```
30+
31+
You can also run individual commands for specific development tasks:
32+
33+
```bash
34+
# Run PHPUnit tests
35+
composer dev-tools tests
36+
37+
# Check and fix code style using ECS and Composer Normalize
38+
composer dev-tools code-style
39+
40+
# Refactor code using Rector
41+
composer dev-tools refactor
42+
43+
# Check and fix PHPDoc comments
44+
composer dev-tools phpdoc
45+
46+
# Generate API documentation using phpDocumentor
47+
composer dev-tools docs
48+
49+
# Generate documentation frontpage and related reports
50+
composer dev-tools reports
51+
```
52+
53+
## 📄 License
54+
55+
This package is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.
56+
57+
## 🔗 Links
58+
59+
- [Repository](https://github.com/php-fast-forward/dev-tools)
60+
- [Packagist](https://packagist.org/packages/fast-forward/dev-tools)
61+
- [RFC 2119](https://datatracker.ietf.org/doc/html/rfc2119)

0 commit comments

Comments
 (0)