|
2 | 2 |
|
3 | 3 | <div aria-hidden="true"> |
4 | 4 |
|
5 | | -[](https://packagist.org/packages/phpcsstandards/phpcsdevtools) |
6 | | -[](https://github.com/PHPCSStandards/PHPCSDevTools/releases) |
| 5 | +[][phpcsdevtools-packagist] |
| 6 | +[][phpcsdevtools-releases] |
7 | 7 | [](https://github.com/PHPCSStandards/PHPCSDevTools/blob/stable/CHANGELOG.md) |
8 | 8 | :construction: |
9 | 9 | [](https://packagist.org/packages/phpcsstandards/phpcsdevtools#dev-develop) |
10 | 10 | [](https://github.com/PHPCSStandards/PHPCSDevTools/commits/develop) |
11 | 11 |
|
12 | | -[](https://packagist.org/packages/phpcsstandards/phpcsdevtools) |
13 | | -[](https://github.com/PHPCSStandards/PHPCSDevTools/actions/workflows/cs.yml) |
14 | | -[](https://github.com/PHPCSStandards/PHPCSDevTools/actions/workflows/test.yml) |
| 12 | +[][phpcsdevtools-packagist] |
| 13 | +[][gha-qa-results] |
| 14 | +[][gha-test-results] |
15 | 15 | [](https://github.com/PHPCSStandards/PHPCSDevTools/actions?query=workflow%3ATest) |
16 | 16 |
|
17 | | -[](https://github.com/PHPCSStandards/PHPCSDevTools/blob/stable/LICENSE) |
| 17 | +[](https://github.com/PHPCSStandards/PHPCSDevTools/blob/stable/LICENSE) |
18 | 18 |  |
19 | 19 |
|
20 | 20 | </div> |
21 | 21 |
|
22 | | -This is a set of tools to assist developers of sniffs for [PHP CodeSniffer](https://github.com/PHPCSStandards/PHP_CodeSniffer). |
| 22 | +This is a set of tools to assist developers of sniffs for [PHP CodeSniffer][phpcs-gh]. |
23 | 23 |
|
24 | 24 | * [Installation](#installation) |
25 | 25 | + [Composer Project-based Installation](#composer-project-based-installation) |
@@ -56,9 +56,9 @@ Composer will automatically install dependencies and register the PHPCSDebug sta |
56 | 56 |
|
57 | 57 | ### Stand-alone Installation |
58 | 58 |
|
59 | | -* Install [PHP CodeSniffer](https://github.com/PHPCSStandards/PHP_CodeSniffer) via [your preferred method](https://github.com/PHPCSStandards/PHP_CodeSniffer#installation). |
| 59 | +* Install [PHP CodeSniffer][phpcs-gh] via [your preferred method][phpcs-gh-install]. |
60 | 60 | * Register the path to PHPCS in your system `$PATH` environment variable to make the `phpcs` command available from anywhere in your file system. |
61 | | -* Download the [latest PHPCSDevTools release](https://github.com/PHPCSStandards/PHPCSDevTools/releases) and unzip/untar it into an arbitrary directory. |
| 61 | +* Download the [latest PHPCSDevTools release][phpcsdevtools-releases] and unzip/untar it into an arbitrary directory. |
62 | 62 | You can also choose to clone this repository using git. |
63 | 63 | * Add the path to the directory in which you placed your copy of the PHPCSDevTools repo to the PHP CodeSniffer configuration using the below command: |
64 | 64 | ```bash |
@@ -175,7 +175,7 @@ PHPCS itself can also display similar information using the `-vv` or `-vvv` verb |
175 | 175 |
|
176 | 176 | ### Documentation XSD Validation |
177 | 177 |
|
178 | | -This project contains an [XML Schema Definition (XSD)](https://www.w3.org/standards/xml/schema) to allow for validation PHPCS documentation XML files. Following the XSD will make sure your documentation can be correctly displayed when using the PHPCS `--generator` option. |
| 178 | +This project contains an [XML Schema Definition (XSD)](https://www.w3.org/TR/xmlschema11-1/) to allow for validation PHPCS documentation XML files. Following the XSD will make sure your documentation can be correctly displayed when using the PHPCS `--generator` option. |
179 | 179 |
|
180 | 180 | In order to use it, you'll need to add the schema related attributes to the `documentation` element of the sniff documentation file, like so: |
181 | 181 |
|
@@ -234,4 +234,13 @@ If unsure whether the changes you are proposing would be welcome, open an issue |
234 | 234 |
|
235 | 235 | ## License |
236 | 236 |
|
237 | | -This code is released under the [GNU Lesser General Public License (LGPLv3)](http://www.gnu.org/copyleft/lesser.html). |
| 237 | +This code is released under the [GNU Lesser General Public License (LGPLv3)](LICENSE). |
| 238 | + |
| 239 | + |
| 240 | +[phpcsdevtools-packagist]: https://packagist.org/packages/phpcsstandards/phpcsdevtools |
| 241 | +[phpcsdevtools-releases]: https://github.com/PHPCSStandards/PHPCSDevTools/releases |
| 242 | +[gha-qa-results]: https://github.com/PHPCSStandards/PHPCSDevTools/actions/workflows/cs.yml |
| 243 | +[gha-test-results]: https://github.com/PHPCSStandards/PHPCSDevTools/actions/workflows/test.yml |
| 244 | + |
| 245 | +[phpcs-gh]: https://github.com/PHPCSStandards/PHP_CodeSniffer |
| 246 | +[phpcs-gh-install]: https://github.com/PHPCSStandards/PHP_CodeSniffer#installation |
0 commit comments