Skip to content

Latest commit

 

History

History
70 lines (48 loc) · 3.71 KB

README.md

File metadata and controls

70 lines (48 loc) · 3.71 KB
Raw

Installation

License Test codecov Release RubyGem Version RubyGem Downloads Donated by Daniel Thorn

A puppet-lint plugin to validate Puppet DSL indentation

Usage

This plugin provides an indentation check for puppet-lint strict_indent. The check has a strict expectation for all indentation, except comments and whitespace/blank lines.

supports --fix flag

Check will raise a warning for any files that don't have 2-space indent, and follow specific guidelines for increase/decrease of indent.

Alternate Indentation

Indentation defaults to 2 spaces. To use a different number of spaces, use the -l option to load ruby file changing the chars_per_indent config.

config file chars_per_indent_4.rb:

# This could also be set in your Rakefile
PuppetLint.configuration.chars_per_indent = 4

lint command:

puppet-lint -l chars_per_indent_4.rb puppet-mysql/manifests/init.pp

Acceptable Identation

  • indent should increase by one step the line after each opened brace (square, curly, paren)
  • indent should decrease by one step the line of every closed brace.
  • indent should increase by one step the line after a resource title, unless it already increased due to a bracket.
  • indent should decrease by one step the line after the end of a resource due to semicolon, if it was indented for resource title.
  • indent should decrease by one step the line of the end of a resource due to right curly brace, if it was indented for resource title, and not ended by a semicolon.
  • indent should increase by one step the line after an equals = or farrow => that ends a line, but only for that one line.

see spec/fixtures/pass/ for good indentation examples.

see spec/fixtures/fail/ for bad indentation examples.

Transfer Notice

This plugin was originally authored by Daniel Thorn. The maintainer preferred that Vox Pupuli take ownership of the module for future improvement and maintenance. Existing pull requests and issues were transferred over, please fork and continue to contribute at https://github.com/voxpupuli/puppet-lint-strict_indent-check.

Previously: https://github.com/relud/puppet-lint-strict_indent-check

License

This gem is licensed under the Mozilla Public license 2.

Release information

To make a new release, please do:

  • update the version in the gemspec file
  • Install gems with bundle install --with release --path .vendor
  • generate the changelog with bundle exec rake changelog
  • Check if the new version matches the closed issues/PRs in the changelog
  • Create a PR with it
  • After it got merged, push a tag. GitHub actions will do the actual release to rubygems and GitHub Packages