puppet-strings 2.4.0 → 2.5.0

data/lib/puppet-strings/yard/templates/default/puppet_data_type/html/method_details_list.erb

@@ -0,0 +1,6 @@
+<h2>Data Type Functions</h2>
+<% method_listing.each_with_index do |meth, i| %>
+  <div id="<%= meth.name %>-instance_method"><h3><%= meth.name %></h3>
+  <%= yieldall :object => meth, :owner => object, :index => i %>
+  </div>
+<% end %>

data/lib/puppet-strings/yard/templates/default/puppet_data_type/html/setup.rb

@@ -1,5 +1,13 @@
 # Initializes the template.
 # @return [void]
 def init
-  sections :header, :box_info, :summary, :overview, :note, :todo, T('tags'), :source
+  sections :header, :box_info, :summary, :overview, :note, :todo, T('tags'), :method_details_list, [T('method_details')], :source
+end
+
+def method_listing
+  sort_listing(object.functions)
+end
+
+def sort_listing(list)
+  list.sort_by {|o| [o.scope.to_s, o.name.to_s.downcase] }
 end

data/lib/puppet-strings/yard/templates/default/puppet_type/html/setup.rb

@@ -16,7 +16,9 @@ end
 def properties
   # Properties are the same thing as parameters (from the documentation standpoint),
   # so reuse the same template but with a different title and data source.
-  @parameters = object.properties || []
+  #
+  # "checks" such as "creates" and "onlyif" are another type of property
+  @parameters = (object.properties || []) + (object.checks || [])
   @parameters.sort_by! { |p| p.name }
   @tag_title = 'Properties'
   erb(:parameters)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-strings
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Puppet Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-20 00:00:00.000000000 Z
+date: 2020-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -50,16 +50,10 @@ extra_rdoc_files:
 - README.md
 files:
 - CHANGELOG.md
-- CODEOWNERS
 - COMMITTERS.md
 - CONTRIBUTING.md
-- Gemfile
-- HISTORY.md
-- JSON.md
 - LICENSE
 - README.md
-- Rakefile
-- codecov.yml
 - lib/puppet-strings.rb
 - lib/puppet-strings/describe.rb
 - lib/puppet-strings/json.rb
@@ -82,6 +76,7 @@ files:
 - lib/puppet-strings/markdown/table_of_contents.rb
 - lib/puppet-strings/markdown/templates/classes_and_defines.erb
 - lib/puppet-strings/markdown/templates/data_type.erb
+- lib/puppet-strings/markdown/templates/data_type_function.erb
 - lib/puppet-strings/markdown/templates/function.erb
 - lib/puppet-strings/markdown/templates/puppet_task.erb
 - lib/puppet-strings/markdown/templates/resource_type.erb
@@ -157,6 +152,7 @@ files:
 - lib/puppet-strings/yard/templates/default/puppet_class/html/todo.erb
 - lib/puppet-strings/yard/templates/default/puppet_data_type/html/box_info.erb
 - lib/puppet-strings/yard/templates/default/puppet_data_type/html/header.erb
+- lib/puppet-strings/yard/templates/default/puppet_data_type/html/method_details_list.erb
 - lib/puppet-strings/yard/templates/default/puppet_data_type/html/note.erb
 - lib/puppet-strings/yard/templates/default/puppet_data_type/html/overview.erb
 - lib/puppet-strings/yard/templates/default/puppet_data_type/html/setup.rb
@@ -227,44 +223,6 @@ files:
 - lib/puppet/face/strings.rb
 - lib/puppet/feature/rgen.rb
 - lib/puppet/feature/yard.rb
-- misc/ANNOUNCEMENT_TEMPLATE.md
-- spec/acceptance/emit_json_options_spec.rb
-- spec/acceptance/generate_markdown_spec.rb
-- spec/acceptance/running_strings_generate_spec.rb
-- spec/fixtures/acceptance/modules/test/functions/add.pp
-- spec/fixtures/acceptance/modules/test/lib/puppet/functions/4x_function.rb
-- spec/fixtures/acceptance/modules/test/lib/puppet/parser/functions/function3x.rb
-- spec/fixtures/acceptance/modules/test/lib/puppet/provider/server/linux.rb
-- spec/fixtures/acceptance/modules/test/lib/puppet/type/database.rb
-- spec/fixtures/acceptance/modules/test/manifests/init.pp
-- spec/fixtures/acceptance/modules/test/manifests/triple_nested_classes.pp
-- spec/fixtures/acceptance/modules/test/metadata.json
-- spec/fixtures/acceptance/modules/test/types/elephant.pp
-- spec/fixtures/unit/markdown/output.md
-- spec/fixtures/unit/markdown/output_with_data_types.md
-- spec/fixtures/unit/markdown/output_with_plan.md
-- spec/spec_helper.rb
-- spec/spec_helper_acceptance.rb
-- spec/spec_helper_acceptance_local.rb
-- spec/unit/puppet-strings/describe_spec.rb
-- spec/unit/puppet-strings/json_spec.rb
-- spec/unit/puppet-strings/markdown/base_spec.rb
-- spec/unit/puppet-strings/markdown_spec.rb
-- spec/unit/puppet-strings/yard/code_objects/task_spec.rb
-- spec/unit/puppet-strings/yard/handlers/json/task_handler_spec.rb
-- spec/unit/puppet-strings/yard/handlers/puppet/class_handler_spec.rb
-- spec/unit/puppet-strings/yard/handlers/puppet/data_type_alias_handler_spec.rb
-- spec/unit/puppet-strings/yard/handlers/puppet/defined_type_handler_spec.rb
-- spec/unit/puppet-strings/yard/handlers/puppet/function_handler_spec.rb
-- spec/unit/puppet-strings/yard/handlers/ruby/data_type_handler_spec.rb
-- spec/unit/puppet-strings/yard/handlers/ruby/function_handler_spec.rb
-- spec/unit/puppet-strings/yard/handlers/ruby/provider_handler_spec.rb
-- spec/unit/puppet-strings/yard/handlers/ruby/rsapi_handler_spec.rb
-- spec/unit/puppet-strings/yard/handlers/ruby/type_handler_spec.rb
-- spec/unit/puppet-strings/yard/parsers/json/parser_spec.rb
-- spec/unit/puppet-strings/yard/parsers/json/task_statement_spec.rb
-- spec/unit/puppet-strings/yard/parsers/puppet/parser_spec.rb
-- spec/unit/puppet-strings/yard/util_spec.rb
 homepage: https://github.com/puppetlabs/puppet-strings
 licenses:
 - Apache-2.0

