Skip to content

Commit 51d4409

Browse files
vv12131415vv12131415
committed
moved Config:: magic properties description to class level annotations
1 parent 6070b60 commit 51d4409

File tree

1 file changed

+55
-55
lines changed

1 file changed

+55
-55
lines changed

‎src/Config.php‎

Lines changed: 55 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,60 @@
1414

1515
use PHP_CodeSniffer\Exceptions\DeepExitException;
1616
use PHP_CodeSniffer\Exceptions\RuntimeException;
17-
17+
/**
18+
* Class Config
19+
*
20+
* @property string[] $files The files and directories to check.
21+
* @property string[] $standards The standards being used for checking.
22+
* @property int $verbosity How verbose the output should be.
23+
* 0: no unnecessary output
24+
* 1: basic output for files being checked
25+
* 2: ruleset and file parsing output
26+
* 3: sniff execution output
27+
* @property bool $interactive Enable interactive checking mode.
28+
* @property bool $parallel Check files in parallel.
29+
* @property bool $cache Enable the use of the file cache.
30+
* @property bool $cacheFile A file where the cache data should be written
31+
* @property bool $colors Display colours in output.
32+
* @property bool $explain Explain the coding standards.
33+
* @property bool $local Process local files in directories only (no recursion).
34+
* @property bool $showSources Show sniff source codes in report output.
35+
* @property bool $showProgress Show basic progress information while running.
36+
* @property bool $quiet Quiet mode; disables progress and verbose output.
37+
* @property bool $annotations Process phpcs: annotations.
38+
* @property int $tabWidth How many spaces each tab is worth.
39+
* @property string $encoding The encoding of the files being checked.
40+
* @property string[] $sniffs The sniffs that should be used for checking.
41+
* If empty, all sniffs in the supplied standards will be used.
42+
* @property string[] $exclude The sniffs that should be excluded from checking.
43+
* If empty, all sniffs in the supplied standards will be used.
44+
* @property string[] $ignored Regular expressions used to ignore files and folders during checking.
45+
* @property string $reportFile A file where the report output should be written.
46+
* @property string $generator The documentation generator to use.
47+
* @property string $filter The filter to use for the run.
48+
* @property string[] $bootstrap One of more files to include before the run begins.
49+
* @property int $reportWidth The maximum number of columns that reports should use for output.
50+
* Set to "auto" for have this value changed to the width of the terminal.
51+
* @property int $errorSeverity The minimum severity an error must have to be displayed.
52+
* @property int $warningSeverity The minimum severity a warning must have to be displayed.
53+
* @property bool $recordErrors Record the content of error messages as well as error counts.
54+
* @property string $suffix A suffix to add to fixed files.
55+
* @property string $basepath A file system location to strip from the paths of files shown in reports.
56+
* @property bool $stdin Read content from STDIN instead of supplied files.
57+
* @property string $stdinContent Content passed directly to PHPCS on STDIN.
58+
* @property string $stdinPath The path to use for content passed on STDIN.
59+
* @property array<string, string> $extensions File extensions that should be checked, and what tokenizer to use.
60+
* E.g., array('inc' => 'PHP');
61+
* @property array<string, string|null> $reports The reports to use for printing output after the run.
62+
* The format of the array is:
63+
* array(
64+
* 'reportName1' => 'outputFile',
65+
* 'reportName2' => null,
66+
* );
67+
* If the array value is NULL, the report will be written to the screen.
68+
* @property string[] $unknown Any arguments gathered on the command line that are unknown to us.
69+
* E.g., using `phpcs -c` will give array('c');
70+
*/
1871
class Config
1972
{
2073

@@ -40,60 +93,7 @@ class Config
4093
* can be used to validate the values. For example, to set the verbosity level to
4194
* level 2, use $this->verbosity = 2; instead of accessing this property directly.
4295
*
43-
* The list of settings are:
44-
*
45-
* string[] files The files and directories to check.
46-
* string[] standards The standards being used for checking.
47-
* int verbosity How verbose the output should be.
48-
* 0: no unnecessary output
49-
* 1: basic output for files being checked
50-
* 2: ruleset and file parsing output
51-
* 3: sniff execution output
52-
* bool interactive Enable interactive checking mode.
53-
* bool parallel Check files in parallel.
54-
* bool cache Enable the use of the file cache.
55-
* bool cacheFile A file where the cache data should be written
56-
* bool colors Display colours in output.
57-
* bool explain Explain the coding standards.
58-
* bool local Process local files in directories only (no recursion).
59-
* bool showSources Show sniff source codes in report output.
60-
* bool showProgress Show basic progress information while running.
61-
* bool quiet Quiet mode; disables progress and verbose output.
62-
* bool annotations Process phpcs: annotations.
63-
* int tabWidth How many spaces each tab is worth.
64-
* string encoding The encoding of the files being checked.
65-
* string[] sniffs The sniffs that should be used for checking.
66-
* If empty, all sniffs in the supplied standards will be used.
67-
* string[] exclude The sniffs that should be excluded from checking.
68-
* If empty, all sniffs in the supplied standards will be used.
69-
* string[] ignored Regular expressions used to ignore files and folders during checking.
70-
* string reportFile A file where the report output should be written.
71-
* string generator The documentation generator to use.
72-
* string filter The filter to use for the run.
73-
* string[] bootstrap One of more files to include before the run begins.
74-
* int reportWidth The maximum number of columns that reports should use for output.
75-
* Set to "auto" for have this value changed to the width of the terminal.
76-
* int errorSeverity The minimum severity an error must have to be displayed.
77-
* int warningSeverity The minimum severity a warning must have to be displayed.
78-
* bool recordErrors Record the content of error messages as well as error counts.
79-
* string suffix A suffix to add to fixed files.
80-
* string basepath A file system location to strip from the paths of files shown in reports.
81-
* bool stdin Read content from STDIN instead of supplied files.
82-
* string stdinContent Content passed directly to PHPCS on STDIN.
83-
* string stdinPath The path to use for content passed on STDIN.
84-
*
85-
* array<string, string> extensions File extensions that should be checked, and what tokenizer to use.
86-
* E.g., array('inc' => 'PHP');
87-
* array<string, string|null> reports The reports to use for printing output after the run.
88-
* The format of the array is:
89-
* array(
90-
* 'reportName1' => 'outputFile',
91-
* 'reportName2' => null,
92-
* );
93-
* If the array value is NULL, the report will be written to the screen.
94-
*
95-
* string[] unknown Any arguments gathered on the command line that are unknown to us.
96-
* E.g., using `phpcs -c` will give array('c');
96+
* All of those are described in class annotation as @property
9797
*
9898
* @var array<string, mixed>
9999
*/

0 commit comments

Comments
 (0)