{"id":15527906,"url":"https://github.com/swissspidy/validate-readme-command","last_synced_at":"2025-04-23T12:30:46.191Z","repository":{"id":62400228,"uuid":"487042893","full_name":"swissspidy/validate-readme-command","owner":"swissspidy","description":"WP-CLI command to validate WordPress plugin readme files","archived":false,"fork":false,"pushed_at":"2024-12-09T14:51:43.000Z","size":82,"stargazers_count":6,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-29T23:41:16.517Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","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/swissspidy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","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-04-29T16:38:11.000Z","updated_at":"2025-03-28T04:18:41.000Z","dependencies_parsed_at":"2024-12-09T15:41:35.933Z","dependency_job_id":null,"html_url":"https://github.com/swissspidy/validate-readme-command","commit_stats":{"total_commits":12,"total_committers":2,"mean_commits":6.0,"dds":0.08333333333333337,"last_synced_commit":"73420d4b7220a9627d6ccb2c9c1fc2f0fe593d0a"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swissspidy%2Fvalidate-readme-command","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swissspidy%2Fvalidate-readme-command/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swissspidy%2Fvalidate-readme-command/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swissspidy%2Fvalidate-readme-command/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/swissspidy","download_url":"https://codeload.github.com/swissspidy/validate-readme-command/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250434416,"owners_count":21430095,"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-02T11:09:49.912Z","updated_at":"2025-04-23T12:30:46.156Z","avatar_url":"https://github.com/swissspidy.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"swissspidy/validate-readme-command\n==================================\n\nValidate WordPress plugin readme files\n\n[![Testing](https://github.com/swissspidy/validate-readme-command/actions/workflows/testing.yml/badge.svg)](https://github.com/swissspidy/validate-readme-command/actions/workflows/testing.yml)\n\nQuick links: [Using](#using) | [Installing](#installing) | [Contributing](#contributing) | [Support](#support)\n\n## Using\n\n~~~\nwp plugin validate-readme \u003creadme\u003e [--format=\u003cformat\u003e] [--strict]\n~~~\n\n**OPTIONS**\n\n\t\u003creadme\u003e\n\t\tReadme contents, path to a readme file, or readme URL.\n\n\t[--format=\u003cformat\u003e]\n\t\tDesired output format\n\t\t---\n\t\tdefault: default\n\t\toptions:\n\t\t  - default\n\t\t  - github-actions\n\n\t[--strict]\n\t\tWhether to perform a strict check by treating all messages as errors.\n\n**EXAMPLES**\n\n    # Validate the Hello Dolly readme\n    $ wp plugin validate-readme \\\n           https://plugins.svn.wordpress.org/hello-dolly/trunk/readme.txt\n    Warning: The `Requires PHP` field is missing. It should be defined here, or in your main plugin file.\n    Warning: No `== Frequently Asked Questions ==` section was found\n    Warning: No `== Changelog ==` section was found\n    Warning: No `== Upgrade Notice ==` section was found\n    Warning: No `== Screenshots ==` section was found\n    Warning: No donate link was found\n    Success: Readme successfully validated.\n\n    # Print output with GitHub Actions workflow annotations\n    $ wp plugin validate-readme readme.txt --format=github-actions\n    ::notice file=readme.txt::No donate link was found\n    Success: Readme successfully validated.\n\n    # Perform strict check\n    $ wp plugin validate-readme readme.txt --strict\n    Error: No donate link was found\n    Error: Readme validated with errors.\n\n## Installing\n\nInstalling this package requires WP-CLI v2.5 or greater. Update to the latest stable release with `wp cli update`.\n\nOnce you've done so, you can install the latest stable version of this package with:\n\n```bash\nwp package install swissspidy/validate-readme-command:@stable\n```\n\nTo install the latest development version of this package, use the following command instead:\n\n```bash\nwp package install swissspidy/validate-readme-command:dev-master\n```\n\n## Contributing\n\nWe appreciate you taking the initiative to contribute to this project.\n\nContributing isn’t limited to just code. We encourage you to contribute in the way that best fits your abilities, by writing tutorials, giving a demo at your local meetup, helping other users with their support questions, or revising our documentation.\n\nFor a more thorough introduction, [check out WP-CLI's guide to contributing](https://make.wordpress.org/cli/handbook/contributing/). This package follows those policy and guidelines.\n\n### Reporting a bug\n\nThink you’ve found a bug? We’d love for you to help us get it fixed.\n\nBefore you create a new issue, you should [search existing issues](https://github.com/swissspidy/validate-readme-command/issues?q=label%3Abug%20) to see if there’s an existing resolution to it, or if it’s already been fixed in a newer version.\n\nOnce you’ve done a bit of searching and discovered there isn’t an open or fixed issue for your bug, please [create a new issue](https://github.com/swissspidy/validate-readme-command/issues/new). Include as much detail as you can, and clear steps to reproduce if possible. For more guidance, [review our bug report documentation](https://make.wordpress.org/cli/handbook/bug-reports/).\n\n### Creating a pull request\n\nWant to contribute a new feature? Please first [open a new issue](https://github.com/swissspidy/validate-readme-command/issues/new) to discuss whether the feature is a good fit for the project.\n\nOnce you've decided to commit the time to seeing your pull request through, [please follow our guidelines for creating a pull request](https://make.wordpress.org/cli/handbook/pull-requests/) to make sure it's a pleasant experience. See \"[Setting up](https://make.wordpress.org/cli/handbook/pull-requests/#setting-up)\" for details specific to working on this package locally.\n\n## Support\n\nGitHub issues aren't for general support questions, but there are other venues you can try: https://wp-cli.org/#support\n\n\n*This README.md is generated dynamically from the project's codebase using `wp scaffold package-readme` ([doc](https://github.com/wp-cli/scaffold-package-command#wp-scaffold-package-readme)). To suggest changes, please submit a pull request against the corresponding part of the codebase.*\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fswissspidy%2Fvalidate-readme-command","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fswissspidy%2Fvalidate-readme-command","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fswissspidy%2Fvalidate-readme-command/lists"}