automattic/phpcs-neutron-standard

A set of phpcs sniffs for modern php development.

Monday, July 23, 2018
by sirbrillig
Repository
6 Watchers
41 Stars
6,989 Installations

PHP
9 Dependents
0 Suggesters
2 Forks
3 Open issues
23 Versions
58 % Grown

The README.md

Neutron PHP Standard

Warning, _(*1)

IMPORTANT NOTE: This project is no longer actively developed. At Automattic we've switched to using the WordPress Coding Standards., _(*2)

These are a set of modern (PHP >7) linting guidelines meant to be applied in addition to the the WordPress coding standards for WordPress development. Because of the newer PHP version, it is not suitable for work on Core WordPress, but may be useful for those who are not bound by PHP 5.2., _(*3)

These guidelines are being developed primarily for a team within Automattic, but anyone is free to use them, suggest changes, or report bugs., _(*4)

This project is a phpcs "standard" (a collection of rules or "sniffs") that can be included in any project., _(*5)

Installation

To use these rules in a project which is set up using composer, we recommend using the phpcodesniffer-composer-installer library which will automatically use all installed standards in the current project with the composer type phpcodesniffer-standard when you run phpcs., _(*6)

composer require --dev squizlabs/php_codesniffer dealerdirect/phpcodesniffer-composer-installer
composer require --dev automattic/phpcs-neutron-standard

If you want this standard, the WordPress standard, the VariableAnalysis standard, and other customizations, you can install the meta-standard NeutronRuleset instead., _(*7)

composer require --dev squizlabs/php_codesniffer dealerdirect/phpcodesniffer-composer-installer
composer require --dev automattic/phpcs-neutron-ruleset

Configuration

When installing sniff standards in a project, you edit a phpcs.xml file with the rule tag inside the ruleset tag. The ref attribute of that tag should specify a standard, category, sniff, or error code to enable. It’s also possible to use these tags to disable or modify certain rules. The official annotated file explains how to do this., _(*8)

<?xml version="1.0"?>
<ruleset name="MyStandard">
 <description>My library.</description>
 <rule ref="NeutronStandard"/>
</ruleset>

Usage

Most editors have a phpcs plugin available, but you can also run phpcs manually. To run phpcs on a file in your project, just use the command-line as follows (the -s causes the sniff code to be shown, which is very important for learning about an error)., _(*9)

vendor/bin/phpcs -s src/MyProject/MyClass.php

Guidelines

View the Guidelines here., _(*10)

The Versions

23/07 2018

dev-master

9999999-dev

A set of phpcs sniffs for modern php development.

phpcodesniffer-standard phpcs-neutron-standard

A set of phpcs sniffs for modern php development.

automattic/phpcs-neutron-standard

The README.md

Neutron PHP Standard

Installation

Configuration

Usage

Guidelines

The Versions

dev-master

The Requires

The Development Requires

by Payton Swick

dev-update/require-php-7

The Requires

The Development Requires

by Payton Swick

dev-add/autoload

The Requires

The Development Requires

by Payton Swick

dev-add/warn-unimported-symbol

The Development Requires

by Payton Swick

v1.5.2

The Development Requires

by Payton Swick

v1.5.1

The Development Requires

by Payton Swick

dev-add/require-use

The Development Requires

by Payton Swick

v1.5.0

The Development Requires

by Payton Swick

dev-add-license-1

The Development Requires

by Payton Swick

dev-add/paren-spacing

The Development Requires

by Payton Swick

v1.4.0

The Development Requires

by Payton Swick

dev-add/newline-between-funcs

The Development Requires

by Payton Swick

v1.3.0

The Development Requires

by Payton Swick

v1.2.4

The Development Requires

by Payton Swick

v1.2.3

The Development Requires

by Payton Swick

v1.2.2

The Development Requires

by Payton Swick

v1.2.1

The Development Requires

by Payton Swick

v1.2.0

The Development Requires

by Payton Swick

dev-add/meta-standard-docs

The Development Requires

by Payton Swick

v1.1.0

The Development Requires

by Payton Swick

dev-add/no-unused-imports

The Development Requires

by Payton Swick

v1.0

The Development Requires

by Payton Swick

dev-add/tests