https://github.com/stickeeuk/canary
Canary provides powerful linting and static analysis for Laravel projects.
https://github.com/stickeeuk/canary
laravel linting php static-analysis
Last synced: about 1 month ago
JSON representation
Canary provides powerful linting and static analysis for Laravel projects.
- Host: GitHub
- URL: https://github.com/stickeeuk/canary
- Owner: stickeeuk
- License: mit
- Created: 2022-11-07T16:30:49.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-02-27T14:08:45.000Z (4 months ago)
- Last Synced: 2025-04-08T22:14:26.230Z (2 months ago)
- Topics: laravel, linting, php, static-analysis
- Homepage: https://packagist.org/packages/stickee/canary
- Size: 273 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Introduction
**Canary** provides **linting** and **static analysis** for stickee Laravel projects.
It includes:
- the stickee [PHP CS Fixer config](https://github.com/stickeeuk/php-cs-fixer-config/) to adhere to our code styles
- the stickee [Larastan config](https://github.com/stickeeuk/larastan-config/) to analyse your code
- the stickee [Rector config](https://github.com/stickeeuk/rector-config) to refactor your code
## Installation
### Composer
```bash
composer require --dev stickee/canary
# Add scripts to composer.json
composer config --json scripts.analyse "vendor/bin/phpstan analyse -c phpstan.dist.neon"
composer config --json scripts.analyze "composer analyse"
composer config --json scripts.fix "vendor/bin/php-cs-fixer fix --config .php-cs-fixer.php"
composer config --json scripts.improve "vendor/bin/rector"
composer config --json scripts.suggest "vendor/bin/rector --dry-run"
```
### Config
```bash
cp vendor/stickee/php-cs-fixer-config/dist/.php-cs-fixer.php .
cp vendor/stickee/larastan-config/dist/phpstan.dist.neon .
cp vendor/stickee/larastan-config/dist/phpstan.ci.neon .
cp vendor/stickee/rector-config/dist/rector.php .
```
You should commit these config files.
### .gitignore
```bash
if grep -q '.php-cs-fixer.cache' .gitignore;
then
echo ".gitignore contains .php-cs-fixer.cache";
else
echo "Adding .php-cs-fixer.cache to .gitignore";
echo ".php-cs-fixer.cache" >> .gitignore;
echo "Done";
fi
```
## Usage
Canary provides a unified package that brings together powerful linting and static analysis tools that we make heavy use of at stickee.
### Tools
### `analyse`
[PHPStan](https://github.com/nunomaduro/larastan)
```bash
composer analyse
# or vendor/bin/phpstan analyse -c phpstan.dist.neon
```
This command will perform static-analysis of your whole project.
It _could_ be run as part of a `pre-commit` hook.
See [stickee/larastan-config](https://github.com/stickeeuk/larastan-config) for more details.
### `fix`
[PHP CS Fixer](https://github.com/PHP-CS-Fixer/PHP-CS-Fixer)
```bash
composer fix
# or vendor/bin/php-cs-fixer fix --config .php-cs-fixer.php
```
This command will attempt to fix minor code style issues.
It _can_ be run against a single file.
It _could_ be run against staged files as part of a `pre-commit` hook.
See [stickee/php-cs-fixer-config](https://github.com/stickeeuk/php-cs-fixer-config) for more details.
### `improve`
[Rector](https://github.com/rectorphp/rector)
```bash
composer improve
# or vendor/bin/rector
```
This command will refactor your code in an attempt to improve it.
Any `improve`d code **must** be checked before committing.
It _can_ be run against a single file.
It should **not** be run as part of a `pre-commit` hook.
See [stickee/rector-config](https://github.com/stickeeuk/rector-config) for more details.
### `suggest`
[Rector](https://github.com/rectorphp/rector) in `--dry-run` mode
```bash
composer suggest
# or vendor/bin/rector --dry-run
```
This command will suggest improvements as diffs in the terminal.
See [stickee/rector-config](https://github.com/stickeeuk/rector-config) for more details.
## Contributions
Contributions are welcome!
Improvements to any of the amalgamated open source tools should be directed towards their respective repositories.
## License
Canary is open source software licensed under the [MIT license](https://opensource.org/licenses/MIT).