{"id":15514166,"url":"https://github.com/petems/puppet-doc-lint","last_synced_at":"2025-04-23T03:16:22.093Z","repository":{"id":13921482,"uuid":"16620844","full_name":"petems/puppet-doc-lint","owner":"petems","description":"Check your puppet files for RDoc coverage","archived":false,"fork":false,"pushed_at":"2015-10-23T13:37:34.000Z","size":337,"stargazers_count":5,"open_issues_count":2,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-23T03:15:55.648Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/petems.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-02-07T16:45:45.000Z","updated_at":"2024-10-22T21:15:55.000Z","dependencies_parsed_at":"2022-09-23T17:05:04.193Z","dependency_job_id":null,"html_url":"https://github.com/petems/puppet-doc-lint","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/petems%2Fpuppet-doc-lint","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/petems%2Fpuppet-doc-lint/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/petems%2Fpuppet-doc-lint/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/petems%2Fpuppet-doc-lint/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/petems","download_url":"https://codeload.github.com/petems/puppet-doc-lint/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250360510,"owners_count":21417721,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-02T09:57:47.085Z","updated_at":"2025-04-23T03:16:22.077Z","avatar_url":"https://github.com/petems.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# DEPRECATED\n\nThis is now deprecated in favour of [Puppet Strings](https://github.com/puppetlabs/puppetlabs-strings)\n\n# puppet-doc-lint\n\nLint your Puppet files for RDoc coverage\n\nThis project is heavily based on the [puppet-parse](https://github.com/johanek/puppet-parse) code base, go check it out! :smile:\n\n## Assumptions\n\nThis assumes that you're formatting your documentation in Puppet with [RDoc formatting](http://rdoc.sourceforge.net/doc/).\n\nFor example _this_ will work:\n\n```Rdoc\n# == Class: foo\n#\n# This module manages foo\n#\n# === Parameters\n#\n# [*ensure*]\n#   Controls presence of package and stuff\n#\n# === Authors\n#\n# * Jane Doe \u003cmailto:jane.doe@fakecorp.com\u003e\n#\n```\n\n_This_ will not:\n\n```\n# Class: foo\n#\n# This module manages foo\n#\n# Parameters:\n# \t- $ensure\n#\n# Authors: Jane Doe \u003cmailto:jane.doe@fakecorp.com\u003e\n#\n```\n\n## Installation\n\n    gem install puppet-doc-lint\n\n## Usage\n\n### By hand\n\nYou can report on one or more manifests by running\n\n    puppet-doc-lint \u003cpath(s) to file(s)\u003e\n\nFor example:\n  \n```\npuppet-doc-lint ~/Projects/puppetlabs-firewall/manifests/linux/debian.pp\nclass firewall::linux::debian Parameters are [\"ensure\", \"enable\"]\nclass firewall::linux::debian Docs found are [\"ensure\", \"enable\"]\n```\n\n### Rake task\n\n** Currrently broken maybe? **\n\nIf you want to parse your entire modules directory, you can add\n`require 'puppet-doc-lint/rake-task' to your Rakefile and then run\n\n    rake parse\n\nIf you need to ignore certain paths from being parsed:\n\n``` ruby\nPuppetDocLint.configuration.ignore_paths = [\"vendor/**/*.pp\"]\n```\n\n## Contributing\n\nYou can do any of these:\n\n1. Create new Pull Request\n2. Create an issue\n3. Write me an email\n4. Complain about how useless my code is on twitter\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpetems%2Fpuppet-doc-lint","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpetems%2Fpuppet-doc-lint","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpetems%2Fpuppet-doc-lint/lists"}