phpcs(1) [debian man page]
phpcs(1) General Commands Manual phpcs(1) NAME
phpcs - php code sniffer cli tool SYNOPSIS
phpcs [-nwlsapvi] [-d key[=value]] [--report=<report>] [--report-file=<reportfile>] [--report-<report>=<reportfile>] ... [--report-width=<reportWidth>] [--generator=<generator>] [--tab-width=<tabWidth>] [--severity=<severity>] [--error-severity=<severity>] [--warning-severity=<severity>] [--config-set key value] [--config-delete key] [--config-show] [--standard=<standard>] [--sniffs=<sniffs>] [--encoding=<encoding>] [--extensions=<extensions>] [--ignore=<patterns>] <file> ... DESCRIPTION
phpcs (or PHP_CodeSniffer) is a PHP5 script that tokenises PHP, JavaScript and CSS files to detect violations of a defined coding standard. It is an essential development tool that ensures your code remains clean and consistent. It can also help prevent some common semantic errors made by developers. PARAMETERS
<file> One or more files and/or directories to check <extensions> A comma separated list of file extensions to check (only valid if checking a directory) <patterns> A comma separated list of patterns to ignore files and directories <encoding> The encoding of the files being checked (default is iso-8859-1) <sniffs> A comma separated list of sniff codes to limit the check to (all sniffs must be part of the specified standard) <severity> The minimum severity required to display an error or warning <standard> The name or path of the coding standard to use <tabWidth> The number of spaces each tab represents <generator> The name of a doc generator to use (forces doc generation instead of checking) <report> Print either the "full", "xml", "checkstyle", "csv", "emacs", "source", "summary", "svnblame", "gitblame" or "hgblame" report (the "full" report is printed by default) <reportfile> Write the report to the specified file path <reportWidth> How many columns wide screen reports should be printed OPTION
-n Do not print warnings (shortcut for ---warning-severity=0) -w Print both warnings and errors (on by default) -l Local directory only, no recursion -s Show sniff codes in all reports -a Run interactively -p Show progress of the run -v[v][v] Print verbose output -i Show a list of installed coding standards -d Set the [key] php.ini value to [value] or [true] if -value is omitted --help Print the help message --version Print version information phpcs(1)
Check Out this Related Man Page
Perl::Critic::OptionsProcessor(3) User Contributed Perl Documentation Perl::Critic::OptionsProcessor(3) NAME
Perl::Critic::OptionsProcessor - The global configuration default values, combined with command-line values. DESCRIPTION
This is a helper class that encapsulates the default parameters for constructing a Perl::Critic::Config object. There are no user- serviceable parts here. INTERFACE SUPPORT
This is considered to be a non-public class. Its interface is subject to change without notice. CONSTRUCTOR
" new( %DEFAULT_PARAMS ) " Returns a reference to a new "Perl::Critic::OptionsProcessor" object. You can override the coded defaults by passing in name-value pairs that correspond to the methods listed below. This is usually only invoked by Perl::Critic::UserProfile, which passes in the global values from a .perlcriticrc file. This object contains no information for individual Policies. METHODS
" exclude() " Returns a reference to a list of the default exclusion patterns. If onto by Perl::Critic::PolicyParameter. there are no default exclusion patterns, then the list will be empty. " force() " Returns the default value of the "force" flag (Either 1 or 0). " include() " Returns a reference to a list of the default inclusion patterns. If there are no default exclusion patterns, then the list will be empty. " only() " Returns the default value of the "only" flag (Either 1 or 0). " profile_strictness() " Returns the default value of "profile_strictness" as an unvalidated string. " single_policy() " Returns the default "single-policy" pattern. (As a string.) " severity() " Returns the default "severity" setting. (1..5). " theme() " Returns the default "theme" setting. (As a string). " top() " Returns the default "top" setting. (Either 0 or a positive integer). " verbose() " Returns the default "verbose" setting. (Either a number or format string). " color() " Returns the default "color" setting. (Either 1 or 0). " pager() " Returns the default "pager" setting. (Either empty string or the pager command string). " allow_unsafe() " Returns the default "allow-unsafe" setting. (Either 1 or 0). " criticism_fatal() " Returns the default "criticism-fatal" setting (Either 1 or 0). " color_severity_highest() " Returns the color to be used for coloring highest severity violations. " color_severity_high() " Returns the color to be used for coloring high severity violations. " color_severity_medium() " Returns the color to be used for coloring medium severity violations. " color_severity_low() " Returns the color to be used for coloring low severity violations. " color_severity_lowest() " Returns the color to be used for coloring lowest severity violations. " program_extensions() " Returns a reference to the array of file name extensions to be interpreted as representing Perl programs. SEE ALSO
Perl::Critic::Config, Perl::Critic::UserProfile AUTHOR
Jeffrey Ryan Thalhammer <jeff@imaginative-software.com> COPYRIGHT
Copyright (c) 2005-2011 Imaginative Software Systems. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. The full text of this license can be found in the LICENSE file included with this module. perl v5.16.3 2014-06-09 Perl::Critic::OptionsProcessor(3)