{"id":16040811,"url":"https://github.com/ryelle/grunt-wp-theme-check","last_synced_at":"2025-03-17T21:31:01.696Z","repository":{"id":18431504,"uuid":"21616545","full_name":"ryelle/grunt-wp-theme-check","owner":"ryelle","description":"Grunt plugin to run Theme Check CLI","archived":false,"fork":false,"pushed_at":"2016-02-21T17:57:53.000Z","size":159,"stargazers_count":3,"open_issues_count":2,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-28T04:46:24.414Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/ryelle.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE-MIT","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-07-08T14:48:10.000Z","updated_at":"2022-10-30T20:42:45.000Z","dependencies_parsed_at":"2022-08-04T23:30:44.708Z","dependency_job_id":null,"html_url":"https://github.com/ryelle/grunt-wp-theme-check","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryelle%2Fgrunt-wp-theme-check","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryelle%2Fgrunt-wp-theme-check/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryelle%2Fgrunt-wp-theme-check/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryelle%2Fgrunt-wp-theme-check/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ryelle","download_url":"https://codeload.github.com/ryelle/grunt-wp-theme-check/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243885926,"owners_count":20363644,"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-08T23:21:38.108Z","updated_at":"2025-03-17T21:31:01.389Z","avatar_url":"https://github.com/ryelle.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# grunt-wp-theme-check\n\n\u003e Grunt plugin to run Theme Check\n\n## Getting Started\nThis plugin requires Grunt `~0.4.5`\n\nIf you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:\n\n```shell\nnpm install grunt-wp-theme-check --save-dev\n```\n\nOnce the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:\n\n```js\ngrunt.loadNpmTasks('grunt-wp-theme-check');\n```\n\n## The \"wp_theme_check\" task\n\n### Requirements\n\nThis grunt plugin requires [WP-CLI](http://wp-cli.org) and [this modified version of the Theme Check plugin](https://github.com/ryelle/theme-check). If you can run `wp theme review check \u003ctheme-name\u003e`, you'll be able to use this plugin.\n\n### Overview\nIn your project's Gruntfile, add a section named `wp_theme_check` to the data object passed into `grunt.initConfig()`.\n\n```js\ngrunt.initConfig({\n  wp_theme_check: {\n    options: {\n      // Task-specific options go here.\n    },\n    your_target: {\n      // Target-specific file lists and/or options go here.\n    },\n  },\n});\n```\n\n### Options\n\n#### options.path\nType: `String`\nDefault value: `null`\n\nPath to WordPress. Used for wp-cli's `--path` flag. Required.\n\n#### options.theme\nType: `String`\nDefault value: `null`\n\nName of the theme to test. Use the folder name here, not the \"Theme Name\".\n\n### Usage Examples\n\n#### Default Options\nIn this example, we're just checking one theme, twentyfourteen, and WordPress lives in the /srv/www/wordpress-trunk directory.\n\n```js\ngrunt.initConfig({\n  wp_theme_check: {\n    options: {\n      path: '/srv/www/wordpress-trunk',\n      theme: 'twentyfourteen'\n    }\n  },\n});\n```\n\n#### Custom Options\nIn this example, we're testing two themes in the same WordPress install.\n\n```js\ngrunt.initConfig({\n  wp_theme_check: {\n    options: {\n      path: '/srv/www/wordpress-trunk'\n    },\n    twentyfourteen: {\n      options: {\n        theme: 'twentyfourteen'\n      }\n    },\n    twentythirteen: {\n      options: {\n        theme: 'twentythirteen'\n      }\n    }\n  },\n});\n```\n\n## Contributing\nIn lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [Grunt](http://gruntjs.com/).\n\n## Release History\n\n0.1.1: Minor update to readme\n\n0.1.0: Initial release","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fryelle%2Fgrunt-wp-theme-check","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fryelle%2Fgrunt-wp-theme-check","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fryelle%2Fgrunt-wp-theme-check/lists"}