├── .gitignore
├── NeutronRuleset
    └── ruleset.xml
├── README.md
└── composer.json


/.gitignore:
--------------------------------------------------------------------------------
1 | vendor
2 | composer.lock
3 | 


--------------------------------------------------------------------------------
/NeutronRuleset/ruleset.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <ruleset name="NeutronRuleset">
 3 | 	<description>Neutron Ruleset.</description>
 4 | 	<rule ref="VariableAnalysis"/>
 5 | 	<rule ref="NeutronStandard"/>
 6 | 	<rule ref="ImportDetection"/>
 7 | 	<rule ref="WordPress-Core"/>
 8 | 	<rule ref="Squiz.Commenting">
 9 | 		<severity>0</severity>
10 | 	</rule>
11 | 	<rule ref="ImportDetection.Imports.RequireImports">
12 | 		<properties>
13 | 			<property name="ignoreUnimportedSymbols" value="/^(BD_PROCESSOR_[A-Z_]+|BD_STRIPE_[A-Z_]+|BD_PAYPAL_[A-Z_]+|BD_TXN[A-Z_]+|BD_TYPE[A-Z_]+|BILLINGDADDY_HOME|require_lib|WPCOM_[A-Z_]+|tracks_record_event|BD_INTERVAL_[A-Z_]+)$/"/>
14 | 			<property name="ignoreGlobalsWhenInGlobalScope" value="true"/>
15 | 			<property name="ignoreWordPressSymbols" value="true"/>
16 | 		</properties>
17 | 	</rule>
18 | 	<rule ref="PEAR.Functions.FunctionCallSignature.MultipleArguments">
19 | 		<severity>0</severity>
20 | 	</rule>
21 | 	<rule ref="Generic.Commenting.DocComment.SpacingBeforeTags">
22 | 		<severity>0</severity>
23 | 	</rule>
24 | 	<rule ref="WordPress.Files.FileName">
25 | 		<severity>0</severity>
26 | 	</rule>
27 | 	<rule ref="WordPress.PHP.DevelopmentFunctions">
28 | 		<severity>0</severity>
29 | 	</rule>
30 | 	<rule ref="WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid">
31 | 		<severity>0</severity>
32 | 	</rule>
33 | 	<rule ref="WordPress.Arrays.MultipleStatementAlignment.DoubleArrowNotAligned">
34 | 		<severity>0</severity>
35 | 	</rule>
36 | 	<rule ref="Generic.Formatting.MultipleStatementAlignment.NotSameWarning">
37 | 		<severity>0</severity>
38 | 	</rule>
39 | 	<rule ref="Generic.Commenting.DocComment.MissingShort">
40 | 		<severity>0</severity>
41 | 	</rule>
42 | 	<rule ref="WordPress.PHP.YodaConditions.NotYoda">
43 | 		<severity>0</severity>
44 | 	</rule>
45 | 	<rule ref="Generic.Functions.OpeningFunctionBraceKernighanRitchie.ContentAfterBrace">
46 | 		<severity>0</severity>
47 | 	</rule>
48 | 	<rule ref="WordPress.WhiteSpace.ControlStructureSpacing.NoSpaceAfterCloseParenthesis">
49 | 		<severity>0</severity>
50 | 	</rule>
51 | 	<rule ref="NeutronStandard.StrictTypes.RequireStrictTypes.StrictTypes">
52 | 		<type>warning</type>
53 | 	</rule>
54 | 	<rule ref="WordPress.Arrays.ArrayDeclarationSpacing.AssociativeArrayFound">
55 | 		<type>warning</type>
56 | 	</rule>
57 | 	<rule ref="WordPress.DB.DirectDatabaseQuery.NoCaching">
58 | 		<severity>0</severity>
59 | 	</rule>
60 | 	<rule ref="ImportDetection.Imports.RequireImports.Import">
61 | 		<type>error</type>
62 | 	</rule>
63 | 	<rule ref="VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable">
64 | 		<type>error</type>
65 | 	</rule>
66 | 	<rule ref="VariableAnalysis.CodeAnalysis.VariableAnalysis">
67 | 		<properties>
68 | 			<property name="allowUnusedCaughtExceptions" value="true"/>
69 | 		</properties>
70 | 	</rule>
71 | 	<rule ref="WordPress.PHP.StrictInArray.MissingTrueStrict">
72 | 		<type>error</type>
73 | 	</rule>
74 | 	<rule ref="NeutronStandard.Functions.TypeHint.NoArgumentType">
75 | 		<severity>0</severity>
76 | 	</rule>
77 | 	<rule ref="WordPress.PHP.StrictComparisons.LooseComparison">
78 | 		<type>error</type>
79 | 	</rule>
80 | 	<rule ref="WordPress.DB.DirectDatabaseQuery.DirectQuery">
81 | 		<severity>0</severity>
82 | 	</rule>
83 | 	<rule ref="WordPress.DB.PreparedSQL.NotPrepared">
84 | 		<type>warning</type>
85 | 	</rule>
86 | 	<rule ref="WordPress.Security.EscapeOutput.OutputNotEscaped">
87 | 		<severity>0</severity>
88 | 	</rule>
89 | 	<rule ref="WordPress.PHP.DevelopmentFunctions.error_log_var_export">
90 | 		<severity>0</severity>
91 | 	</rule>
92 | 	<rule ref="Generic.Arrays.DisallowShortArraySyntax">
93 | 		<severity>0</severity>
94 | 	</rule>
95 | </ruleset>
96 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # Neutron PHP Ruleset
 2 | 
 3 | These are a set of modern (PHP >7) linting guidelines 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.
 4 | 
 5 | 
 6 | > **Warning**
 7 | >
 8 | > **IMPORTANT NOTE:** This project is no longer actively developed. At Automattic we've switched to using the [WordPress Coding Standards](https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards) + [VariableAnalysis](https://github.com/sirbrillig/phpcs-variable-analysis).
 9 | 
