https://github.com/szepeviktor/phpcs-psr-12-neutron-hybrid-ruleset

My useful frankenstein PHPCS ruleset 👓 for OOP WordPress development
https://github.com/szepeviktor/phpcs-psr-12-neutron-hybrid-ruleset

coding-standards phpcs psr-12 ruleset wordpress wordpress-development wpcs

Last synced: 9 days ago
JSON representation

My useful frankenstein PHPCS ruleset 👓 for OOP WordPress development

• Host: GitHub
• URL: https://github.com/szepeviktor/phpcs-psr-12-neutron-hybrid-ruleset
• Owner: szepeviktor
• License: mit
• Created: 2019-11-23T08:48:50.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-09-30T07:50:13.000Z (about 2 months ago)
• Last Synced: 2024-10-31T19:37:08.349Z (16 days ago)
• Topics: coding-standards, phpcs, psr-12, ruleset, wordpress, wordpress-development, wpcs
• Language: PHP
• Homepage: https://packagist.org/packages/szepeviktor/phpcs-psr-12-neutron-hybrid-ruleset
• Size: 81.1 KB
• Stars: 10
• Watchers: 2
• Forks: 2
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Hybrid PHPCS ruleset for OOP WordPress development

[![Build Status](https://app.travis-ci.com/szepeviktor/phpcs-psr-12-neutron-hybrid-ruleset.svg?token=CgYVxsSdNVnRNCDNV3qG&branch=master)](https://app.travis-ci.com/szepeviktor/phpcs-psr-12-neutron-hybrid-ruleset)

[![Packagist Version](https://img.shields.io/packagist/v/szepeviktor/phpcs-psr-12-neutron-hybrid-ruleset)](https://packagist.org/packages/szepeviktor/phpcs-psr-12-neutron-hybrid-ruleset)

[![Packagist PHP Version Support](https://img.shields.io/packagist/php-v/szepeviktor/phpcs-psr-12-neutron-hybrid-ruleset)](https://packagist.org/packages/szepeviktor/phpcs-psr-12-neutron-hybrid-ruleset)

- [PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer)

- [PSR-12](https://www.php-fig.org/psr/psr-12/)

- [Neutron PHP Ruleset by Automattic](https://github.com/Automattic/phpcs-neutron-ruleset)

- [Slevomat Coding Standard](https://github.com/slevomat/coding-standard)

### Features

- PSR-12 Extended Coding Style as starting point (formatting)

- All [WPCS](https://github.com/WordPress/WordPress-Coding-Standards) features through Neutron (except formatting)

- File permission bits

- Strict types

- File, class and method comments

- Handpicked [Slevomat](https://github.com/slevomat/coding-standard) rules

### Usage

```bash

composer require --dev szepeviktor/phpcs-psr-12-neutron-hybrid-ruleset

./vendor/bin/phpcs --standard=PSR12NeutronRuleset src/

```

### About the `@package` tag

- The origins of the `@package` tag are in [PEAR](https://pear.php.net/manual/en/standards.header.php)

  where packages are called for example `Net_Ping`

- You can put your Composer package name there: `yoast/phpunit-polyfills`

- Or you can use your WordPress.org plugin slug: `wordpress-seo`