data/CODEOWNERS

@@ -1 +0,0 @@
-* @puppet-strings-maintainers

data/Gemfile

@@ -1,53 +0,0 @@
-source ENV['GEM_SOURCE'] || "https://rubygems.org"
-
-gemspec
-
-gem 'rgen'
-gem 'redcarpet'
-gem 'yard', '~> 0.9.11'
-
-if ENV['PUPPET_GEM_VERSION']
-  gem 'puppet', ENV['PUPPET_GEM_VERSION'], :require => false
-else
-  gem 'puppet', :require => false
-end
-
-group :test do
-  gem 'codecov'
-  gem 'mocha'
-  gem 'puppetlabs_spec_helper'
-  gem 'serverspec'
-  gem 'simplecov-console'
-  gem 'rspec', '~> 3.1'
-  gem 'json_spec', '~> 1.1', '>= 1.1.5'
-end
-
-group :acceptance do
-  # Litmus has dependencies which require Ruby 2.5 (Puppet 6) or above.
-  if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.5.0')
-    # Until https://github.com/puppetlabs/puppet_litmus/pull/248 is merged we need to use the source of the
-    # of the PR.  Not the greatest and prone to error, but without it, all litmus based testing is broken.
-    # This can be reverted once this PR is merged and Litmus is released with this fix.
-    gem 'puppet_litmus', git: 'https://github.com/michaeltlombardi/puppet_litmus', ref: 'maint/master/fix-upload-file'
-    gem 'net-ssh', '~> 5.2'
-  end
-end
-
-group :development do
-  gem 'github_changelog_generator', git: 'https://github.com/skywinder/github-changelog-generator', ref: '20ee04ba1234e9e83eb2ffb5056e23d641c7a018' if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.2.2')
-  gem 'pry'
-  gem 'pry-byebug'
-end
-
-gem 'rubocop-rspec'
-gem 'rubocop', '~> 0.57.2'
-
-# Evaluate Gemfile.local if it exists
-if File.exists? "#{__FILE__}.local"
-  eval(File.read("#{__FILE__}.local"), binding)
-end
-
-# Evaluate ~/.gemfile if it exists
-if File.exists?(File.join(Dir.home, '.gemfile'))
-  eval(File.read(File.join(Dir.home, '.gemfile')), binding)
-end

data/HISTORY.md

