{"id":20757603,"url":"https://github.com/dodevops/puppet-lint-param_comment-check","last_synced_at":"2026-04-21T12:02:48.567Z","repository":{"id":65524850,"uuid":"497923255","full_name":"dodevops/puppet-lint-param_comment-check","owner":"dodevops","description":"An extensive, opinionated puppet lint check for valid parameter comments","archived":false,"fork":false,"pushed_at":"2023-09-05T07:55:12.000Z","size":80,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-02-18T17:54:06.816Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/dodevops.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-05-30T11:57:48.000Z","updated_at":"2022-05-30T11:59:14.000Z","dependencies_parsed_at":"2025-01-18T04:54:59.298Z","dependency_job_id":null,"html_url":"https://github.com/dodevops/puppet-lint-param_comment-check","commit_stats":{"total_commits":21,"total_committers":1,"mean_commits":21.0,"dds":0.0,"last_synced_commit":"ac8c6d93d0a17be9788b43acc92fc2de8ae147d2"},"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dodevops%2Fpuppet-lint-param_comment-check","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dodevops%2Fpuppet-lint-param_comment-check/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dodevops%2Fpuppet-lint-param_comment-check/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dodevops%2Fpuppet-lint-param_comment-check/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dodevops","download_url":"https://codeload.github.com/dodevops/puppet-lint-param_comment-check/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243067048,"owners_count":20230860,"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-11-17T09:43:21.809Z","updated_at":"2026-04-21T12:02:48.553Z","avatar_url":"https://github.com/dodevops.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Puppet lint param check\n\nThis is an extensive, opinionated check for valid parameter comments. It checks if the following criteria are matched:\n\n- All parameters are documented\n- @param-tags are separated from another by one empty line\n- The description of a @param tag is always indented in the next line\n- The @option comments directly follow the corresponding hash @param tag without a separator\n- @param tags are sorted like the parameters they document\n\n```\n# @param mandatory\n#   A mandatory parameter\n# @option mandatory [String] hashkey\n#   A key of the hash \"mandatory\" named \"hashkey\".\n#\n# @param withdefault\n#   A parameter with a default value\n#\n# @param optional\n#   An optional parameter\n\nclass my_class {\n    Hash $mandatory,\n    Boolean $withdefault = false,\n    Optional[String] $optional = undef,\n```\n\n## Development\n\nThis check uses a finite state machine to work through the expected list of parameters.\n\nThe workflow used by the fsm can be visualized like this:\n\n![](docs/param_workflow.drawio.png)\n\n## Usage\n\nTo use the plugin, add the following line to the Gemfile:\n\n    gem 'puppet-lint-param_comment-check'\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdodevops%2Fpuppet-lint-param_comment-check","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdodevops%2Fpuppet-lint-param_comment-check","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdodevops%2Fpuppet-lint-param_comment-check/lists"}