https://github.com/mreduar/laravel-phpcs

PHP Codesniffer ruleset to follow Laravel's coding style
https://github.com/mreduar/laravel-phpcs

hacktoberfest laravel laravel-framework laravel-package phpcs phpcs-laravel phpcs-phpcbf phpcs-standard

Last synced: 1 day ago
JSON representation

PHP Codesniffer ruleset to follow Laravel's coding style

• Host: GitHub
• URL: https://github.com/mreduar/laravel-phpcs
• Owner: mreduar
• License: mit
• Created: 2022-01-25T17:37:37.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2022-11-02T20:02:16.000Z (almost 2 years ago)
• Last Synced: 2024-09-18T08:24:54.095Z (15 days ago)
• Topics: hacktoberfest, laravel, laravel-framework, laravel-package, phpcs, phpcs-laravel, phpcs-phpcbf, phpcs-standard
• Language: Shell
• Homepage:
• Size: 43.9 KB
• Stars: 39
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# PHP Codesniffer ruleset to follow Laravel's coding style

[![MIT Licensed](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.md)

[![PR friendly repository](https://img.shields.io/badge/Pull--Request-are%20welcome!-ff69b4)](/compare)

[php codesniffer](https://github.com/squizlabs/PHP_CodeSniffer/wiki/Annotated-Ruleset) ruleset for laravel or any other php projects.

## Installation

**[*]** Install using composer

```bash

composer require mreduar/laravel-phpcs --dev

```

**[*]** Install manually

1. Copy the `phpcs.xml` file into your project root.

2. Descoment lines `app` and the others in `phpcs.xml` file.

3. Because this package uses third party standards that are not in phpcs you need to install these package.

   1. `composer require slevomat/coding-standard`

4. Run `phpcs .` to check your project.

## Usage

### Enabling the rules

> Only neccesary if you installed as a package using composer!

`php artisan vendor:publish --provider="Mreduar\LaravelPhpcs\LaravelPhpcsServiceProvider" --tag="ruleset"`

This will publish to your root directory the following file

```xml

    

    ./app

    ./config

    ./resources

    ./routes

    ./tests

    

```

Optionally you can also publish a git hook that will help you to never overlook smelly code.

`php artisan vendor:publish --provider="Mreduar\LaravelPhpcs\LaravelPhpcsServiceProvider" --tag="hook"`

The file will be published in its root directory `.git/hooks/pre-commit`

So every time you try to commit `phpcs` will first check that you have everything correct.

```bash

$ git commit -m "test"

[1/1] code sniffer        OK!

[master a6133d7] test

 1 file changed, 1 insertion(+), 1 deletion(-)

```

if you have any errors the commit will be cancelled.

### Sniffing code

Use php CodeSniffer commands, pointed towards your xml file, to sniff the code

using the new ruleset.

`vendor/bin/phpcs`

`vendor/bin/phpcbf`

#### Sniffing code in PHPStorm

See [PHP Code Sniffer in PhpStorm](https://confluence.jetbrains.com/display/PhpStorm/PHP+Code+Sniffer+in+PhpStorm) on how to set up CodeSniffer in PHPStorm.

#### Sniffing code Visual Studio Code

See [PHP Sniffer by wongjn](https://marketplace.visualstudio.com/items?itemName=wongjn.php-sniffer) or other [phpcs](https://marketplace.visualstudio.com/search?term=phpcs&target=VSCode&category=All%20categories&sortBy=Relevance) plugins for more information about PHP Code Sniffer in Visual Studio Code.

--------------------------------------------------------------------------------

## Contributing

All changes that makes the sniffer more accurate towards _Laravel_'s coding standard

is always highly appreciated and welcome.

Please see [CONTRIBUTING](CONTRIBUTING.md) for more details.

## Credits

- [All Contributors](../../contributors)

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.