0.02
No commit activity in last 3 years
No release in over 3 years
Parse Puppet modules for classes, defines, parameters and documentation
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

>= 0
< 3.0, >= 2.12.0

Runtime

>= 0
~> 3.12
 Project Readme

puppet-parse

This project is abandoned

Build Status

Analyse puppet manifests and report what classes and defines are specified, and their parameters and parameter documentation.

Installation

gem install puppet-parse

Requirements

rdoc >=3.12, <4.0
facter

Supported Platforms

puppet-parse only works on Unix like platforms such as Linux and MacOSX.

Windows is not supported.

Usage

By hand

You can report on one or more manifests by running

puppet-parse <path(s) to file(s)>

Rake task

If you want to parse your entire modules directory, you can add `require 'puppet-parse/puppet-parse' to your Rakefile and then run

rake parse

If you need to ignore certain paths from being parsed:

PuppetParse.configuration.ignore_paths = ["vendor/**/*.pp"]

Sample Output

--- 
  ntp: 
    parameters: 
      enabled: true
      present: true
      enableboot: true
    docs: 
      enabled: 
        - "Set to 'false' to stop service"
      present: 
        - "Set to 'false' to remove package"
      enableboot: 
        - "Set to 'false' to prevent service starting at boot"

Contributing

You can do any of these:

  1. Create new Pull Request
  2. Create an issue
  3. Write me an email
  4. Complain about how useless my code is on twitter