10 | -----
11 | 
12 | These guidelines are being developed primarily for a team within [Automattic](https://automattic.com/), but anyone is free to use them, suggest changes, or report bugs.
13 | 
14 | This project is a [phpcs](https://github.com/squizlabs/PHP_CodeSniffer) "standard" (a collection of rules or "sniffs") that can be included in any project.
15 | 
16 | This is a meta-project in that it's just a collection of rules defined in these packages with certain modifications:
17 | 
18 | - [WordPress Coding Standards](https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards)
19 | - [VariableAnalysis](https://github.com/sirbrillig/phpcs-variable-analysis)
20 | - [NeutronStandard](https://github.com/Automattic/phpcs-neutron-standard)
21 | - [ImportDetection](https://github.com/sirbrillig/phpcs-import-detection)
22 | 
23 | ## Installation
24 | 
25 | To use these rules in a project which is set up using [composer](https://href.li/?https://getcomposer.org/), we recommend using the [phpcodesniffer-composer-installer library](https://href.li/?https://github.com/DealerDirect/phpcodesniffer-composer-installer) which will automatically use all installed standards in the current project with the composer type `phpcodesniffer-standard` when you run phpcs.
26 | 
27 | ```
28 | composer require --dev squizlabs/php_codesniffer dealerdirect/phpcodesniffer-composer-installer
29 | composer require --dev automattic/phpcs-neutron-ruleset
30 | ```
31 | 
32 | ## Configuration
33 | 
34 | 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](https://href.li/?https://github.com/squizlabs/PHP_CodeSniffer/wiki/Annotated-ruleset.xml) explains how to do this.
35 | 
36 | The following configuration will enable all the sniffs in this ruleset.
37 | 
38 | ```xml
39 | <?xml version="1.0"?>
40 | <ruleset name="MyStandard">
41 |  <description>My library.</description>
42 |  <rule ref="NeutronRuleset"/>
43 | </ruleset>
44 | ```
45 | 
46 | ## Usage
47 | 
48 | 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).
49 | 
50 | ```
51 | vendor/bin/phpcs -s src/MyProject/MyClass.php
52 | ```
53 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "automattic/phpcs-neutron-ruleset",
 3 |     "type": "phpcodesniffer-standard",
 4 |     "keywords": [ "phpcs", "static analysis" ],
 5 |     "description": "A PHPCS meta-ruleset for WordPress development",
 6 |     "license": "MIT",
 7 |     "require": {
 8 |         "php": "^7.0 || ^8.0",
 9 |         "automattic/phpcs-neutron-standard": "^1.5.3",
10 |         "sirbrillig/phpcs-import-detection": "^1.1.4",
11 |         "sirbrillig/phpcs-variable-analysis": "^2.6.1",
12 |         "wp-coding-standards/wpcs": "^2.1.0"
13 |     },
14 |     "require-dev": {
15 |         "dealerdirect/phpcodesniffer-composer-installer": "^0.5.0",
16 |         "squizlabs/php_codesniffer": "^3.4.2"
17 |     }
18 | }
19 | 


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