{"id":20757604,"url":"https://github.com/dodevops/puppet-lint-module_reference-check","last_synced_at":"2026-04-17T19:31:55.689Z","repository":{"id":57698043,"uuid":"499138041","full_name":"dodevops/puppet-lint-module_reference-check","owner":"dodevops","description":"An extensive, opinionated puppet lint check for valid module reference comments","archived":false,"fork":false,"pushed_at":"2022-06-03T11:46:52.000Z","size":15,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-12-03T13:44:47.938Z","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}},"created_at":"2022-06-02T13:04:33.000Z","updated_at":"2022-06-02T13:05:33.000Z","dependencies_parsed_at":"2022-08-25T11:00:50.279Z","dependency_job_id":null,"html_url":"https://github.com/dodevops/puppet-lint-module_reference-check","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/dodevops/puppet-lint-module_reference-check","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dodevops%2Fpuppet-lint-module_reference-check","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dodevops%2Fpuppet-lint-module_reference-check/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dodevops%2Fpuppet-lint-module_reference-check/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dodevops%2Fpuppet-lint-module_reference-check/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dodevops","download_url":"https://codeload.github.com/dodevops/puppet-lint-module_reference-check/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dodevops%2Fpuppet-lint-module_reference-check/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31943279,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-17T17:29:20.459Z","status":"ssl_error","status_checked_at":"2026-04-17T17:28:47.801Z","response_time":62,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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.883Z","updated_at":"2026-04-17T19:31:55.670Z","avatar_url":"https://github.com/dodevops.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Puppet lint module reference check\n\nThis checks whether used modules are properly referenced in the comments by these rules:\n\n- All internal prefixed with profile:: or role:: based on the Puppet role/profile concept) modules have to be \n  referenced using a @see tag\n- All component modules have to be referenced like the following\n  - All used classes and defined types need to be gathered in a comma-separated list of regexps in a @ref tag\n  - The full module name (vendor-module) has to be referenced in a @note tag\n  - At minimum one @see tag with a reference to the puppet forge page of the component module\n  - Example:\n    ```\n    # @ref apache.*,a2mod\n    # @note puppetlabs-apache\n    # @see https://forge.puppet.com/modules/puppetlabs/apache\n    ```\n- Modules referenced by features (using our own role::include_features function) have to be referenced with @see\n- The module references have to be sorted alphabetically and grouped by this:\n  - component module\n  - internal modules\n  - modules referenced by features\n\n**Note**: This check can only detect component module usage with the `class` and `include` keywords, but supports\nreference comments to undetectable components modules as well.\n\n## Usage\n\nTo use the plugin, add the following line to the Gemfile:\n\n    gem 'puppet-lint-module_reference-check'\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdodevops%2Fpuppet-lint-module_reference-check","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdodevops%2Fpuppet-lint-module_reference-check","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdodevops%2Fpuppet-lint-module_reference-check/lists"}