Parent

Methods

PuppetLint::OptParser

Public: Contains the puppet-lint option parser so that it can be used easily in multiple places.

Constants

HELP_TEXT

Public Class Methods

build() click to toggle source

Public: Initialise a new puppet-lint OptionParser.

Returns an OptionParser object.

# File lib/puppet-lint/optparser.rb, line 20
def self.build
  OptionParser.new do |opts|
    opts.banner = HELP_TEXT

    opts.on('--version', 'Display the current version.') do
      PuppetLint.configuration.display_version = true
    end

    opts.on('-c', '--config FILE', 'Load puppet-lint options from file.') do |file|
      opts.load(file)
    end

    opts.on('--with-context', 'Show where in the manifest the problem is.') do
      PuppetLint.configuration.with_context = true
    end

    opts.on('--with-filename', 'Display the filename before the warning.') do
      PuppetLint.configuration.with_filename = true
    end

    opts.on('--fail-on-warnings', 'Return a non-zero exit status for warnings') do
      PuppetLint.configuration.fail_on_warnings = true
    end

    opts.on('--error-level LEVEL', [:all, :warning, :error],
            'The level of error to return (warning, error or all).') do |el|
      PuppetLint.configuration.error_level = el
    end

    opts.on('--show-ignored', 'Show problems that have been ignored by control comments') do
      PuppetLint.configuration.show_ignored = true
    end

    opts.on('--relative', 'Compare module layout relative to the module root') do
      PuppetLint.configuration.relative = true
    end

    opts.on('-l', '--load FILE', 'Load a file containing custom puppet-lint checks.') do |f|
      load f
    end

    opts.on('-f', '--fix', 'Attempt to automatically fix errors') do
      PuppetLint.configuration.fix = true
    end

    opts.on('--log-format FORMAT',
            'Change the log format.', 'Overrides --with-filename.',
            'The following placeholders can be used:',
            '%{filename} - Filename without path.',
            '%{path}     - Path as provided to puppet-lint.',
            '%{fullpath} - Expanded path to the file.',
            '%{line}     - Line number.',
            '%{column}   - Column number.',
            '%{kind}     - The kind of message (warning, error).',
            '%{KIND}     - Uppercase version of %{kind}.',
            '%{check}    - The name of the check.',
            '%{message}  - The message.'
    ) do |format|
      if format.include?('%{linenumber}')
        $stderr.puts "DEPRECATION: Please use %{line} instead of %{linenumber}"
      end
      PuppetLint.configuration.log_format = format
    end

    opts.separator ''
    opts.separator '    Checks:'

    opts.on('--only-checks CHECKS', 'A comma separated list of checks that should be run') do |checks|
      enable_checks = checks.split(',').map(&:to_sym)
      (PuppetLint.configuration.checks - enable_checks).each do |check|
        PuppetLint.configuration.send("disable_#{check}")
      end
    end

    PuppetLint.configuration.checks.each do |check|
      opts.on("--no-#{check}-check", "Skip the #{check} check.") do
        PuppetLint.configuration.send("disable_#{check}")
      end
    end

    opts.load('/etc/puppet-lint.rc')
    opts.load(File.expand_path('~/.puppet-lint.rc')) if ENV['HOME']
    opts.load('.puppet-lint.rc')
  end
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.