Download the PHP package richcongress/static-analysis without Composer
On this page you can find all versions of the php package richcongress/static-analysis. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download richcongress/static-analysis
More information about richcongress/static-analysis
Files in richcongress/static-analysis
Package static-analysis
Short Description A library to setup quickly the static analysis tools for RichCongress
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package static-analysis
Static analysis
The static analysis checks if the code fits the configured. In this repository, you'll find a default configuration, and a script to easily execute the static analysis.
Installation
Execute the following command using composer: composer require richcongress/static-analysis --dev
Configuration
Files
Create symlinks in the project folder that points to the configuration files:
If you use this method in a bundle you will also want to exclude phpinsights.php from your autoloads in your composer.json:
If you want rather copying files instead of creating a symlink, juste change ln by cp:
Git Hook
To easily add a hook that execute the static analysis on pre-push, add the following code to your composer.json file:
Note that if commit outside your docker container if you use one, it will be executed outside your container.
PHP CS Fixer File Watcher
You can setup a file watcher to run php-cs-fixer automatically on file save. For PhpStorm the config configs/watcherTasks.xml can be used as an example or if you don't have other watchers in your config, directly copy it to your .idea/ folder:
Versioning
static-analysis follows semantic versioning. In short the scheme is MAJOR.MINOR.PATCH where
- MAJOR is bumped when there is a breaking change,
- MINOR is bumped when a new feature is added in a backward-compatible way,
- PATCH is bumped when a bug is fixed in a backward-compatible way.
Versions bellow 1.0.0 are considered experimental and breaking changes may occur at any time.
Contributing
Contributions are welcomed! There are many ways to contribute, and we appreciate all of them. Here are some of the major ones:
- Bug Reports: While we strive for quality software, bugs can happen and we can't fix issues we're not aware of. So please report even if you're not sure about it or just want to ask a question. If anything the issue might indicate that the documentation can still be improved!
- Feature Request: You have a use case not covered by the current api? Want to suggest a change or add something? We'd be glad to read about it and start a discussion to try to find the best possible solution.
- Pull Request: Want to contribute code or documentation? We'd love that! If you need help to get started, GitHub as documentation on pull requests. We use the "fork and pull model" were contributors push changes to their personnal fork and then create pull requests to the main repository. Please make your pull requests against the
masterbranch.
As a reminder, all contributors are expected to follow our Code of Conduct.
License
static-analysis is distributed under the terms of the MIT license.
See LICENSE for details.
All versions of static-analysis with dependencies
jschaedl/composer-git-hooks Version ^4.0
friendsofphp/php-cs-fixer Version ^2.0 || ^3.0
nunomaduro/phpinsights Version ^1.0 || ^2.0
phpmetrics/phpmetrics Version ^2.7
phpstan/phpstan Version ^1.10.0