comparison vendor/drupal/coder/README.md @ 5:12f9dff5fda9 tip

Update to Drupal core 8.7.1
author Chris Cannam
date Thu, 09 May 2019 15:34:47 +0100
parents a9cd425dd02b
children
comparison
equal deleted inserted replaced
4:a9cd425dd02b 5:12f9dff5fda9
1 # Coder 1 # Coder
2 2
3 [![Build Status](https://travis-ci.org/pfrenssen/coder.svg?branch=8.x-2.x)](https://travis-ci.org/pfrenssen/coder) 3 [![Build Status](https://travis-ci.org/pfrenssen/coder.svg?branch=8.x-3.x)](https://travis-ci.org/pfrenssen/coder)
4 4
5 Coder is a library for automated Drupal code reviews and coding standard fixes. It 5 Coder is a library for automated Drupal code reviews and coding standard fixes. It
6 defines rules for [PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer) 6 defines rules for [PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer)
7 7
8 Built-in support for: 8 Built-in support for:
23 which composer 23 which composer
24 24
25 If you get composer not found or similar, follow Composer's installation 25 If you get composer not found or similar, follow Composer's installation
26 instructions. 26 instructions.
27 27
28 Install Coder (8.x-2.x) in your global Composer directory in your home directory 28 Install Coder (8.x-3.x) in your global Composer directory in your home directory
29 (`~/.composer`): 29 (`~/.composer`):
30 30
31 composer global require drupal/coder 31 composer global require drupal/coder
32 32
33 To make the `phpcs` and `phpcbf` commands available globally, add the Composer 33 To make the `phpcs` and `phpcbf` commands available globally, add the Composer
79 79
80 Drupal Code Sniffer can be used with various editors. 80 Drupal Code Sniffer can be used with various editors.
81 81
82 Editors: 82 Editors:
83 83
84 - [Atom](https://www.drupal.org/node/1419996)
84 - [Eclipse](https://www.drupal.org/node/1420004) 85 - [Eclipse](https://www.drupal.org/node/1420004)
85 - [Komodo](https://www.drupal.org/node/1419996) 86 - [Komodo](https://www.drupal.org/node/1419996)
86 - [Netbeans](https://www.drupal.org/node/1420008) 87 - [Netbeans](https://www.drupal.org/node/1420008)
87 - [PhpStorm](https://www.jetbrains.com/help/phpstorm/php-code-sniffer.html) 88 - [PhpStorm](https://www.jetbrains.com/help/phpstorm/php-code-sniffer.html)
88 - [Sublime Text](https://www.drupal.org/node/1419996) 89 - [Sublime Text](https://www.drupal.org/node/1419996)
89 - [Vim](https://www.drupal.org/node/1419996) 90 - [Vim](https://www.drupal.org/node/1419996)
91 - [Visual Studio Code (VSCode)](https://www.drupal.org/node/1419996)
90 92
91 93
92 ## Automated Testing (PHPUnit + PHPCS) 94 ## Automated Testing (PHPUnit + PHPCS)
93 95
94 Coder Sniffer comes with a PHPUnit test suite to make sure the sniffs work correctly. 96 Coder Sniffer comes with a PHPUnit test suite to make sure the sniffs work correctly.
106 108
107 109
108 ## Contributing 110 ## Contributing
109 111
110 1. Make sure an issue exists at https://www.drupal.org/project/issues/coder 112 1. Make sure an issue exists at https://www.drupal.org/project/issues/coder
111 2. Create a [pull request](https://help.github.com/articles/using-pull-requests/) against https://github.com/pfrenssen/coder 113 2. Create a [Pull Request](https://help.github.com/articles/using-pull-requests/) against https://github.com/pfrenssen/coder
112 3. Post a link to the pull request to the issue on drupal.org and set the issue to 114 3. Post a link to the pull request to the issue on drupal.org and set the issue to
113 "needs review" 115 "needs review"
114 116
115 Thank you! 117 Thank you!
116 118
117 119
118 ## Maintainers 120 ## Maintainers
119 Pieter Frenssen, https://www.drupal.org/u/pfrenssen 121
122 - Pieter Frenssen, https://www.drupal.org/u/pfrenssen
123 - Michael Welford, https://www.drupal.org/u/mikejw
124 - Klaus Purer, https://www.drupal.org/u/klausi
120 125
121 126
122 ## Credits 127 ## Credits
123 128
124 Greg Sherwood and Squiz Pty Ltd, many sniffs are modified copies of their original 129 Greg Sherwood and Squiz Pty Ltd, many sniffs are modified copies of their original