PHP_CodeSniffer_CLI::printPHPCSUsage PHP Метод

printPHPCSUsage() публичный Метод

Prints out the usage information for PHPCS.
public printPHPCSUsage ( ) : void
Результат void
    public function printPHPCSUsage()
    {
        echo 'Usage: phpcs [-nwlsaepqvi] [-d key[=value]] [--colors] [--no-colors] [--stdin-path=<stdinPath>]' . PHP_EOL;
        echo '    [--report=<report>] [--report-file=<reportFile>] [--report-<report>=<reportFile>] ...' . PHP_EOL;
        echo '    [--report-width=<reportWidth>] [--generator=<generator>] [--tab-width=<tabWidth>]' . PHP_EOL;
        echo '    [--severity=<severity>] [--error-severity=<severity>] [--warning-severity=<severity>]' . PHP_EOL;
        echo '    [--runtime-set key value] [--config-set key value] [--config-delete key] [--config-show]' . PHP_EOL;
        echo '    [--standard=<standard>] [--sniffs=<sniffs>] [--exclude=<sniffs>] [--encoding=<encoding>]' . PHP_EOL;
        echo '    [--extensions=<extensions>] [--ignore=<patterns>] [--bootstrap=<bootstrap>]' . PHP_EOL;
        echo '    [--file-list=<fileList>] <file> ...' . PHP_EOL;
        echo '                      Set runtime value (see --config-set) ' . PHP_EOL;
        echo '        -n            Do not print warnings (shortcut for --warning-severity=0)' . PHP_EOL;
        echo '        -w            Print both warnings and errors (this is the default)' . PHP_EOL;
        echo '        -l            Local directory only, no recursion' . PHP_EOL;
        echo '        -s            Show sniff codes in all reports' . PHP_EOL;
        echo '        -a            Run interactively' . PHP_EOL;
        echo '        -e            Explain a standard by showing the sniffs it includes' . PHP_EOL;
        echo '        -p            Show progress of the run' . PHP_EOL;
        echo '        -q            Quiet mode; disables progress and verbose output' . PHP_EOL;
        echo '        -v[v][v]      Print verbose output' . PHP_EOL;
        echo '        -i            Show a list of installed coding standards' . PHP_EOL;
        echo '        -d            Set the [key] php.ini value to [value] or [true] if value is omitted' . PHP_EOL;
        echo '        --help        Print this help message' . PHP_EOL;
        echo '        --version     Print version information' . PHP_EOL;
        echo '        --colors      Use colors in output' . PHP_EOL;
        echo '        --no-colors   Do not use colors in output (this is the default)' . PHP_EOL;
        echo '        <file>        One or more files and/or directories to check' . PHP_EOL;
        echo '        <fileList>    A file containing a list of files and/or directories to check (one per line)' . PHP_EOL;
        echo '        <stdinPath>   If processing STDIN, the file path that STDIN will be processed as ' . PHP_EOL;
        echo '        <bootstrap>   A comma separated list of files to run before processing starts' . PHP_EOL;
        echo '        <encoding>    The encoding of the files being checked (default is iso-8859-1)' . PHP_EOL;
        echo '        <extensions>  A comma separated list of file extensions to check' . PHP_EOL;
        echo '                      (extension filtering only valid when checking a directory)' . PHP_EOL;
        echo '                      The type of the file can be specified using: ext/type' . PHP_EOL;
        echo '                      e.g., module/php,es/js' . PHP_EOL;
        echo '        <generator>   Uses either the "HTML", "Markdown" or "Text" generator' . PHP_EOL;
        echo '                      (forces documentation generation instead of checking)' . PHP_EOL;
        echo '        <patterns>    A comma separated list of patterns to ignore files and directories' . PHP_EOL;
        echo '        <report>      Print either the "full", "xml", "checkstyle", "csv"' . PHP_EOL;
        echo '                      "json", "emacs", "source", "summary", "diff", "junit"' . PHP_EOL;
        echo '                      "svnblame", "gitblame", "hgblame" or "notifysend" report' . PHP_EOL;
        echo '                      (the "full" report is printed by default)' . PHP_EOL;
        echo '        <reportFile>  Write the report to the specified file path' . PHP_EOL;
        echo '        <reportWidth> How many columns wide screen reports should be printed' . PHP_EOL;
        echo '                      or set to "auto" to use current screen width, where supported' . PHP_EOL;
        echo '        <sniffs>      A comma separated list of sniff codes to include or exclude during checking' . PHP_EOL;
        echo '                      (all sniffs must be part of the specified standard)' . PHP_EOL;
        echo '        <severity>    The minimum severity required to display an error or warning' . PHP_EOL;
        echo '        <standard>    The name or path of the coding standard to use' . PHP_EOL;
        echo '        <tabWidth>    The number of spaces each tab represents' . PHP_EOL;
    }