Added support for default ruleset + file paths in ruleset.xml files

Author: gsherwood

CodeSniffer.php

@@ -702,6 +702,7 @@ public function processRuleset($rulesetPath, $depth=0)
         $ownSniffs      = array();
         $includedSniffs = array();
         $excludedSniffs = array();
+        $cliValues      = $this->cli->getCommandLineValues();
 
         $rulesetDir          = dirname($rulesetPath);
         self::$rulesetDirs[] = $rulesetDir;
@@ -772,7 +773,10 @@ public function processRuleset($rulesetPath, $depth=0)
             }
 
             if (isset($arg['name']) === true) {
-                $argString = '--'.(string) $arg['name'].'='.(string) $arg['value'];
+                $argString = '--'.(string) $arg['name'];
+                if (isset($arg['value']) === true) {
+                    $argString .= '='.(string) $arg['value'];
+                }
             } else {
                 $argString = '-'.(string) $arg['value'];
             }
@@ -783,6 +787,18 @@ public function processRuleset($rulesetPath, $depth=0)
                 echo str_repeat("\t", $depth);
                 echo "\t=> set command line value $argString".PHP_EOL;
             }
+        }//end foreach
+
+        if (empty($cliValues['files']) === true) {
+            // Process hard-coded file paths.
+            foreach ($ruleset->{'file'} as $file) {
+                $file      = (string) $file;
+                $cliArgs[] = $file;
+                if (PHP_CODESNIFFER_VERBOSITY > 1) {
+                    echo str_repeat("\t", $depth);
+                    echo "\t=> added \"$file\" to the file list".PHP_EOL;
+                }
+            }
         }
 
         if (empty($cliArgs) === false) {

CodeSniffer/CLI.php

@@ -825,21 +825,6 @@ public function process($values=array())
             exit(0);
         }
 
-        $fileContents = '';
-        if (empty($values['files']) === true) {
-            // Check if they are passing in the file contents.
-            $handle       = fopen('php://stdin', 'r');
-            $fileContents = stream_get_contents($handle);
-            fclose($handle);
-
-            if ($fileContents === '') {
-                // No files and no content passed in.
-                echo 'ERROR: You must supply at least one file or directory to process.'.PHP_EOL.PHP_EOL;
-                $this->printUsage();
-                exit(2);
-            }
-        }
-
         $phpcs = new PHP_CodeSniffer($values['verbosity'], null, null, null);
         $phpcs->setCli($this);
         $phpcs->initStandard($values['standard'], $values['sniffs']);
@@ -880,8 +865,22 @@ public function process($values=array())
 
         $phpcs->processFiles($values['files'], $values['local']);
 
-        if ($fileContents !== '') {
-            $phpcs->processFile('STDIN', $fileContents);
+        if (empty($values['files']) === true) {
+            // Check if they are passing in the file contents.
+            $handle       = fopen('php://stdin', 'r');
+            $fileContents = stream_get_contents($handle);
+            fclose($handle);
+
+            if ($fileContents === '') {
+                // No files and no content passed in.
+                echo 'ERROR: You must supply at least one file or directory to process.'.PHP_EOL.PHP_EOL;
+                $this->printUsage();
+                exit(2);
+            } else {
+                if ($fileContents !== '') {
+                    $phpcs->processFile('STDIN', $fileContents);
+                }
+            }
         }
 
         // Interactive runs don't require a final report and it doesn't really
@@ -997,6 +996,14 @@ public function validateStandard($standards)
     {
         if ($standards === null) {
             // They did not supply a standard to use.
+            // Looks for a ruleset in the current directory.
+            if (empty($this->values['files']) === true) {
+                $default = getcwd().DIRECTORY_SEPARATOR.'ruleset.xml';
+                if (is_file($default) === true) {
+                    return array($default);
+                }
+            }
+
             // Try to get the default from the config system.
             $standard = PHP_CodeSniffer::getConfigData('default_standard');
             if ($standard === null) {

package.xml

@@ -34,6 +34,12 @@ http://pear.php.net/dtd/package-2.0.xsd">
     -- Use the --report-width=auto command line argument to auto-size the reports
     -- Use the command "phpcs --config-set report_width auto" to use auto-sizing by default
   - Reports will now size to fit inside the report width setting instead of always using padding to fill the space
+  - If no files or standards are specified, PHPCS will now look for a ruleset.xml file in the current directory
+    -- This file has the same format as a standard ruleset.xml file
+    -- The ruleset.xml file should specify (at least) files to process and a standard/sniffs to use
+    -- Useful for running the phpcs and phpcbf commands without any arguments at the top of a repository
+  - Default file paths can now be specified in a ruleset.xml file using the "file" tag
+    -- File paths are only processed if no files were specified on the command line
   - Interactive mode no longer breaks if you also specify a report type on the command line
   - PEAR InlineCommentSniff now fixes the Perl-style comments that it finds (request #375)
   - PSR2 standard no longer fixes the placement of docblock open tags as comments are excluded from this standard