8 |
9 | Running the PHPCBF command attempts to fix the coding standard violations and displays a diff of the changes that were made.
10 |
11 | 
12 |
13 |
14 |
15 | Installation
16 | --------------
17 | - Install [PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer).
18 | - Clone the PHP_CodeSniffer Sublime Text Plugin in to ST2/ST3 Packages directory.
19 | ```
20 | git clone https://github.com/squizlabs/sublime-PHP_CodeSniffer PHP_CodeSniffer
21 | ```
22 | - Packages directory locations:
23 | ```
24 | Mac: /Users/{user}/Library/Application Support/Sublime Text 2/Packages
25 | Windows: C:\Users\{user}\AppData\Roaming\Sublime Text 2\Packages
26 | Linux: ~/.config/sublime-text-2/Packages
27 | ```
28 |
29 | Configuration
30 | --------------
31 | Configuration files can be opened via Preferences > Package Settings > PHP_CodeSniffer.
32 |
33 | Make sure the php_path, phpcs_path and phpcbf_path paths are correct. E.g.
34 | ```
35 | "phpcs_path": "/usr/local/bin/phpcs",
36 | "phpcbf_path": "/usr/local/bin/phpcbf",
37 | ```
38 |
39 |
40 | **phpcs_standard**
41 |
42 | This settings can be the name of a single standard or a list of folder/project names and the standard to be used for each project. E.g.
43 | ```
44 | "phpcs_standard": "Squiz"
45 | ```
46 | ```
47 | "phpcs_standard": {
48 | "PHP_CodeSniffer": "PHPCS",
49 | "php-sikuli": "PSR1",
50 | "Sublime-PHP_CodeSniffer": "PEAR"
51 | }
52 | ```
53 |
54 | **additional_args**
55 |
56 | Array containing additional arguments to pass to the PHPCS/PHPCBF scripts.
57 |
58 | **error_scope & warning_scope**
59 |
60 | These settings define the colors used for the error and warning gutter markers.
61 | ```
62 | // Gutter error icon color.
63 | "error_scope": "comment.block",
64 |
65 | // Gutter warning icon color.
66 | "warning_scope": "function"
67 | ```
68 |
69 | **run_on_save**
70 |
71 | If set to *true* then buffer will be checked on each save.
72 |
73 |
74 | Usage
75 | --------
76 | There are two shortcuts that can be used for Sublime PHP_CodeSniffer plugin:
77 | - **ALT + S**: Runs PHPCS command for the open buffer.
78 | - **ALT + SHIFT + S**: Runs PHPCBF command for the open buffer.
79 |
80 | These commands are also available in Tools > PHP_CodeSniffer menu.
81 |
--------------------------------------------------------------------------------
/STPluginReport.php:
--------------------------------------------------------------------------------
1 |
6 | * @copyright 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600)
7 | * @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
8 | */
9 |
10 | namespace PHP_CodeSniffer_SublimePlugin;
11 |
12 | use PHP_CodeSniffer\Files\File;
13 | use PHP_CodeSniffer\Reports\Report;
14 |
15 | class STPluginReport implements Report
16 | {
17 |
18 |
19 | /**
20 | * Generate a partial report for a single processed file.
21 | *
22 | * Function should return TRUE if it printed or stored data about the file
23 | * and FALSE if it ignored the file. Returning TRUE indicates that the file and
24 | * its data should be counted in the grand totals.
25 | *
26 | * @param array $report Prepared report data.
27 | * @param \PHP_CodeSniffer\File $phpcsFile The file being reported on.
28 | * @param bool $showSources Show sources?
29 | * @param int $width Maximum allowed line width.
30 | *
31 | * @return bool
32 | */
33 | public function generateFileReport($report, File $phpcsFile, $showSources=false, $width=80)
34 | {
35 | if ($report['errors'] === 0 && $report['warnings'] === 0) {
36 | // Nothing to print.
37 | return false;
38 | }
39 |
40 | echo PHP_EOL;
41 | echo ' PHP_CodeSniffer found '.$report['errors'].' error';
42 | if ($report['errors'] !== 1) {
43 | echo 's';
44 | }
45 |
46 | if ($report['warnings'] > 0) {
47 | echo ' and '.$report['warnings'].' warning';
48 | if ($report['warnings'] !== 1) {
49 | echo 's';
50 | }
51 | }
52 |
53 | echo ' affecting '.count($report['messages']).' line';
54 | if (count($report['messages']) !== 1) {
55 | echo 's';
56 | }
57 |
58 | echo PHP_EOL;
59 |
60 | // Print the fixable message.
61 | if ($report['fixable'] > 0) {
62 | echo PHP_EOL;
63 | $message = 'Good news! ';
64 | if ($report['fixable'] > 1) {
65 | $message .= 'The '.$report['fixable'].' marked sniff violations';
66 | } else {
67 | $message .= 'The marked sniff violation';
68 | }
69 |
70 | $message .= ' below can be fixed automatically';
71 |
72 | $length = (strlen($message) + 4);
73 |
74 | $fixButton = '[ Click here to fix this file ]';
75 | $leftPadding = floor(($length - 4 - strlen($fixButton)) / 2);
76 | $rightPadding = ($length - $leftPadding - strlen($fixButton) - 4);
77 | $fixMessage = str_repeat(' ', $leftPadding).$fixButton.str_repeat(' ', $rightPadding);
78 |
79 | echo ' '.str_repeat('-', $length).PHP_EOL;
80 | echo ' | '.$message.' |'.PHP_EOL;
81 | echo ' | '.$fixMessage.' |'.PHP_EOL;
82 | echo ' '.str_repeat('-', $length).PHP_EOL;
83 | }//end if
84 |
85 | echo PHP_EOL.' Note: click a sniff violation below to jump directly to the relevant line'.PHP_EOL;
86 |
87 | // Work out the max line number for formatting.
88 | $maxLine = 0;
89 | foreach ($report['messages'] as $line => $lineErrors) {
90 | if ($line > $maxLine) {
91 | $maxLine = $line;
92 | }
93 | }
94 |
95 | $maxLineLength = strlen($maxLine);
96 |
97 | if ($report['errors'] > 0) {
98 | echo PHP_EOL.' Errors:'.PHP_EOL;
99 | foreach ($report['messages'] as $line => $lineErrors) {
100 | foreach ($lineErrors as $column => $colErrors) {
101 | foreach ($colErrors as $error) {
102 | if ($error['type'] !== 'ERROR') {
103 | continue;
104 | }
105 |
106 | $message = $error['message'];
107 | if ($showSources === true) {
108 | $message .= ' ('.$error['source'].')';
109 | }
110 |
111 | echo ' ';
112 | if ($report['fixable'] > 0) {
113 | echo '[';
114 | if ($error['fixable'] === true) {
115 | echo 'x';
116 | } else {
117 | echo ' ';
118 | }
119 |
120 | echo '] ';
121 | }
122 |
123 | $padding = ($maxLineLength - strlen($line));
124 | echo 'Line '.$line.str_repeat(' ', $padding).': '.$message.PHP_EOL;
125 | }//end foreach
126 | }//end foreach
127 | }//end foreach
128 | }//end if
129 |
130 | if ($report['warnings'] > 0) {
131 | echo PHP_EOL.' Warnings:'.PHP_EOL;
132 | foreach ($report['messages'] as $line => $lineErrors) {
133 | foreach ($lineErrors as $column => $colErrors) {
134 | foreach ($colErrors as $error) {
135 | if ($error['type'] !== 'WARNING') {
136 | continue;
137 | }
138 |
139 | $message = $error['message'];
140 | if ($showSources === true) {
141 | $message .= ' ('.$error['source'].')';
142 | }
143 |
144 | echo ' ';
145 | if ($report['fixable'] > 0) {
146 | echo '[';
147 | if ($error['fixable'] === true) {
148 | echo 'x';
149 | } else {
150 | echo ' ';
151 | }
152 |
153 | echo '] ';
154 | }
155 |
156 | $padding = ($maxLineLength - strlen($line));
157 | echo 'Line '.$line.str_repeat(' ', $padding).': '.$message.PHP_EOL;
158 | }//end foreach
159 | }//end foreach
160 | }//end foreach
161 | }//end if
162 |
163 | return true;
164 |
165 | }//end generateFileReport()
166 |
167 |
168 | /**
169 | * Prints all errors and warnings for each file processed.
170 | *
171 | * @param string $cachedData Any partial report data that was returned from
172 | * generateFileReport during the run.
173 | * @param int $totalFiles Total number of files processed during the run.
174 | * @param int $totalErrors Total number of errors found during the run.
175 | * @param int $totalWarnings Total number of warnings found during the run.
176 | * @param int $totalFixable Total number of problems that can be fixed.
177 | * @param bool $showSources Show sources?
178 | * @param int $width Maximum allowed line width.
179 | * @param bool $interactive Are we running in interactive mode?
180 | * @param bool $toScreen Is the report being printed to screen?
181 | *
182 | * @return void
183 | */
184 | public function generate(
185 | $cachedData,
186 | $totalFiles,
187 | $totalErrors,
188 | $totalWarnings,
189 | $totalFixable,
190 | $showSources=false,
191 | $width=80,
192 | $interactive=false,
193 | $toScreen=true
194 | ) {
195 | echo $cachedData;
196 |
197 | }//end generate()
198 |
199 |
200 | }//end class
201 |
202 |
--------------------------------------------------------------------------------
/icons/error.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/squizlabs/sublime-PHP_CodeSniffer/e7fa40d3a7ad27553e8caf0014567cace82ed785/icons/error.png
--------------------------------------------------------------------------------
/icons/warning.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/squizlabs/sublime-PHP_CodeSniffer/e7fa40d3a7ad27553e8caf0014567cace82ed785/icons/warning.png
--------------------------------------------------------------------------------