https://github.com/bigbite/phpcs-config

Big Bite's PHP Coding Standards.
https://github.com/bigbite/phpcs-config

coding-conventions php-codesniffer ruleset

Last synced: 6 days ago
JSON representation

Big Bite's PHP Coding Standards.

• Host: GitHub
• URL: https://github.com/bigbite/phpcs-config
• Owner: bigbite
• License: mit
• Created: 2021-11-05T08:48:39.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-04-29T23:38:20.000Z (7 months ago)
• Last Synced: 2024-04-30T00:38:01.693Z (7 months ago)
• Topics: coding-conventions, php-codesniffer, ruleset
• Language: PHP
• Homepage:
• Size: 356 KB
• Stars: 2
• Watchers: 4
• Forks: 1
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# BigBite PHPCS Configuration

This package contains the PHPCS configuration [Big Bite](https://bigbite.net) use for all projects.

It is primarily based upon [WPCS](https://github.com/WordPress/WordPress-Coding-Standards) and [VIP WPCS](https://github.com/Automattic/VIP-Coding-Standards), but is more strict, and contains additional Sniffs not included by those standards.

## Installation

Run the following command in terminal:

```bash

composer require --dev bigbite/phpcs-config

```

Then run:

```bash

$ composer update

```

Create a `.phpcs.xml.dist` file in your project and add the following, replacing {PROJECT} with your project name:

```xml

	

```

Alternatively, you can install the standard globally:

```bash

composer global require --dev bigbite/phpcs-config

```

And reference the standard directly within your `.phpcs.xml.dist`:

```xml

	

```

## Developing

Please note that the PHPUnit test suite is not yet compatible with PHP 8.*.

Clone this repository, and then run `composer install && composer install-cs`.  

Please run the following command prior to creating a PR, and ensure that there are no errors:

- `composer run all-checks`

If you're feeling especially nice, you can run this command instead:

- `composer run all-checks-strict`