@@ -1,218 +0,0 @@
-# Previous Changes
-
-## [2.0.0](https://github.com/puppetlabs/puppet-strings/tree/2.0.0) (2018-05-11)
-
-[Full Changelog](https://github.com/puppetlabs/puppet-strings/compare/1.2.1...2.0.0)
-
-### Changed
-
-- bump required ruby and puppet versions [\#178](https://github.com/puppetlabs/puppet-strings/pull/178) ([eputnam](https://github.com/eputnam))
-
-### Added
-
-- \(PDOC-238\) add generated message to markdown [\#175](https://github.com/puppetlabs/puppet-strings/pull/175) ([eputnam](https://github.com/eputnam))
-- \(PDOC-228\) puppet plan support [\#168](https://github.com/puppetlabs/puppet-strings/pull/168) ([eputnam](https://github.com/eputnam))
-- \(PDOC-206\) support for tasks [\#161](https://github.com/puppetlabs/puppet-strings/pull/161) ([eputnam](https://github.com/eputnam))
-
-### Fixed
-
-- \(PDOC-36\) fix hack for README urls [\#176](https://github.com/puppetlabs/puppet-strings/pull/176) ([eputnam](https://github.com/eputnam))
-- \(PDOC-240\) add handling for :array node type in rsapi\_handler [\#174](https://github.com/puppetlabs/puppet-strings/pull/174) ([eputnam](https://github.com/eputnam))
-- \(PDOC-159\) server urls fix [\#173](https://github.com/puppetlabs/puppet-strings/pull/173) ([eputnam](https://github.com/eputnam))
-- \(maint\) display Plans in markdown table of contents [\#171](https://github.com/puppetlabs/puppet-strings/pull/171) ([eputnam](https://github.com/eputnam))
-- \(PDOC-233\) markdown whitespace fixes [\#170](https://github.com/puppetlabs/puppet-strings/pull/170) ([JohnLyman](https://github.com/JohnLyman))
-- \(PDOC-229\) fix error with return\_type and @return [\#169](https://github.com/puppetlabs/puppet-strings/pull/169) ([eputnam](https://github.com/eputnam))
-- \(PDOC-36\) hack to fix README links in generated HTML [\#167](https://github.com/puppetlabs/puppet-strings/pull/167) ([eputnam](https://github.com/eputnam))
-- \(PDOC-192\) remove warning for title/name [\#166](https://github.com/puppetlabs/puppet-strings/pull/166) ([eputnam](https://github.com/eputnam))
-- \(maint\) add condition for misleading warning [\#155](https://github.com/puppetlabs/puppet-strings/pull/155) ([eputnam](https://github.com/eputnam))
-
-## [1.2.1](https://github.com/puppetlabs/puppet-strings/tree/1.2.1) (2018-03-01)
-
-[Full Changelog](https://github.com/puppetlabs/puppet-strings/compare/1.2.0...1.2.1)
-
-### Fixed
-
-- (PDOC-224) Handle --emit-json(-stdout) again [\#162](https://github.com/puppetlabs/puppet-strings/pull/162) ([ekohl](https://github.com/ekohl))
-
-## [1.2.0](https://github.com/puppetlabs/puppet-strings/tree/1.2.0) (2018-02-26)
-
-[Full Changelog](https://github.com/puppetlabs/puppet-strings/compare/1.1.1...1.2.0)
-
-### Added
-
-- \(PDOC-184\) generate markdown [\#156](https://github.com/puppetlabs/puppet-strings/pull/156) ([eputnam](https://github.com/eputnam))
-- \(PDK-437\) Add support for Resource API types [\#153](https://github.com/puppetlabs/puppet-strings/pull/153) ([DavidS](https://github.com/DavidS))
-
-### Fixed
-
-- Fix return type matching for Puppet functions [\#159](https://github.com/puppetlabs/puppet-strings/pull/159) ([pegasd](https://github.com/pegasd))
-- Add rgen as a runtime dependency [\#149](https://github.com/puppetlabs/puppet-strings/pull/149) ([rnelson0](https://github.com/rnelson0))
-
-## 2017-10-20 - Release 1.1.1
-
-### BugFixes
-- Remove timestamps from footer of generated HTML pages ([GeoffWilliams](https://github.com/GeoffWilliams))
-- Fix argument handling for `rake strings::generate` ([hashar](https://github.com/hashar))
-
-### Other
-- Fixed Markdown formatting issues in CHANGELOG ([maju6406](https://github.com/maju6406))
-- Fixed typo in README ([hfm](https://github.com/hfm))
-- Fixed Markdown formatting issues in README ([gguillotte](https://github.com/gguillotte))
-- Update Travis CI configurations for Ruby and Puppet versions ([ghoneycutt](https://github.com/ghoneycutt))
-
-## 2017-03-20 - Release 1.1.0
-
-### Summary
-
-This release adds a new `summary` tag which can be used to add a short description to classes, functions, types, and providers. In addition, `@param` tags can now include type information in Puppet 4 code without warnings being issued.
-
-All related tickets can be found under the [PDOC](https://tickets.puppetlabs.com/browse/PDOC) JIRA project with the fix version of [1.1.0](https://tickets.puppetlabs.com/issues/?filter=25603).
-
-### Features
-- The `summary` tag can be added to any code that puppet-strings supports. The recommended length limit for a summary is 140 characters. Warnings will be issued for strings longer than this limit.
-- Puppet 4 parameter types can now be explicitly documented. Previously, this was not allowed because Puppet 4 parameter types can be automatically determined without extra documentation. However, users may desire to do so anyway for consistency. Strings will emit a warning if the documented type does not match the actual type. In such an event, the incorrect documented type will be ignored in favor of the real one.
-
-## 2016-11-28 - Release 1.0.0
-
-### Summary
-
-This release fixes up minor bugs from the 0.99.0 release and modifies the JSON schema for Puppet functions.
-
-All related tickets can be found under the [PDOC](https://tickets.puppetlabs.com/browse/PDOC) JIRA project with the fix version of [1.0.0](https://tickets.puppetlabs.com/issues/?filter=23607).
-
-### Features
-- The JSON schema for Puppet functions has been altered to include a new 'signatures' top-level key **(PDOC-125)**
-  - Includes information about all function signatures (overloads). Existing overload key format has been preserved.
-- Reworked README for enhanced clarity **(PDOC-133)**
-
-### BugFixes
-- Fixed an issue where the search box in the code navigator overlapped list items below it **(PDOC-93)**
-- Strings can now handle multiple `defaultfor` calls in Puppet providers **(PDOC-95)**
-- Fixed an issue preventing the generated \_index.html file from being uploaded to GitHub pages via the gh_pages task **(PDOC-120)**
-- Fixed several issues with String's handling of Puppet 3.x and 4.x function return types **(PDOC-135)**, **(PDOC-136)**
-- Fixed an issue where String's didn't properly parse overloads if no summary description was provided **(PDOC-129)**
-- Strings now correctly handles Puppet 3.x functions when the `newfunction` call is on a newline **(PDOC-122)**
-- Fixed an issue where certain Ruby string constructs were incompletely stripped from some docstrings **(PDOC-126)**
-- Hanging indents from type feature descriptions are now properly stripped **(PDOC-127)**
-
-## 2016-10-10 - Release 0.99.0
-
-### Summary
-
-This release includes a complete rewrite of strings, fixing many bugs from previous versions and generally improving the user experience. This release is intended to be the last stop before the strings major version 1.0 is released, and nearly all of the functionality of the major release is included.
-
-All related tickets can be found under the [PDOC][PDOC JIRA] JIRA project with the fix version of [0.99.0](https://tickets.puppetlabs.com/issues/?filter=22705).
-
-### Features
-- Complete overhaul, including code cleanup, bug fixes and new functionality **(PDOC-63)**
-  - Documentation has been split into sections based on type: puppet 3x API functions, puppet 4x API functions, ruby classes, puppet language functions, types, and providers
-  - New JSON schema organized to reflect the separation of types
-  - Support for custom functions written in the puppet language
-  - Support for puppet function overloads via the create_function 4.x API
-  - YARD bumped to latest version, 0.9.5
-- Markdown is now the default format for parsing docstring text **(PDOC-86)**
-  - Note: this means Markdown text in YARD comments and tags, not a change in the output of strings
-- New commandline options: --emit-json and --emit-json-stdout to generate JSON documentation **(PDOC-84)**
-- Runtime dependency on Puppet has been removed, allowing strings to function in Puppet Enterprise 3.8 **(PDOC-80)**
-  - Note that the gem still requires puppet. We recommend that the strings gem be installed with puppet, as suggested in the  [README](https://github.com/puppetlabs/puppet-strings/blob/master/README.md#installing-puppet-strings)
-- New gemspec requirement on Ruby version 1.9.3, the oldest supported Ruby version
-
-### BugFixes
-
-- Prevents a blizzard of errors when documenting Puppet Core source and some puppet modules **(PDOC-63)**
-  - As this is a complete rewrite, many known and unknown bugs from the original code were fixed along the way
-- Allow strings to be installed in PE 3.8 without overwriting existing puppet and facter installations with newer gems
-
-## 2016-03-30 - Release 0.4.0
-
-### Summary
-
-This release adds JSON output support for strings, fixes a major bug that prevented strings from working with the 4.4.0 release of puppet, and is the last version of strings that will be released as a module.
-
-All related tickets can be found under the [PDOC][PDOC JIRA] JIRA project with the fix version of [0.4.0](https://tickets.puppetlabs.com/issues/?filter=18810).
-
-### Features
-- Support for JSON output **(PDOC-23)**
-  - Strings now has the ability to produce a JSON representation of a given puppet module
-  - The details of the JSON schema can be found [here](https://github.com/puppetlabs/puppet-strings/blob/master/json_dom.md)
-  - For details on how to generate JSON, see the [README](https://github.com/puppetlabs/puppet-strings/blob/master/README.md#running-puppet-strings)
-- Migrate to ruby gems as a distribution method **(PDOC-28)**
-  - This is the last release of strings that will be available as a puppet module
-  - The 0.4.0 release will be released concurrently as a ruby gem
-  - After this release, all updates will only be available via the gem
-
-### Bugfixes
-
-- Fix issue that prevented strings from running with Puppet 4.4.0 **(PDOC-75)**
-
-## 2015-09-22 - Release 0.3.1
-
-### Summary
-
-This is a minor bug fix release.
-
-All related tickets can be found under the [PDOC][PDOC JIRA] JIRA project with the fix version of [0.3.1](https://tickets.puppetlabs.com/issues/?filter=15530).
-
-### Bugfixes
-
-- Prevent strings from printing unnecessary quotes in error messages **(PDOC-57)**
-- Issue correct type check warnings for defined types **(PDOC-56)**
-- Allow providers, types, and defines to have the same name **(PDOC-54)**
-
-## 2015-09-21 - Release 0.3.0
-
-### Summary
-
-This release includes support for Puppet Types and Providers, as well as
-type checking Puppet 4x functions and defined types.
-
-All related tickets can be found under the [PDOC][PDOC JIRA] JIRA project with
-the fix version of [0.3.0](https://tickets.puppetlabs.com/issues/?filter=15529).
-
-#### Features
-
-- Support for Puppet Types and Providers **(PDOC-35)**
-- Type check Puppet 4x functions and defined types where possible and warn the user when types don't match.
-  - Type check defined types **(PDOC-21)**
-  - Type check Puppet 4x functions **(PDOC-38)** **(PDOC-19)** **(PDOC-37)**
-  - Output type info in generated HTML **(PDOC-19)**
-- Improved warnings and logging.
-  - Create a consistent style for warnings. **(PDOC-49)**
-  - All warnings get printed on stderr.
-  - Yard warnings are redirected to a log file **(PDOC-38)**
-  - Prevent duplicate warnings **(PDOC-38)**
-- Improved README installation and usage instructions.
-  - Installation instructions using Puppet **(PDOC-33)**
-
-
-#### Bugfixes
-
-- Fix markdown list processing **(PDOC-30)**
-- Fix namespacing for nested classes and defined types **(PDOC-20)**
-
-
-## 2015-03-17 - Release 0.2.0
-
-### Summary
-
-This release includes improvements to the HTML output generated by strings and a few bug fixes.
-All related tickets can be found under the [PDOC][PDOC JIRA] JIRA project with the fix version of [0.2.0](https://tickets.puppetlabs.com/issues/?filter=13760).
-
-[PDOC JIRA]: https://tickets.puppetlabs.com/browse/PDOC
-
-#### Features
-- Custom YARD templates for classes and defined types **(PDOC-17)**
-    - Improved HMTL output that is more appropriate for Puppet code (especially for parameters)
-    - Support for the explicit list of YARD tags we will be supporting initially (@param, @return, @since, @example)
-    - Our own custom YARD templates which can be easily extended and tweaked
-
-- Custom YARD templates for 3.x and 4.x functions **(PDOC-24)**
-    - Improved HMTL output that is more appropriate for listing several functions on one webpage in addition to being more consistent with the HTML produced for classes and defined types.
-    - Support for the explicit list of YARD tags we will be supporting initially (@param, @return, @since, @example)
-    - Our own custom YARD templates which can be easily extended and tweaked
-- Addition of RubCop Travis CI job to ensure code quality and consistency **(PDOC-8)**
-
-#### Bugfixes
-- Puppet namespaces are no longer mangled for nested classes and defined types **(PDOC-25)**
-- Strings is now compatible with the renaming of the Puppetx/puppetx namespace to PuppetX/puppet_x **(PDOC-26)**
-- Strings will no longer crash when documenting 3x functions with less than two arguments passed into newfunction **(PDOC-27)**

data/JSON.md

@@ -1,832 +0,0 @@
-Puppet Strings JSON Data
-========================
-
-Puppet Strings can generate JSON to STDOUT with the `--format` option:
-```shell
-puppet strings generate --format json
-```
-
-Document Schema
-===============
-
-At the top level, there are nine arrays in the JSON document:
-
-| Document Key      | Description                                                                   |
-| ----------------- | ----------------------------------------------------------------------------- |
-| puppet_classes    | The list of Puppet classes that were parsed.                                  |
-| data_types        | The list of data types that were parsed.                                      |
-| data_type_aliases | | The list of data types that were parsed.                                      |
-| defined_types     | The list of defined types that were parsed.                                   |
-| resource_types    | The list of resource types that were parsed.                                  |
-| providers         | The list of resource providers that were parsed.                              |
-| puppet_functions  | The list of Puppet functions (4.x, 4.x and Puppet language) that were parsed. |
-| puppet_tasks      | The list of Puppet tasks that were parsed.                                    |
-| puppet_plans      | The list of Puppet plans that were parsed.                                    |
-
-Puppet Classes
---------------
-
-Each entry in the `puppet_classes` list is an object with the following attributes:
-
-| Attribute Key | Description                                           |
-| ------------- | ----------------------------------------------------- |
-| name          | The name of the Puppet class.                         |
-| file          | The file defining the Puppet class.                   |
-| line          | The line where the Puppet class is defined.           |
-| inherits      | The name of the Puppet class the class inherits from. |
-| docstring     | The *DocString* object for the class (see below).     |
-| defaults      | The map of parameter names to default values.         |
-| source        | The Puppet source code for the class.                 |
-
-Data Types
-----------
-
-Each entry in the `data_types` list is an object with the following attributes:
-
-| Attribute Key | Description                                                 |
-| ------------- | ----------------------------------------------------------- |
-| name          | The name of the data type.                                  |
-| file          | The file defining the data type.                            |
-| line          | The line where the data type is data.                       |
-| docstring     | The *DocString* object for the data type (see below).       |
-| defaults      | The map of parameter names to default values.               |
-| source        | The ruby source code for the data type. (Not Implemented)   |
-
-Data Type Aliases
------------------
-
-Each entry in the `data_type_aliases` list is an object with the following attributes:
-
-| Attribute Key | Description                                                       |
-| ------------- | ----------------------------------------------------------------- |
-| name          | The name of the data type.                                        |
-| file          | The file defining the data type.                                  |
-| line          | The line where the data type is defined.                          |
-| docstring     | The *DocString* object for the data type (see below).             |
-| alias_of      | The actual type this is an alias of.                              |
-| source        | The Puppet source code for the data type alias. (Not Implemented) |
-
-Defined Types
--------------
-
-Each entry in the `defined_types` list is an object with the following attributes:
-
-| Attribute Key | Description                                              |
-| ------------- | -------------------------------------------------------- |
-| name          | The name of the defined type.                            |
-| file          | The file defining the defined type.                      |
-| line          | The line where the defined type is defined.              |
-| docstring     | The *DocString* object for the defined type (see below). |
-| defaults      | The map of parameter names to default values.            |
-| source        | The Puppet source code for the defined type.             |
-
-Resource Types
---------------
-
-Each entry in the `resource_types` list is an object with the following attributes:
-
-| Attribute Key | Description                                               |
-| ------------- | --------------------------------------------------------- |
-| name          | The name of the resource type.                            |
-| file          | The file defining the resource type.                      |
-| line          | The line where the resource type is defined.              |
-| docstring     | The *DocString* object for the resource type (see below). |
-| properties    | The list of properties for the resource type (see below). |
-| parameters    | The list of parameters for the resource type (see below). |
-| features      | The list of features for the resource type (see below).   |
-
-Each entry in the `properties` list is an object with the following attributes:
-
-| Attribute Key | Description                                             |
-| ------------- | ------------------------------------------------------- |
-| name          | The name of the property.                               |
-| description   | The description of the property.                        |
-| values        | The array of acceptable string values for the property. |
-| aliases       | The map of new values aliased to existing values.       |
-| isnamevar     | True if the property is a namevar or false if not.      |
-| default       | The default value for the property.                     |
-
-Each entry in the `parameters` list is an object with the following attributes:
-
-| Attribute Key | Description                                              |
-| ------------- | -------------------------------------------------------- |
-| name          | The name of the parameter.                               |
-| description   | The description of the parameter.                        |
-| values        | The array of acceptable string values for the parameter. |
-| aliases       | The map of new values aliased to existing values.        |
-| isnamevar     | True if the parameter is a namevar or false if not.      |
-| default       | The default value for the parameter.                     |
-
-Each entry in the `features` list is an object with the following attributes:
-
-| Attribute Key | Description                     |
-| ------------- | ------------------------------- |
-| name          | The name of the feature.        |
-| description   | The description of the feature. |
-
-Providers
----------
-
-Each entry in the `providers` list is an object with the following attributes:
-
-| Attribute Key | Description                                          |
-| ------------- | ---------------------------------------------------- |
-| name          | The name of the provider.                            |
-| type_name     | The name of the resource type of the provider.       |
-| file          | The file defining the provider.                      |
-| line          | The line where the provider is defined.              |
-| docstring     | The *DocString* object for the provider (see below). |
-| confines      | The string map of confines for the provider.         |
-| features      | The list of features implemented by the provider.    |
-| defaults      | The list of lists of "default for" for the provider. |
-| commands      | The string map of commands for the provider.         |
-
-Puppet Functions
-----------------
-
-Each entry in the `puppet_functions` list is an object with the following attributes:
-
-| Attribute Key | Description                                                                   |
-| ------------- | ----------------------------------------------------------------------------- |
-| name          | The name of the function.                                                     |
-| file          | The file defining the function.                                               |
-| line          | The line where the function is defined.                                       |
-| type          | The function type (e.g. ruby3x, ruby4x, puppet).                              |
-| signatures    | A list of Puppet signatures of the function, including overloads if present.  |
-| docstring     | The *DocString* object for the function (see below).                          |
-| defaults      | The map of parameter names to default values.                                 |
-| source        | The source code for the function.                                             |
-
-Puppet Tasks
-------------
-
-Each entry in the `puppet_tasks` list is an object with the following attributes:
-
-| Attribute Key | Description                                                                   |
-| ------------- | ----------------------------------------------------------------------------- |
-| name          | The name of the task.                                                         |
-| file          | The file defining the task.                                                   |
-| line          | The line where the task is defined.                                           |
-| docstring     | The *DocString* object for the task (see below).                              |
-| source        | The source code for the task.                                                 |
-| supports_noop | Whether the task supports noop mode                                           |
-| input_method  | Maps to the `input_method` key in the task json                               |
-
-Puppet Plans
-------------
-
-Each entry in the `puppet_plans` list is an object with the following attributes:
-
-| Attribute Key | Description                                                                   |
-| ------------- | ----------------------------------------------------------------------------- |
-| name          | The name of the plan.                                                         |
-| file          | The file defining the plan.                                                   |
-| line          | The line where the plan is defined.                                           |
-| docstring     | The *DocString* object for the plan (see below).                              |
-| defaults      | The map of parameter names to default values.                                 |
-| source        | The source code for the plan.                                                 |
-
-Signature Objects
------------------
-
-The `signatures` key is a function-specific list containing an object for each signature of a
-function. Each object includes the `signature` itself, as well as each of its `param` and `return`
-tags. Puppet 4.x functions with overloads will contain multiple signatures, while other function
-types will contain only one.
-
-Each signature is represented as an object with the following attributes:
-
-| Attribute Key | Description                                                                                        |
-| ------------- | -------------------------------------------------------------------------------------------------- |
-| signature     | The signature of the function.                                                                     |
-| docstring     | The *DocString* object describing the signature, which includes `text`, `param` and `return` tags. |
-
-DocString Objects
------------------
-
-For the above types, their docstrings are represented as an object with the following attributes:
-
-| Attribute Key | Description                                         |
-| ------------- | --------------------------------------------------- |
-| text          | The textual part of the DocString.                  |
-| tags          | The array of tag objects, if any are present.       |
-
-Each entry in the `tags` list is an object with the following properties:
-
-| Attribute Key | Description                                             |
-| ------------- | ------------------------------------------------------- |
-| tag_name      | The name of the tag (e.g. param, return, etc.).         |
-| text          | The descriptive text of the tag.                        |
-| types         | The array of types associated with the tag.             |
-| name          | The name associated with the tag (e.g. parameter name). |
-
-For Puppet 4.x functions with overloads, `overload` tags will contain three additional attributes:
-
-| Attribute Key | Description                                     |
-| ------------- | ----------------------------------------------- |
-| signature     | The Puppet signature of the overload.           |
-| docstring     | The *DocString* object describing the overload. |
-| defaults      | The map of parameter names to default values.   |
-
-
-Example JSON Document
----------------------
-
-An example JSON document describing a Puppet class, defined type, resource type, provider, and Puppet functions:
-
-```json
-{
-  "puppet_classes": [
-    {
-      "name": "foo",
-      "file": "site.pp",
-      "line": 5,
-      "inherits": "foo::bar",
-      "docstring": {
-        "text": "A simple class.",
-        "tags": [
-          {
-            "tag_name": "param",
-            "text": "First param.",
-            "types": [
-              "Integer"
-            ],
-            "name": "param1"
-          },
-          {
-            "tag_name": "param",
-            "text": "Second param.",
-            "types": [
-              "Any"
-            ],
-            "name": "param2"
-          },
-          {
-            "tag_name": "param",
-            "text": "Third param.",
-            "types": [
-              "String"
-            ],
-            "name": "param3"
-          }
-        ]
-      },
-      "defaults": {
-        "param3": "hi"
-      },
-      "source": "class foo(Integer $param1, $param2, String $param3 = hi) inherits foo::bar {\n}"
-    }
-  ],
-  "defined_types": [
-    {
-      "name": "dt",
-      "file": "site.pp",
-      "line": 12,
-      "docstring": {
-        "text": "A simple defined type.",
-        "tags": [
-          {
-            "tag_name": "param",
-            "text": "First param.",
-            "types": [
-              "Integer"
-            ],
-            "name": "param1"
-          },
-          {
-            "tag_name": "param",
-            "text": "Second param.",
-            "types": [
-              "Any"
-            ],
-            "name": "param2"
-          },
-          {
-            "tag_name": "param",
-            "text": "Third param.",
-            "types": [
-              "String"
-            ],
-            "name": "param3"
-          }
-        ]
-      },
-      "defaults": {
-        "param3": "hi"
-      },
-      "source": "define dt(Integer $param1, $param2, String $param3 = hi) {\n}"
-    }
-  ],
-  "resource_types": [
-    {
-      "name": "database",
-      "file": "database.rb",
-      "line": 43,
-      "docstring": {
-        "text": "An example database server resource type."
-      },
-      "properties": [
-        {
-          "name": "ensure",
-          "description": "What state the database should be in.",
-          "values": [
-            "present",
-            "absent",
-            "up",
-            "down"
-          ],
-          "aliases": {
-            "up": "present",
-            "down": "absent"
-          },
-          "default": "up"
-        },
-        {
-          "name": "file",
-          "description": "The database file to use."
-        },
-        {
-          "name": "log_level",
-          "description": "The log level to use.",
-          "values": [
-            "debug",
-            "warn",
-            "error"
-          ],
-          "default": "warn"
-        }
-      ],
-      "parameters": [
-        {
-          "name": "address",
-          "description": "The database server name.",
-          "isnamevar": true
-        },
-        {
-          "name": "encryption_key",
-          "description": "The encryption key to use."
-        },
-        {
-          "name": "encrypt",
-          "description": "Whether or not to encrypt the database.",
-          "values": [
-            "true",
-            "false",
-            "yes",
-            "no"
-          ],
-          "default": "false"
-        }
-      ],
-      "features": [
-        {
-          "name": "encryption",
-          "description": "The provider supports encryption."
-        }
-      ]
-    }
-  ],
-  "providers": [
-    {
-      "name": "linux",
-      "type_name": "database",
-      "file": "linux.rb",
-      "line": 33,
-      "docstring": {
-        "text": "An example provider on Linux."
-      },
-      "confines": {
-        "kernel": "Linux",
-        "osfamily": "RedHat"
-      },
-      "features": [
-        "implements_some_feature",
-        "some_other_feature"
-      ],
-      "defaults": [
-        [
-          [
-            "kernel",
-            "Linux"
-          ]
-        ],
-        [
-          [
-            "osfamily",
-            "RedHat",
-          ],
-          [
-            "operatingsystemmajrelease",
-            "7"
-          ]
-        ]
-      ],
-      "commands": {
-        "foo": "/usr/bin/foo"
-      }
-    }
-  ],
-  "puppet_functions": [
-    {
-      "name": "func",
-      "file": "site.pp",
-      "line": 20,
-      "type": "puppet",
-      "signatures": [
-        {
-          "signature": "func(Integer $param1, Any $param2, String $param3 = hi)",
-          "docstring": {
-            "text": "A simple function.",
-            "tags": [
-              {
-                "tag_name": "param",
-                "text": "First param.",
-                "types": [
-                  "Integer"
-                ],
-                "name": "param1"
-              },
-              {
-                "tag_name": "param",
-                "text": "Second param.",
-                "types": [
-                  "Any"
-                ],
-                "name": "param2"
-              },
-              {
-                "tag_name": "param",
-                "text": "Third param.",
-                "types": [
-                  "String"
-                ],
-                "name": "param3"
-              },
-              {
-                "tag_name": "return",
-                "text": "Returns nothing.",
-                "types": [
-                  "Undef"
-                ]
-              }
-            ]
-          }
-        }
-      ],
-      "docstring": {
-        "text": "A simple function.",
-        "tags": [
-          {
-            "tag_name": "param",
-            "text": "First param.",
-            "types": [
-              "Integer"
-            ],
-            "name": "param1"
-          },
-          {
-            "tag_name": "param",
-            "text": "Second param.",
-            "types": [
-              "Any"
-            ],
-            "name": "param2"
-          },
-          {
-            "tag_name": "param",
-            "text": "Third param.",
-            "types": [
-              "String"
-            ],
-            "name": "param3"
-          },
-          {
-            "tag_name": "return",
-            "text": "Returns nothing.",
-            "types": [
-              "Undef"
-            ]
-          }
-        ]
-      },
-      "defaults": {
-        "param3": "hi"
-      },
-      "source": "function func(Integer $param1, $param2, String $param3 = hi) {\n}"
-    },
-    {
-      "name": "func3x",
-      "file": "func3x.rb",
-      "line": 1,
-      "type": "ruby3x",
-      "signatures": [
-        {
-          "signature": "func3x(String $first, Any $second)",
-          "docstring": {
-            "text": "An example 3.x function.",
-            "tags": [
-              {
-                "tag_name": "param",
-                "text": "The first parameter.",
-                "types": [
-                  "String"
-                ],
-                "name": "first"
-              },
-              {
-                "tag_name": "param",
-                "text": "The second parameter.",
-                "types": [
-                  "Any"
-                ],
-                "name": "second"
-              },
-              {
-                "tag_name": "return",
-                "text": "Returns nothing.",
-                "types": [
-                  "Undef"
-                ]
-              }
-            ]
-          }
-        }
-      ],
-      "docstring": {
-        "text": "An example 3.x function.",
-        "tags": [
-          {
-            "tag_name": "param",
-            "text": "The first parameter.",
-            "types": [
-              "String"
-            ],
-            "name": "first"
-          },
-          {
-            "tag_name": "param",
-            "text": "The second parameter.",
-            "types": [
-              "Any"
-            ],
-            "name": "second"
-          },
-          {
-            "tag_name": "return",
-            "text": "Returns nothing.",
-            "types": [
-              "Undef"
-            ]
-          }
-        ]
-      },
-      "source": "Puppet::Parser::Functions.newfunction(:func3x, doc: <<-DOC\nAn example 3.x function.\n@param [String] first The first parameter.\n@param second The second parameter.\n@return [Undef] Returns nothing.\nDOC\n) do |*args|\nend"
-    },
-    {
-      "name": "func4x",
-      "file": "func4x.rb",
-      "line": 11,
-      "type": "ruby4x",
-      "signatures": [
-        {
-          "signature": "func4x(Integer $param1, Any $param2, Optional[Array[String]] $param3)",
-          "docstring": {
-            "text": "The first overload.",
-            "tags": [
-              {
-                "tag_name": "param",
-                "text": "The first parameter.",
-                "types": [
-                  "Integer"
-                ],
-                "name": "param1"
-              },
-              {
-                "tag_name": "param",
-                "text": "The second parameter.",
-                "types": [
-                  "Any"
-                ],
-                "name": "param2"
-              },
-              {
-                "tag_name": "param",
-                "text": "The third parameter.",
-                "types": [
-                  "Optional[Array[String]]"
-                ],
-                "name": "param3"
-              },
-              {
-                "tag_name": "return",
-                "text": "Returns nothing.",
-                "types": [
-                  "Undef"
-                ]
-              }
-            ]
-          }
-        },
-        {
-          "signature": "func4x(Boolean $param, Callable &$block)",
-          "docstring": {
-            "text": "The second overload.",
-            "tags": [
-              {
-                "tag_name": "param",
-                "text": "The first parameter.",
-                "types": [
-                  "Boolean"
-                ],
-                "name": "param"
-              },
-              {
-                "tag_name": "param",
-                "text": "The block parameter.",
-                "types": [
-                  "Callable"
-                ],
-                "name": "&block"
-              },
-              {
-                "tag_name": "return",
-                "text": "Returns a string.",
-                "types": [
-                  "String"
-                ]
-              }
-            ]
-          }
-        }
-      ],
-      "docstring": {
-        "text": "An example 4.x function.",
-        "tags": [
-          {
-            "tag_name": "overload",
-            "signature": "func4x(Integer $param1, Any $param2, Optional[Array[String]] $param3)",
-            "docstring": {
-              "text": "The first overload.",
-              "tags": [
-                {
-                  "tag_name": "param",
-                  "text": "The first parameter.",
-                  "types": [
-                    "Integer"
-                  ],
-                  "name": "param1"
-                },
-                {
-                  "tag_name": "param",
-                  "text": "The second parameter.",
-                  "types": [
-                    "Any"
-                  ],
-                  "name": "param2"
-                },
-                {
-                  "tag_name": "param",
-                  "text": "The third parameter.",
-                  "types": [
-                    "Optional[Array[String]]"
-                  ],
-                  "name": "param3"
-                },
-                {
-                  "tag_name": "return",
-                  "text": "Returns nothing.",
-                  "types": [
-                    "Undef"
-                  ]
-                }
-              ]
-            },
-            "name": "func4x"
-          },
-          {
-            "tag_name": "overload",
-            "signature": "func4x(Boolean $param, Callable &$block)",
-            "docstring": {
-              "text": "The second overload.",
-              "tags": [
-                {
-                  "tag_name": "param",
-                  "text": "The first parameter.",
-                  "types": [
-                    "Boolean"
-                  ],
-                  "name": "param"
-                },
-                {
-                  "tag_name": "param",
-                  "text": "The block parameter.",
-                  "types": [
-                    "Callable"
-                  ],
-                  "name": "&block"
-                },
-                {
-                  "tag_name": "return",
-                  "text": "Returns a string.",
-                  "types": [
-                    "String"
-                  ]
-                }
-              ]
-            },
-            "name": "func4x"
-          }
-        ]
-      },
-      "source": "Puppet::Functions.create_function(:func4x) do\n  # The first overload.\n  # @param param1 The first parameter.\n  # @param param2 The second parameter.\n  # @param param3 The third parameter.\n  # @return [Undef] Returns nothing.\n  dispatch :foo do\n    param          'Integer',       :param1\n    param          'Any',           :param2\n    optional_param 'Array[String]', :param3\n  end\n\n  # The second overload.\n  # @param param The first parameter.\n  # @param block The block parameter.\n  # @return [String] Returns a string.\n  dispatch :other do\n    param 'Boolean', :param\n    block_param\n  end\nend"
-    }
-  ],
-  "puppet_tasks": [
-    {
-      "name": "(stdin)",
-      "file": "(stdin)",
-      "line": 0,
-      "docstring": {
-        "text": "Allows you to backup your database to local file.",
-        "tags": [
-          {
-            "name": "database",
-            "tag_name": "param",
-            "text": "Database to connect to",
-            "types": [
-              "Optional[String[1]]"
-            ]
-          },
-          {
-            "name": "user",
-            "tag_name": "param",
-            "text": "The user",
-            "types": [
-              "Optional[String[1]]"
-            ]
-          },
-          {
-            "name": "password",
-            "tag_name": "param",
-            "text": "The password",
-            "types": [
-              "Optional[String[1]]"
-            ]
-          },
-          {
-            "name": "sql",
-            "tag_name": "param",
-            "text": "Path to file you want backup to",
-            "types": [
-              "String[1]"
-            ]
-          }
-        ]
-      },
-      "source": "{\n  \"description\": \"Allows you to backup your database to local file.\",\n  \"input_method\": \"stdin\",\n  \"parameters\": {\n    \"database\": {\n      \"description\": \"Database to connect to\",\n      \"type\": \"Optional[String[1]]\"\n    },\n    \"user\": {\n      \"description\": \"The user\",\n      \"type\": \"Optional[String[1]]\"\n    },\n    \"password\": {\n      \"description\": \"The password\",\n      \"type\": \"Optional[String[1]]\"\n    },\n     \"sql\": {\n      \"description\": \"Path to file you want backup to\",\n      \"type\": \"String[1]\"\n    }\n  }\n}\n",
-      "supports_noop": false,
-      "input_method": "stdin"
-    }
-  ],
-  "puppet_plans": [
-    {
-      "name": "plann",
-      "file": "(stdin)",
-      "line": 5,
-      "docstring": {
-        "text": "A simple plan.",
-        "tags": [
-          {
-            "tag_name": "param",
-            "text": "First param.",
-            "types": [
-              "String"
-            ],
-            "name": "param1"
-          },
-          {
-            "tag_name": "param",
-            "text": "Second param.",
-            "types": [
-              "Any"
-            ],
-            "name": "param2"
-          },
-          {
-            "tag_name": "param",
-            "text": "Third param.",
-            "types": [
-              "Integer"
-            ],
-            "name": "param3"
-          }
-        ]
-      },
-      "defaults": {
-        "param3": "1"
-      },
-      "source": "plan plann(String $param1, $param2, Integer $param3 = 1) {\n}"
-    }
-  ]
-}
-```