symplify/easy-ci
Toolkit of commands that should not be missed in you CI
Maintainers
Requires
- php: >=7.2
Requires (Dev)
None
Suggests
None
Provides
None
Conflicts
None
Replaces
None
MIT bec2c4cc5fc6b5179b056691da8142a94bf0c2ab
This package is auto-updated.
Last update: 2024-05-26 11:57:26 UTC
README
Tools that make easy to setup CI.
- Check git conflicts in CI
Install
composer require symplify/easy-ci --dev
Usage
1. Check your Code for Git Merge Conflicts
Do you use Git? Then merge conflicts is not what you want in your code ever to see:
<<<<<<< HEAD this is some content to mess with content to append ======= totally different content to merge later
How to avoid it? Add check to your CI:
vendor/bin/easy-ci check-conflicts .
The /vendor directory is excluded by default.
2. Detect Commented Code
Have you ever forgot commented code in your code?
// foreach ($matches as $match) { // $content = str_replace($match[0], $match[2], $content); // }
Clutter no more! Add check-commented-code command to your CI and don't worry about it:
vendor/bin/easy-ci check-commented-code <directory> vendor/bin/easy-ci check-commented-code packages --line-limit 5
3. Find multiple classes in single file
To make PSR-4 work properly, each class must be in its own file. This command makes it easy to spot multiple classes in single file:
vendor/bin/easy-ci find-multi-classes src
4. Update Namespace to match PSR-4 Root
Is your class in wrong namespace? Make it match your PSR-4 root:
vendor/bin/easy-ci namespace-to-psr-4 src --namespace-root "App\\"
This will update all files in your /src directory, to starts with App\\ and follow full PSR-4 path:
# file path: src/Repository/TalkRepository.php -namespace Model; +namespace App\Repository; ...
Report Issues
In case you are experiencing a bug or want to request a new feature head over to the Symplify monorepo issue tracker
Contribute
The sources of this package are contained in the Symplify monorepo. We welcome contributions for this package on symplify/symplify.