When passing content via STDIN, you can now specify the file path to use on the command line (request #934)

Author: gsherwood

CodeSniffer/CLI.php

@@ -286,6 +286,7 @@ public function getDefaults()
         $defaults['errorSeverity']   = null;
         $defaults['warningSeverity'] = null;
         $defaults['stdin']           = null;
+        $defaults['stdinPath']       = '';
 
         $reportFormat = PHP_CodeSniffer::getConfigData('report_format');
         if ($reportFormat !== null) {
@@ -640,6 +641,13 @@ public function processLongArgument($arg, $pos)
 
                     $this->values['bootstrap'][] = $path;
                 }
+            } else if (substr($arg, 0, 11) === 'stdin-path=') {
+                $this->values['stdinPath'] = PHP_CodeSniffer::realpath(substr($arg, 11));
+
+                // It may not exist and return false instead, so just use whatever they gave us.
+                if ($this->values['stdinPath'] === false) {
+                    $this->values['stdinPath'] = trim(substr($arg, 11));
+                }
             } else if (substr($arg, 0, 12) === 'report-file=') {
                 $this->values['reportFile'] = PHP_CodeSniffer::realpath(substr($arg, 12));
 
@@ -1205,7 +1213,7 @@ public function printUsage()
      */
     public function printPHPCSUsage()
     {
-        echo 'Usage: phpcs [-nwlsaepvi] [-d key[=value]] [--colors] [--no-colors]'.PHP_EOL;
+        echo 'Usage: phpcs [-nwlsaepvi] [-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;
@@ -1228,6 +1236,7 @@ public function printPHPCSUsage()
         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 '        <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;
@@ -1260,7 +1269,7 @@ public function printPHPCSUsage()
      */
     public function printPHPCBFUsage()
     {
-        echo 'Usage: phpcbf [-nwli] [-d key[=value]]'.PHP_EOL;
+        echo 'Usage: phpcbf [-nwli] [-d key[=value]] [--stdin-path=<stdinPath>]'.PHP_EOL;
         echo '    [--standard=<standard>] [--sniffs=<sniffs>] [--suffix=<suffix>]'.PHP_EOL;
         echo '    [--severity=<severity>] [--error-severity=<severity>] [--warning-severity=<severity>]'.PHP_EOL;
         echo '    [--tab-width=<tabWidth>] [--encoding=<encoding>]'.PHP_EOL;
@@ -1274,6 +1283,7 @@ public function printPHPCBFUsage()
         echo '        --version     Print version information'.PHP_EOL;
         echo '        --no-patch    Do not make use of the "diff" or "patch" programs'.PHP_EOL;
         echo '        <file>        One or more files and/or directories to fix'.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 fixed (default is iso-8859-1)'.PHP_EOL;
         echo '        <extensions>  A comma separated list of file extensions to fix'.PHP_EOL;

CodeSniffer/File.php

@@ -459,8 +459,11 @@ public function start($contents=null)
         // If this is standard input, see if a filename was passed in as well.
         // This is done by including: phpcs_input_file: [file path]
         // as the first line of content.
-        if ($this->_file === 'STDIN' && $contents !== null) {
-            if (substr($contents, 0, 17) === 'phpcs_input_file:') {
+        if ($this->_file === 'STDIN') {
+            $cliValues = $this->phpcs->cli->getCommandLineValues();
+            if ($cliValues['stdinPath'] !== '') {
+                $this->_file = $cliValues['stdinPath'];
+            } else if ($contents !== null && substr($contents, 0, 17) === 'phpcs_input_file:') {
                 $eolPos      = strpos($contents, $this->eolChar);
                 $filename    = trim(substr($contents, 17, ($eolPos - 17)));
                 $contents    = substr($contents, ($eolPos + strlen($this->eolChar)));

package.xml

@@ -32,6 +32,9 @@ http://pear.php.net/dtd/package-2.0.xsd">
     -- Absolute paths are still allowed and work the same way they always have
     -- This change allows ruleset.xml files to be more portable
   - Content passed via STDIN will now be processed even if files are specified on the command line or in a ruleset
+  - When passing content via STDIN, you can now specify the file path to use on the command line (request #934)
+    -- This allows sniffs that check file paths to work correctly
+    -- This is the same functionality provided by the phpcs_input_file line, except it is available on the command line
   - Files processed with custom tokenizers will no longer be skipped if they appear minified (request #877)
     -- If the custom tokenizer wants minified files skipped, it can set a $skipMinified member var to TRUE
     -- See the included JS and CSS tokenizers for an example