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
+9-7Lines changed: 9 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,14 +3,14 @@
3
3
4
4
# PHPCompatibilityAll
5
5
6
-
Convenience package to install all the external rulesets which the [PHPCompatibility organisation](https://github.com/PHPCompatibility) maintains, in one go using Composer.
6
+
Convenience package to install all the external PHP_CodeSniffer rulesets which the [PHPCompatibility organisation](https://github.com/PHPCompatibility) maintains, in one go using Composer.
7
7
8
8
9
9
## What's included in this package ?
10
10
11
11
### Base ruleset
12
12
13
-
-[](https://packagist.org/packages/phpcompatibility/php-compatibility)[PHPCompatibility](https://github.com/PHPCompatibility/PHPCompatibility) - External PHPCS standard to check your codebase for PHP cross-version compatibility.
13
+
-[](https://packagist.org/packages/phpcompatibility/php-compatibility)[PHPCompatibility](https://github.com/PHPCompatibility/PHPCompatibility) - External PHP_CodeSniffer standard to check your codebase for PHP cross-version compatibility.
14
14
15
15
### Framework/CMS specific rulesets
16
16
@@ -45,7 +45,7 @@ Next, run:
45
45
```bash
46
46
vendor/bin/phpcs -i
47
47
```
48
-
If all went well, you will now see that the PHPCompatibility, PHPCompatibilityJoomla and PHPCompatibilityWP standards are installed for PHP_CodeSniffer.
48
+
If all went well, you will now see that the `PHPCompatibility`, `PHPCompatibilityJoomla` and `PHPCompatibilityWP` standards are installed for PHP_CodeSniffer.
49
49
50
50
51
51
## How to use
@@ -60,16 +60,18 @@ Now you can use any of the following commands to inspect your code:
60
60
By default, you will only receive notifications about deprecated and/or removed PHP features.
61
61
62
62
To get the most out of the PHPCompatibility standards, you should specify a `testVersion` to check against. That will enable the checks for both deprecated/removed PHP features as well as the detection of code using new PHP features.
63
-
- You can run the checks for just one specific PHP version by adding `--runtime-set testVersion 5.5` to your command line command.
64
-
- You can also specify a range of PHP versions that your code needs to support. In this situation, compatibility issues that affect any of the PHP versions in that range will be reported: `--runtime-set testVersion 5.3-5.5`.
65
-
- Since PHPCompatibility 7.1.3, you can omit one part of the range if you want to support everything above or below a particular version, i.e. use `--runtime-set testVersion 7.0-` to run all the checks for PHP 7.0 and above.
63
+
64
+
* You can run the checks for just one specific PHP version by adding `--runtime-set testVersion 5.5` to your command line command.
65
+
* You can also specify a range of PHP versions that your code needs to support. In this situation, compatibility issues that affect any of the PHP versions in that range will be reported: `--runtime-set testVersion 5.3-5.5`.
66
+
* Since PHPCompatibility 7.1.3, you can omit one part of the range if you want to support everything above or below a particular version, i.e. use `--runtime-set testVersion 7.0-` to run all the checks for PHP 7.0 and above.
66
67
67
68
For more detailed information, see the README of the main [PHPCompatibility](https://github.com/PHPCompatibility/PHPCompatibility#sniffing-your-code-for-compatibility-with-specific-php-versions) standard.
68
69
69
70
70
71
## License
71
72
72
-
All code within the PHPCompatibility organisation is released under the GNU Lesser General Public License (LGPL). For more information, visit https://www.gnu.org/copyleft/lesser.html
73
+
All code within the PHPCompatibility organisation is released under the GNU Lesser General Public License (LGPL).
74
+
For more information, visit https://www.gnu.org/copyleft/lesser.html
0 commit comments