Merge pull request #804 from xraystyle/feature/list_checks

Implement --list-checks feature, to list the names of all available checks from the cli.

.rubocop_todo.yml

@@ -60,7 +60,7 @@ Metrics/LineLength:
 # Offense count: 65
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
-  Max: 100
+  Max: 105
 
 # Offense count: 18
 Metrics/PerceivedComplexity:

README.md

@@ -45,6 +45,10 @@ puppet-lint --fix /modules
 
 Puppet Lint options allow you to modify which checks to run. You can disable any of the checks temporarily or permanently, or you can limit testing to specific checks.
 
+#### List all available checks
+
+To list all available checks along with basic usage documentation, use the `--list-checks` option.
+
 #### Run specific checks
 
 To run only specific checks, use the `--only-checks` option, with a comma-separated list of arguments specifying which checks to make:
@@ -65,7 +69,7 @@ You can disable specific Lint checks on the command line, disable them permanent
 
 #### Disable checks on the command line
 
-To disable any of the checks when running the `puppet-lint` command, add a `--no-<check name>-check` flag to the command. For example, to skip the 140-character check, run:
+To disable any of the checks when running the `puppet-lint` command, add a `--no-<check_name>-check` flag to the command. For example, to skip the 140-character check, run:
 
 ```
 puppet-lint --no-140chars-check modules/

lib/puppet-lint/bin.rb

@@ -33,6 +33,11 @@ def run
       return 0
     end
 
+    if PuppetLint.configuration.list_checks
+      puts PuppetLint.configuration.checks
+      return 0
+    end
+
     if @args[0].nil?
       puts 'puppet-lint: no file specified'
       puts "puppet-lint: try 'puppet-lint --help' for more information"

lib/puppet-lint/optparser.rb

@@ -99,6 +99,10 @@ def self.build(args)
         PuppetLint.configuration.json = true
       end
 
+      opts.on('--list-checks', 'List available check names.') do
+        PuppetLint.configuration.list_checks = true
+      end
+
       opts.separator('')
       opts.separator('    Checks:')
 

spec/puppet-lint/bin_spec.rb

@@ -55,6 +55,19 @@ def initialize(args)
     its(:stdout) { is_expected.to eq("puppet-lint #{PuppetLint::VERSION}") }
   end
 
+  context 'when asked to display available checks' do
+    let(:args) { '--list-checks' }
+    all_checks = PuppetLint.configuration.checks.map(&:to_s)
+
+    its(:exitstatus) { is_expected.to eq(0) }
+
+    all_checks.each do |c|
+      it "includes check #{c} in its output" do
+        expect(subject.stdout).to include c
+      end
+    end
+  end
+
   context 'when passed a backslash separated path on Windows', :if => Gem.win_platform? do
     let(:args) do
       [