/wp-theme-check

:heavy_check_mark: WordPress Theme Check in Node.js

Primary LanguagePHPMIT LicenseMIT

✔️ WordPress Theme Check

WordPress Theme Check in Node.js. Theme Mentor and Theme Check

Motivation

After 5 years developing themes in WordPress, I realize that implementing good workflow is hard. After wandering in javascript world, my perspective about workflow really changed. All tasks are automated. Today, I'm going back to WordPress world. Here is reason why this project is good for WordPress development workflow:

  • You don't need to install WordPress and setup server in CI server.
  • You don't need to install Plugin to check whether theme is valid or not.
  • Your wasting time checking theme with plugin will be handled in Continous Integration script.

💻 Install

Using NPM

$ npm install wp-theme-check --save

Using Yarn

$ yarn add wp-theme-check

If you want to use CLI version, please install it globally.

# NPM
$ npm install wp-theme-check -g

# Yarn
# Use sudo in OSX
$ yarn global wp-theme-check

Usage

const themeCheck = require('wp-theme-check')

themeCheck(`/path/to/wordpress/wp-content/themes/theme-name`)
  .then(logs => {
    console.log(logs)
  })
  .catch(err => {
    console.error(err.message)
  })

⚡ CLI

themecheck - WordPress theme check

  USAGE

  themecheck [path]

  ARGUMENTS

  [path]      Script path could be theme directory.      optional      

  OPTIONS

  --with-theme-mentor Only use theme mentor as validator. optional      
  --with-theme-check Only use theme check as validator. optional      

  GLOBAL OPTIONS

  -h, --help         Display help                                      
  -V, --version      Display version                                   
  --no-color         Disable colors                                    
  --quiet            Quiet mode - only displays warn and error messages
  -v, --verbose      Verbose mode - will also output debug messages

Related

License

MIT © oknoorap