puppet-lint 2.2.1 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d38c3e980312a05a89ce9927adb0f804a9bb2b3a
-  data.tar.gz: 9ed350e5a31848d582093b528b516c8834250bd8
+  metadata.gz: 5cf7e44161d54a800d685bcfd4cf152f5d8513c9
+  data.tar.gz: dedf83a5d6c65efd93413867bce94c198b622b0c
 SHA512:
-  metadata.gz: 29ed416ab704c80e28e01fff7c024fb92406a5dc091f2ebbd4e247b214b49560aca37e71e03730adfd71846f08c8396122fc4e30d043881e20434a920b43d6ac
-  data.tar.gz: dbf341808a24b94dbaa7e1b01145832b5995f7c197fa651300aac7e38bdb5f688c6f1b57271b9496648bf9604788a278cb522e3679d3e4e4a669b0bfafb85123
+  metadata.gz: 40ae10c6e1b29822cbc3146c9a1fb4dcbfcabacc3d934710d9b7ca654bfdbd3ba45a44186f03b32ff77ba1dbeb147f58131a7fc197e08cccac60f4ec9fa13153
+  data.tar.gz: fb7c37f37510e8d6f6fb100e797e2d002cc539ad08c5bbaddda33c301d077ba09761d71d967692ad95f5de6b8b8e7f9a66d03f1ac12370d9e0b89fb41932effb

data/CHANGELOG.md

@@ -1,10 +1,34 @@
 # Change Log
 
