grunt-wp-theme-check

Grunt plugin to run Theme Check

Getting Started

This plugin requires Grunt ~0.4.5

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-wp-theme-check --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-wp-theme-check');

The "wp_theme_check" task

Requirements

This grunt plugin requires WP-CLI and this modified version of the Theme Check plugin. If you can run wp theme review check <theme-name>, you'll be able to use this plugin.

Overview

In your project's Gruntfile, add a section named wp_theme_check to the data object passed into grunt.initConfig().

grunt.initConfig({
  wp_theme_check: {
    options: {
      // Task-specific options go here.
    },
    your_target: {
      // Target-specific file lists and/or options go here.
    },
  },
});

Options

options.path

Type: String Default value: null

Path to WordPress. Used for wp-cli's --path flag. Required.

options.theme

Type: String Default value: null

Name of the theme to test. Use the folder name here, not the "Theme Name".

Usage Examples

Default Options

In this example, we're just checking one theme, twentyfourteen, and WordPress lives in the /srv/www/wordpress-trunk directory.

grunt.initConfig({
  wp_theme_check: {
    options: {
      path: '/srv/www/wordpress-trunk',
      theme: 'twentyfourteen'
    }
  },
});

Custom Options

In this example, we're testing two themes in the same WordPress install.

grunt.initConfig({
  wp_theme_check: {
    options: {
      path: '/srv/www/wordpress-trunk'
    },
    twentyfourteen: {
      options: {
        theme: 'twentyfourteen'
      }
    },
    twentythirteen: {
      options: {
        theme: 'twentythirteen'
      }
    }
  },
});

Contributing

In 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.

Release History

0.1.1: Minor update to readme

0.1.0: Initial release

alexVauch/grunt-wp-theme-check