Download the PHP package bound1ess/adviser without Composer
On this page you can find all versions of the php package bound1ess/adviser. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download bound1ess/adviser
More information about bound1ess/adviser
Files in bound1ess/adviser
Package adviser
Short Description A CLI application that checks your project for various possible improvements.
License MIT
Homepage https://github.com/bound1ess/adviser
Informations about the package adviser
Adviser
Adviser is a CLI application that checks your PHP project for various possible improvements.
Heavily inspired by phppackagechecklist.com.
Motivation
- Do I have some sort of a license file?
- Is my composer.json valid?
- Is my code PSR-2 compatible?
- Are the repository tags and settings OK?
I often ask myself such questions. And I got tired of checking it all manually every time. Here comes Adviser to make things a lot easier.
Navigation
- Installing
- Using
- Configuring
- Extending
- Contributing
- Additional information
Installing
Composer way
Just run in your terminal (you should be in your project's root directory):
Or, if you don't have Composer installed globally:
Now you should be able to run vendor/bin/adviser
and see Adviser's CLI.
Building a PHAR (Box is required)
This is not very difficult to do either, just run:
Now you can use builds/adviser.phar
, or (only if you want to!) you can also do this:
Now you can use adviser
(everywhere!) instead of builds/adviser.phar
.
Using
analyse
This command will analyse (suggest possible improvements) the current working directory.
analyse --formatter="formattername"
Same, but the output will be formatted depending on the formatter you choose.
Available formatters:
plaintext
(Adviser\Output\Formatters\PlainTextFormatter
).
analyse-repository name [--formatter="..."]
The name
argument here is a Github repository name (e.g. bound1ess/adviser
).
This command will make a local clone of it, run the analyse
command, then remove it (directory).
Configuring
Adviser can be configured via an adviser.yml
file placed in the working directory.
Adding a Formatter
Adding a Validator
Configuring a Validator
ChangelogValidator
CIValidator
ComposerValidator
ContributingValidator
FrameworkValidator
LicenseValidator
ReadmeValidator
TestValidator
Extending
- Write the code.
- Don't forget to test it!
- Add it to the
adviser.yml
configuration file (see Configuring section). - Done! Share your work with others if you want to.
Creating a Validator
Creating a Formatter
Contributing
- Fork the project and create a local clone of it.
- Install the dependencies:
composer update
orcomposer install --dev
. - Make a fix.
- Run the tests:
make tests
.
- Build the coverage report:
Now open localhost:8000
in your browser.
- Commit and pull!
Extra: building the documentation (ApiGen is required)
Additional information
License and support information, as well as my thanks to everyone who made Adviser possible.
License
This project is licensed under the MIT license.
Support
Stuck? Found a bug? Feel free to create a new issue here on Github, or find me on Twitter.
Thanks!
To the creators of PHPUnit, Symfony, Guzzle, Mockery and Box projects.
All versions of adviser with dependencies
symfony/console Version 2.6.*
symfony/yaml Version 2.6.*
guzzlehttp/guzzle Version 5.*