+## [2.3.0](https://github.com/rodjek/puppet-lint/tree/2.3.0) (2017-07-12)
+[Full Changelog](https://github.com/rodjek/puppet-lint/compare/2.2.1...2.3.0)
+
+**Closed issues:**
+
+- Inappropriate =\> Indentation Warning in Hash [\#698](https://github.com/rodjek/puppet-lint/issues/698)
+- Regression: arrow\_alignment check broken between 2.1.1 and 2.2.x releases when left side contains text after variable interpolation [\#697](https://github.com/rodjek/puppet-lint/issues/697)
+- Check `arrow\_on\_right\_operand\_line` is undocumented. [\#688](https://github.com/rodjek/puppet-lint/issues/688)
+
+**Merged pull requests:**
+
+- \(maint\) Fixes puppet-lint json formatting to output valid json to stdout [\#719](https://github.com/rodjek/puppet-lint/pull/719) ([bmjen](https://github.com/bmjen))
+- Permit puppet-lint to load "prerelease" gems [\#718](https://github.com/rodjek/puppet-lint/pull/718) ([kpaulisse](https://github.com/kpaulisse))
+- Document the configuration file better [\#713](https://github.com/rodjek/puppet-lint/pull/713) ([binford2k](https://github.com/binford2k))
+- Replace deprecated plugin with an improved alternative. [\#712](https://github.com/rodjek/puppet-lint/pull/712) ([deanwilson](https://github.com/deanwilson))
+- Readme formatting fixes [\#709](https://github.com/rodjek/puppet-lint/pull/709) ([dbeckham](https://github.com/dbeckham))
+- Readme edit [\#707](https://github.com/rodjek/puppet-lint/pull/707) ([jbondpdx](https://github.com/jbondpdx))
+- Take into account length of DQPOST token when updating column number [\#701](https://github.com/rodjek/puppet-lint/pull/701) ([dbeckham](https://github.com/dbeckham))
+- Add pattern support to rake task [\#700](https://github.com/rodjek/puppet-lint/pull/700) ([dbeckham](https://github.com/dbeckham))
+- Note arrow\_on\_right\_operand\_line in the README [\#690](https://github.com/rodjek/puppet-lint/pull/690) ([rodjek](https://github.com/rodjek))
+- Document the arrow\_on\_right\_operand\_line check on the website [\#689](https://github.com/rodjek/puppet-lint/pull/689) ([rodjek](https://github.com/rodjek))
+- One file per plugin. Fixes \#657 [\#671](https://github.com/rodjek/puppet-lint/pull/671) ([Darhazer](https://github.com/Darhazer))
+
 ## [2.2.1](https://github.com/rodjek/puppet-lint/tree/2.2.1) (2017-03-29)
 [Full Changelog](https://github.com/rodjek/puppet-lint/compare/2.2.0...2.2.1)
 
 **Closed issues:**
 
+- Error on whitespace with 2.2.0 [\#683](https://github.com/rodjek/puppet-lint/issues/683)
 - "undefined method `map' for nil:NilClass" when running check\_whitespace [\#681](https://github.com/rodjek/puppet-lint/issues/681)
 - "undefined method `next\_token='" when fixing with check\_whitespace [\#680](https://github.com/rodjek/puppet-lint/issues/680)
 - Release 2.2.0 planning and discussion [\#668](https://github.com/rodjek/puppet-lint/issues/668)
@@ -19,43 +43,46 @@
 
 **Closed issues:**
 
+- Plugins reorganization: One file per check [\#657](https://github.com/rodjek/puppet-lint/issues/657)
+- 2.1.1 git tag [\#652](https://github.com/rodjek/puppet-lint/issues/652)
+- Quoted boolean triggers on the command 'true' [\#646](https://github.com/rodjek/puppet-lint/issues/646)
+- Namevars detected as optional parameters [\#633](https://github.com/rodjek/puppet-lint/issues/633)
+- 'Duplicate Parameter' warning on dynamic class parameter [\#627](https://github.com/rodjek/puppet-lint/issues/627)
+- arrow\_alignment should only check the alignment of the first arrow on each line [\#609](https://github.com/rodjek/puppet-lint/issues/609)
+- Top-scope variable warning on inline lambda [\#549](https://github.com/rodjek/puppet-lint/issues/549)
+- Puppet-lint crash with new puppet 4 syntax [\#516](https://github.com/rodjek/puppet-lint/issues/516)
+- Top-scope warning when looping though an array of hashes [\#464](https://github.com/rodjek/puppet-lint/issues/464)
+- Array of hashes one-liner throws a "Indentation of =\> is not properly aligned" [\#446](https://github.com/rodjek/puppet-lint/issues/446)
 - Missed bad file modes in file with multiple resource bodies [\#663](https://github.com/rodjek/puppet-lint/issues/663)
 - Provide helper methods to search for specific tokens [\#660](https://github.com/rodjek/puppet-lint/issues/660)
 - ensure\_first\_param fix can create invalid syntax [\#659](https://github.com/rodjek/puppet-lint/issues/659)
 - puppet-lint dies with inline\_template syntax [\#656](https://github.com/rodjek/puppet-lint/issues/656)
 - Variable use like "${$a}" isn't reported as an error and is changed with no message when run with --fix [\#655](https://github.com/rodjek/puppet-lint/issues/655)
 - Linter gets confused with arrays of hashes [\#654](https://github.com/rodjek/puppet-lint/issues/654)
-- 2.1.1 git tag [\#652](https://github.com/rodjek/puppet-lint/issues/652)
 - heredoc throws unhandled exception [\#649](https://github.com/rodjek/puppet-lint/issues/649)
-- Quoted boolean triggers on the command 'true' [\#646](https://github.com/rodjek/puppet-lint/issues/646)
 - Match function breaks puppet-lint [\#645](https://github.com/rodjek/puppet-lint/issues/645)
 - top-scope variable being used without an explicit namespace in a string with a lookup [\#635](https://github.com/rodjek/puppet-lint/issues/635)
 - unquoted file mode & mode should be represented as a 4 digit when file mode is done by a lookup [\#634](https://github.com/rodjek/puppet-lint/issues/634)
-- Namevars detected as optional parameters [\#633](https://github.com/rodjek/puppet-lint/issues/633)
-- 'Duplicate Parameter' warning on dynamic class parameter [\#627](https://github.com/rodjek/puppet-lint/issues/627)
 - double\_quoted\_strings-check issue with escaped character in the string [\#625](https://github.com/rodjek/puppet-lint/issues/625)
 - unable to disable 140chars check with control comments "block" [\#622](https://github.com/rodjek/puppet-lint/issues/622)
-- arrow\_alignment should only check the alignment of the first arrow on each line [\#609](https://github.com/rodjek/puppet-lint/issues/609)
 - unquoted\_node\_name crash when curly braces missing [\#582](https://github.com/rodjek/puppet-lint/issues/582)
 - Heredoc triggers exception in arrow\_alignment check [\#578](https://github.com/rodjek/puppet-lint/issues/578)
 - Each + With = Fake positive top-scope variable detection [\#576](https://github.com/rodjek/puppet-lint/issues/576)
-- Top-scope variable warning on inline lambda [\#549](https://github.com/rodjek/puppet-lint/issues/549)
 - Top-scope variable warning on nested each loops [\#548](https://github.com/rodjek/puppet-lint/issues/548)
-- Puppet-lint crash with new puppet 4 syntax [\#516](https://github.com/rodjek/puppet-lint/issues/516)
 - `arrow\_alignment --fix` doesn't indent keys when introducing line breaks; erroneously reports success [\#506](https://github.com/rodjek/puppet-lint/issues/506)
-- Top-scope warning when looping though an array of hashes [\#464](https://github.com/rodjek/puppet-lint/issues/464)
-- Array of hashes one-liner throws a "Indentation of =\> is not properly aligned" [\#446](https://github.com/rodjek/puppet-lint/issues/446)
 - heredoc escape gives syntax error [\#430](https://github.com/rodjek/puppet-lint/issues/430)
 - NoMethodError when multiple heredocs are used [\#395](https://github.com/rodjek/puppet-lint/issues/395)
 
 **Merged pull requests:**
 
+- Support double quoted strings inside interpolated values in double quoted strings [\#676](https://github.com/rodjek/puppet-lint/pull/676) ([rodjek](https://github.com/rodjek))
+- Check that arrow is on the line of right operand [\#672](https://github.com/rodjek/puppet-lint/pull/672) ([Darhazer](https://github.com/Darhazer))
+- Deal with ruby 1.8.7 gem issues [\#630](https://github.com/rodjek/puppet-lint/pull/630) ([mterzo](https://github.com/mterzo))
+- Plugin review; disable unnecessary plugins [\#567](https://github.com/rodjek/puppet-lint/pull/567) ([rnelson0](https://github.com/rnelson0))
 - Ignore selectors when finding resource type [\#678](https://github.com/rodjek/puppet-lint/pull/678) ([rodjek](https://github.com/rodjek))
 - Fix for arrow\_alignment bugs in \#506 [\#677](https://github.com/rodjek/puppet-lint/pull/677) ([rodjek](https://github.com/rodjek))
-- Support double quoted strings inside interpolated values in double quoted strings [\#676](https://github.com/rodjek/puppet-lint/pull/676) ([rodjek](https://github.com/rodjek))
 - Don't silently remove unnecessary $ from enclosed variables [\#674](https://github.com/rodjek/puppet-lint/pull/674) ([rodjek](https://github.com/rodjek))
 - Fix ensure\_first\_param fix method to retrieve the full value of the ensure parameter [\#673](https://github.com/rodjek/puppet-lint/pull/673) ([rodjek](https://github.com/rodjek))
-- Check that arrow is on the line of right operand [\#672](https://github.com/rodjek/puppet-lint/pull/672) ([Darhazer](https://github.com/Darhazer))
 - Restrict appveyor testing to Ruby versions that appveyor supports [\#670](https://github.com/rodjek/puppet-lint/pull/670) ([james-stocks](https://github.com/james-stocks))
 - Clear expected parameter column after processing each block when checking arrow alignment [\#669](https://github.com/rodjek/puppet-lint/pull/669) ([rodjek](https://github.com/rodjek))
 - Allow regexps to used as function arguments [\#665](https://github.com/rodjek/puppet-lint/pull/665) ([rodjek](https://github.com/rodjek))
@@ -71,10 +98,8 @@
 - Correctly handle nested lambdas [\#637](https://github.com/rodjek/puppet-lint/pull/637) ([hanazuki](https://github.com/hanazuki))
 - Support for nested multiple-variable assignments [\#636](https://github.com/rodjek/puppet-lint/pull/636) ([hanazuki](https://github.com/hanazuki))
 - Add LoadError to fix broken tests [\#631](https://github.com/rodjek/puppet-lint/pull/631) ([davidmogar](https://github.com/davidmogar))
-- Deal with ruby 1.8.7 gem issues [\#630](https://github.com/rodjek/puppet-lint/pull/630) ([mterzo](https://github.com/mterzo))
-- Plugin review; disable unnecessary plugins [\#567](https://github.com/rodjek/puppet-lint/pull/567) ([rnelson0](https://github.com/rnelson0))
 
-## [2.1.1](https://github.com/rodjek/puppet-lint/tree/2.1.1) (2017-02-13)
+## [2.1.1](https://github.com/rodjek/puppet-lint/tree/2.1.1) (2017-02-15)
 [Full Changelog](https://github.com/rodjek/puppet-lint/compare/2.1.0...2.1.1)
 
 **Closed issues:**
@@ -123,8 +148,6 @@
 
 **Merged pull requests:**
 
-- 2.1.0 Release [\#612](https://github.com/rodjek/puppet-lint/pull/612) ([rnelson0](https://github.com/rnelson0))
-- Puppet-lint version bump to 2.1.0.pre [\#608](https://github.com/rodjek/puppet-lint/pull/608) ([rnelson0](https://github.com/rnelson0))
 - Ignore \*.pp files at the top level [\#597](https://github.com/rodjek/puppet-lint/pull/597) ([rnelson0](https://github.com/rnelson0))
 - Show logs in rspec tests [\#596](https://github.com/rodjek/puppet-lint/pull/596) ([ghoneycutt](https://github.com/ghoneycutt))
 - Count lines in comments and double quoted strings [\#577](https://github.com/rodjek/puppet-lint/pull/577) ([paran1](https://github.com/paran1))
@@ -163,7 +186,6 @@
 
 **Merged pull requests:**
 
-- Release 2.0.2 [\#536](https://github.com/rodjek/puppet-lint/pull/536) ([rnelson0](https://github.com/rnelson0))
 - Revert "Bugfix: properly handling $gronk-$grouik with --fix \(fix \#442\)" [\#535](https://github.com/rodjek/puppet-lint/pull/535) ([rnelson0](https://github.com/rnelson0))
 
 ## [2.0.1](https://github.com/rodjek/puppet-lint/tree/2.0.1) (2016-08-18)
@@ -223,7 +245,6 @@
 **Merged pull requests:**
 
 - Continue supporting Ruby \< 2 [\#529](https://github.com/rodjek/puppet-lint/pull/529) ([ghoneycutt](https://github.com/ghoneycutt))
-- Release 2.0.1 [\#528](https://github.com/rodjek/puppet-lint/pull/528) ([rnelson0](https://github.com/rnelson0))
 - Use underscores instead of CamelCase in example [\#527](https://github.com/rodjek/puppet-lint/pull/527) ([ghoneycutt](https://github.com/ghoneycutt))
 - new linter for top\_scope\_facts [\#526](https://github.com/rodjek/puppet-lint/pull/526) ([mmckinst](https://github.com/mmckinst))
 - \(GH462\) Multi-line comments can now be fixed. [\#525](https://github.com/rodjek/puppet-lint/pull/525) ([rnelson0](https://github.com/rnelson0))
@@ -822,4 +843,4 @@ If the additional gems you use for checks are pinned to 1.x, you should pin pupp
 ## [0.0.1](https://github.com/rodjek/puppet-lint/tree/0.0.1) (2011-08-15)
 
 
-\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
+\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

data/README.md

@@ -1,242 +1,262 @@
-# Puppet-lint
+# Puppet Lint
 
 [![Build
 Status](https://secure.travis-ci.org/rodjek/puppet-lint.png)](http://travis-ci.org/rodjek/puppet-lint)
 [![Inline docs](http://inch-ci.org/github/rodjek/puppet-lint.png?branch=master)](http://inch-ci.org/github/rodjek/puppet-lint)
 
-Puppet Lint will test modules and manifests against the recommended Puppet
-style guidelines from the [Puppet Labs style
-guide](http://docs.puppetlabs.com/guides/style_guide.html) as closely as practical. It is not meant to validate syntax. Please use `puppet parser validate` for that.
+Puppet Lint tests Puppet code against the recommended [Puppet language style
+guide](http://docs.puppet.com/puppet/latest/style_guide.html). Puppet Lint validates only code style; it does not validate syntax. To test syntax, use Puppet's `puppet parser validate` command.
+
+## Compatibility warning
+
+Puppet Lint version 2 is the last planned version with support for Puppet 3 and Ruby 1.8.7. The next major version of Puppet Lint will drop support for these versions.
 
 ## Installation
 
-    gem install puppet-lint
+Install the Puppet Lint gem by running:
 
-## Usage
+```
+gem install puppet-lint
+```
 
-### By hand
+## Testing with Puppet Lint
 
-You can test a single manifest file by running
+To test manifests for correct Puppet style, run the `puppet-lint` command with the path to the files you want to test.
 
-    puppet-lint <path to file>
+For example:
 
-Puppet Lint has a large number of options to modify which checks should be run.
+```
+puppet-lint ~/modules/puppetlabs-java/manifests/init.pp
+```
 
-You can disable any of the checks when running the `puppet-lint` command by
-adding a `--no-<check name>-check` flag to the command.  For example, if you
-wanted to skip the 140 character check, you would run
-```  
-    puppet-lint --no-140chars-check <path to file>
 ```
+puppet-lint ~/modules/puppetlabs-mysql/manifests
+```
+
+### Fix issues automatically
+
+To instruct Lint to automatically fix any issues that it detects, use the `--fix` flag:
 
-You can also instruct puppet-lint to automatically fix issues it detects with the `--fix` flag.
 ```
-    puppet-lint --fix /modules
+puppet-lint --fix /modules
 ```
 
-Note that this can be combined with the `--only-checks` option to help avoid enormous patch sets.
+### Modify which checks to run
+
+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.
+
+#### 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:
+
 ```
-    puppet-lint --only-checks trailing_whitespace --fix modules/
+puppet-lint --only-checks trailing_whitespace,140chars modules/
 ```
 
-You can also use [control comments](http://puppet-lint.com/controlcomments/) to disable checks
-within puppet code on a per line or per block basis using `#lint:ignore:<check_name>`:
+To avoid enormous patch sets when using the `--fix` flag, use the `--only-checks` option to limit which checks Puppet Lint makes:
+
 ```
-    class foo {
-      $bar = 'bar'
-      # This ignores the double_quoted_strings check over multiple lines
-      # lint:ignore:double_quoted_strings
-      $baz = "baz"
-      $gronk = "gronk"
-      # lint:endignore
-
-      # This ignores the 140chars check on a single line
-      $this_line_has_a_really_long_name_and_value_that_is_much_longer_than_the_style_guide_recommends = "I mean, a really, really long line like you can't believe" # lint:ignore:140chars
-    }
+puppet-lint --only-checks trailing_whitespace --fix modules/
 ```
 
-See puppet-lint --help for a full list of options.
+### Disable Lint checks
 
-### Rake
+You can disable specific Lint checks on the command line, disable them permanently with a configuration file, or disable them with control comments within your Puppet code.
 
-If you want to test your entire Puppet manifest directory, you can add
-`require 'puppet-lint/tasks/puppet-lint'` to your Rakefile and then run
+#### Disable checks on the command line
 
-    rake lint
+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:
 
-If you want to modify the default behaviour of the rake task, you can modify
-the PuppetLint configuration by defining the task yourself.
+```
+puppet-lint --no-140chars-check modules/
+```
+
+#### Disable checks within Puppet code
 
-    PuppetLint::RakeTask.new :lint do |config|
-      # Pattern of files to check, defaults to `**/*.pp`
-      config.pattern = 'modules'
+To disable checks from within your Puppet code itself, use [control comments](http://puppet-lint.com/controlcomments/). Disable checks on either a per-line or per-block basis using `#lint:ignore:<check_name>`.
 
-      # Pattern of files to ignore
-      config.ignore_paths = ['modules/apt', 'modules/stdlib']
+For example:
 
-      # List of checks to disable
-      config.disable_checks = ['documentation', '140chars']
+```puppet
+class foo {
+  $bar = 'bar'
 
-      # Should puppet-lint prefix it's output with the file being checked,
-      # defaults to true
-      config.with_filename = false
+  # This ignores the double_quoted_strings check over multiple lines
 
-      # Should the task fail if there were any warnings, defaults to false
-      config.fail_on_warnings = true
+  # lint:ignore:double_quoted_strings
+  $baz = "baz"
+  $gronk = "gronk"
+  # lint:endignore
 
-      # Format string for puppet-lint's output (see the puppet-lint help output
-      # for details
-      config.log_format = '%{filename} - %{message}'
+  # This ignores the 140chars check on a single line
 
-      # Print out the context for the problem, defaults to false
-      config.with_context = true
+  $this_line_has_a_really_long_name_and_value_that_is_much_longer_than_the_style_guide_recommends = "I mean, a really, really long line like you can't believe" # lint:ignore:140chars
+}
+```
 
-      # Enable automatic fixing of problems, defaults to false
-      config.fix = true
+## Configuration file
 
-      # Show ignored problems in the output, defaults to false
-      config.show_ignored = true
+Each time Puppet Lint starts up, it loads configuration from three files in order:
 
-      # Compare module layout relative to the module root
-      config.relative = true
-    end
+1. `/etc/puppet-lint.rc`
+1. `~/.puppet-lint.rc`
+1. `.puppet-lint.rc`
 
-### Settings
+This means that a flag in the local `.puppet-lint.rc` will take precedence over a flag in the global `/etc/puppet-lint.rc`, for example. Flags specified on the command line take final precedence and override all config file options.
 
-puppet-lint will also check for a `.puppet-lint.rc` file in the current
-directory and your home directory and read in flags from there, so if you
-wanted to always skip the hard tab character check, you could create
-`~/.puppet-lint.rc` containing
+Any flag that can be specified on the command line can also be specified in the configuration file. For example, to always skip the hard tab character check, create `~/.puppet-lint.rc` and include the line:
 
 ```
 --no-hard_tabs-check
 ```
 
-## Compatibility Warning
+Or to specify a whitelist of allowed checks, include a line like:
 
-Release 2.1.0 of puppet-lint is the last planned version with support for Puppet 3 and Ruby 1.8.7. Future versions will drop support for these versions.
+```
+--only-checks=trailing_whitespace,hard_tabs,duplicate_params,double_quoted_strings,unquoted_file_mode,only_variable_string,variables_not_enclosed,single_quote_string_with_variables,variable_contains_dash,ensure_not_symlink_target,unquoted_resource_title,relative_classname_inclusion,file_mode,resource_reference_without_title_capital,leading_zero,arrow_alignment,variable_is_lowercase,ensure_first_param,resource_reference_without_whitespace,file_ensure,trailing_comma,leading_zero
+```
 
-## Implemented Tests
+## Testing with Puppet Lint as a Rake task
 
-At the moment, the following tests have been implemented:
+To test your entire Puppet manifest directory, add `require 'puppet-lint/tasks/puppet-lint'` to your Rakefile and then run:
 
-### Spacing, Indentation & Whitespace
+```
+rake lint
+```
 
- * Must use two-space soft tabs.
- * Must not use literal tab characters.
- * Must not contain trailing white space.
- * Should not exceed an 140 character line width
-   * An exception has been made for `source => 'puppet://...'` lines as
-     splitting these over multiple lines decreases the readability of the
-     manifests.
- * Should align arrows (`=>`) within blocks of attributes.
+To modify the default behaviour of the Rake task, modify the Puppet Lint configuration by defining the task yourself. For example:
 
-### Quoting
+```ruby
+PuppetLint::RakeTask.new :lint do |config|
+  # Pattern of files to check, defaults to `**/*.pp`
+  config.pattern = 'modules'
 
- * All strings that do not contain variables should be enclosed in single
-   quotes.
-   * An exception has been made for double quoted strings containing \n or \t.
- * All strings that contain variables must be enclosed in double quotes.
- * All variables should be enclosed in braces when interpolated in a string.
- * Variables standing by themselves should not be quoted.
+  # Pattern of files to ignore
+  config.ignore_paths = ['modules/apt', 'modules/stdlib']
 
-### Capitalization
- * All variables should be in lowercase
+  # List of checks to disable
+  config.disable_checks = ['documentation', '140chars']
 
-### Resources
+  # Should puppet-lint prefix it's output with the file being checked,
+  # defaults to true
+  config.with_filename = false
 
- * All resource titles should be quoted.
-   * An exception has been made for resource titles that consist of only
-     a variable standing by itself.
- * If a resource declaration includes an `ensure` attribute, it should be the
-   first attribute specified.
- * Symbolic links should be declared by using an ensure value of `link` and
-   explicitly specifying a value for the `target` attribute.
- * File modes should be represented as a 4 digit string enclosed in single
-   quotes or use symbolic file modes.
+  # Should the task fail if there were any warnings, defaults to false
+  config.fail_on_warnings = true
 
-### Conditionals
+  # Format string for puppet-lint's output (see the puppet-lint help output
+  # for details
+  config.log_format = '%{filename} - %{message}'
 
- * You should not intermingle conditionals inside resource declarations (i.e.
-   selectors inside resources).
- * Case statements should have a default case.
+  # Print out the context for the problem, defaults to false
+  config.with_context = true
 
-### Classes
+  # Enable automatic fixing of problems, defaults to false
+  config.fix = true
 
- * Relationship declarations with the chaining syntax should only be used in
-   the 'left to right' direction.
- * Classes should not be defined inside a class.
- * Defines should not be defined inside a class.
- * Classes should not inherit between namespaces.
- * Required parameters in class & defined type definitions should be listed
-   before optional parameters.
- * When using top-scope variables, including facts, Puppet modules should
-   explicitly specify the empty namespace.
+  # Show ignored problems in the output, defaults to false
+  config.show_ignored = true
 
-## Disabling checks
+  # Compare module layout relative to the module root
+  config.relative = true
+end
+```
 
-### puppet-lint
+### Disable checks in the Lint Rake task
 
-You can disable any of the checks when running the `puppet-lint` command by
-adding a `--no-<check name>-check` flag to the command.  For example, if you
-wanted to skip the 140 character check, you would run
+You can also disable checks when running Puppet Lint through the supplied Rake task by modifying your `Rakefile`.
 
-```
-puppet-lint --no-140chars-check /path/to/my/manifest.pp
-```
+* To disable a check, add the following line after the `require` statement in your `Rakefile`:
 
-puppet-lint will also check for a `.puppet-lint.rc` file in the current
-directory and your home directory and read in flags from there, so if you
-wanted to always skip the hard tab character check, you could create
-`~/.puppet-lint.rc` containing
+  ```ruby
+  PuppetLint.configuration.send("disable_<check name>")
+  ```
 
-```
---no-hard_tabs-check
-```
+  For example, to disable the 140-character check, add:
 
-For a list of all the flags just type:
+  ```ruby
+  PuppetLint.configuration.send("disable_140chars")
+  ```
 
-```
-puppet-lint --help
-```
+* To set the Lint Rake task to ignore certain paths:
 
-### Rake task
+  ```ruby
+  PuppetLint.configuration.ignore_paths = ["vendor/**/*.pp"]
+  ```
 
-You can also disable checks when running puppet-lint through the supplied Rake
-task.  Simply add the following line after the `require` statement in your
-`Rakefile`.
+* To set a pattern of files that Lint should check:
 
-``` ruby
-PuppetLint.configuration.send("disable_<check name>")
-```
+  ```ruby
+  # Defaults to `**/*.pp`
+  PuppetLint.configuration.pattern = "modules"
+  ```
 
-So, to disable the 140 character check, you would add:
+## Options
 
-``` ruby
-PuppetLint.configuration.send("disable_140chars")
-```
+See `puppet-lint --help` for a full list of command line options and checks.
 
-The Rake task also supports ignoring certain paths
-from being linted:
+## Checks
 
-``` ruby
-PuppetLint.configuration.ignore_paths = ["vendor/**/*.pp"]
-```
+For a complete list of checks, and how to resolve errors on each check, see the Puppet Lint [checks](http://puppet-lint.com/checks/) page.
+
+### Spacing, Indentation, and Whitespace
+
+* Must use two-space soft tabs.
+* Must not use literal tab characters.
+* Must not contain trailing white space.
+* Should not exceed an 140-character line width.
+  * An exception has been made for `source => 'puppet://...'` lines as splitting these over multiple lines decreases the readability of the manifests.
+* Should align arrows (`=>`) within blocks of attributes.
+
+### Quoting
+
+* All strings that do not contain variables should be enclosed in single quotes.
+  * An exception has been made for double-quoted strings containing \n or \t.
+* All strings that contain variables must be enclosed in double quotes.
+* All variables should be enclosed in braces when interpolated in a string.
+* Variables standing by themselves should not be quoted.
+
+### Capitalization
+
+* All variables should be in lowercase.
+
+### Resources
+
+* All resource titles should be quoted.
+  * An exception has been made for resource titles that consist of only a variable standing by itself.
+* If a resource declaration includes an `ensure` attribute, it should be the first attribute specified.
+* Symbolic links should be declared by using an ensure value of `link` and explicitly specifying a value for the `target` attribute.
+* File modes should be represented as a 4-digit string enclosed in single quotes or use symbolic file modes.
+
+### Conditionals
+
+* You should not intermingle conditionals inside resource declarations (that is, selectors inside resources).
+* Case statements should have a default case.
+
+### Classes
+
+* Relationship declarations with the chaining syntax should only be used in the 'left to right' direction.
+* Classes should not be defined inside a class.
+* Defines should not be defined inside a class.
+* Classes should not inherit between namespaces.
+* Required parameters in class & defined type definitions should be listed before optional parameters.
+* When using top-scope variables, including facts, Puppet modules should explicitly specify the empty namespace.
+* Chaining operators should appear on the same line as the right hand operand.
 
 ## Reporting bugs or incorrect results
 
-If you find a bug in puppet-lint or its results, please create an issue in the
-[repo issues tracker](https://github.com/rodjek/puppet-lint/issues/).  Bonus
+If you find a bug in Puppet Lint or its results, please create an issue in the
+[repo issues tracker](https://github.com/rodjek/puppet-lint/issues/). Bonus
 points will be awarded if you also include a patch that fixes the issue.
 
-## Thank You
+## Thank you
 
 Many thanks to the following people for contributing to puppet-lint
 
- * James Turnbull (@kartar)
- * Jan Vansteenkiste (@vStone)
- * Julian Simpson (@simpsonjulian)
- * S. Zachariah Sprackett (@zsprackett)
+* James Turnbull (@kartar)
+* Jan Vansteenkiste (@vStone)
+* Julian Simpson (@simpsonjulian)
+* S. Zachariah Sprackett (@zsprackett)
 
 As well as the many people who have reported the issues they've had!
 
@@ -244,21 +264,8 @@ As well as the many people who have reported the issues they've had!
 
 Copyright (c) 2011-2016 Tim Sharpe
 
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.