You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-8Lines changed: 10 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -1,19 +1,19 @@
1
1
## About
2
2
3
-
PHP\_CodeSniffer is a set of two PHP scripts; the main `phpcs` script that tokenizes PHP, JavaScript and CSS files to detect violations of a defined coding standard, and a second `phpcbf` script to automatically correct coding standard violations. PHP\_CodeSniffer is an essential development tool that ensures your code remains clean and consistent.
3
+
PHP_CodeSniffer is a set of two PHP scripts; the main `phpcs` script that tokenizes PHP, JavaScript and CSS files to detect violations of a defined coding standard, and a second `phpcbf` script to automatically correct coding standard violations. PHP_CodeSniffer is an essential development tool that ensures your code remains clean and consistent.
4
4
5
5
[](https://travis-ci.org/squizlabs/PHP_CodeSniffer)[](http://squizlabs.github.io/PHP_CodeSniffer/analysis/squizlabs/PHP_CodeSniffer)[](https://gitter.im/squizlabs/PHP_CodeSniffer?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
6
6
7
7
## Requirements
8
8
9
-
PHP\_CodeSniffer requires PHP version 5.4.0 or greater, although individual sniffs may have additional requirements such as external applications and scripts. See the [Configuration Options manual page](https://github.com/squizlabs/PHP_CodeSniffer/wiki/Configuration-Options) for a list of these requirements.
9
+
PHP_CodeSniffer requires PHP version 5.4.0 or greater, although individual sniffs may have additional requirements such as external applications and scripts. See the [Configuration Options manual page](https://github.com/squizlabs/PHP_CodeSniffer/wiki/Configuration-Options) for a list of these requirements.
10
10
11
11
If you're using PHP_CodeSniffer as part of a team, or you're running it on a [CI](https://en.wikipedia.org/wiki/Continuous_integration) server, you may want to configure your project's settings [using a configuration file](https://github.com/squizlabs/PHP_CodeSniffer/wiki/Advanced-Usage#using-a-default-configuration-file).
12
12
13
13
14
14
## Installation
15
15
16
-
The easiest way to get started with PHP\_CodeSniffer is to download the Phar files for each of the commands:
16
+
The easiest way to get started with PHP_CodeSniffer is to download the Phar files for each of the commands:
@@ -62,12 +62,12 @@ You will then be able to run PHP_CodeSniffer from the tools directory:
62
62
./tools/phpcbf -h
63
63
64
64
### PEAR
65
-
If you use PEAR, you can install PHP\_CodeSniffer using the PEAR installer. This will make the `phpcs` and `phpcbf` commands immediately available for use. To install PHP\_CodeSniffer using the PEAR installer, first ensure you have [installed PEAR](http://pear.php.net/manual/en/installation.getting.php) and then run the following command:
65
+
If you use PEAR, you can install PHP_CodeSniffer using the PEAR installer. This will make the `phpcs` and `phpcbf` commands immediately available for use. To install PHP_CodeSniffer using the PEAR installer, first ensure you have [installed PEAR](http://pear.php.net/manual/en/installation.getting.php) and then run the following command:
66
66
67
67
pear install PHP_CodeSniffer
68
68
69
69
### Git Clone
70
-
You can also download the PHP\_CodeSniffer source and run the `phpcs` and `phpcbf` commands directly from the Git clone:
70
+
You can also download the PHP_CodeSniffer source and run the `phpcs` and `phpcbf` commands directly from the Git clone:
@@ -76,7 +76,7 @@ You can also download the PHP\_CodeSniffer source and run the `phpcs` and `phpcb
76
76
77
77
## Documentation
78
78
79
-
The documentation for PHP\_CodeSniffer is available on the [Github wiki](https://github.com/squizlabs/PHP_CodeSniffer/wiki).
79
+
The documentation for PHP_CodeSniffer is available on the [Github wiki](https://github.com/squizlabs/PHP_CodeSniffer/wiki).
80
80
81
81
## Issues
82
82
@@ -94,13 +94,15 @@ The `MAJOR` version is incremented when:
94
94
- backwards-incompatible changes are made to how the `phpcs` or `phpcbf` commands are used, or
95
95
- backwards-incompatible changes are made to the `ruleset.xml` format, or
96
96
- backwards-incompatible changes are made to the API used by sniff developers, or
97
-
- custom PHP_CodeSniffer token types are removed
97
+
- custom PHP_CodeSniffer token types are removed, or
98
+
- existing sniffs are removed from PHP_CodeSniffer entirely
98
99
99
100
The `MINOR` version is incremented when:
100
101
- new backwards-compatible features are added to the `phpcs` and `phpcbf` commands, or
101
102
- backwards-compatible changes are made to the `ruleset.xml` format, or
102
103
- backwards-compatible changes are made to the API used by sniff developers, or
103
-
- new sniffs are added to an included standard
104
+
- new sniffs are added to an included standard, or
105
+
- existing sniffs are removed from an included standard
104
106
105
107
> NOTE: Backwards-compatible changes to the API used by sniff developers will allow an existing sniff to continue running without producing fatal errors but may not result in the sniff reporting the same errors as it did previously without changes being required.
0 commit comments