Skip to content

"Just Do It" is designed to provide the basic requirements to help you run tasks automatically for you to save time out of your day running tests, version checking and building a deployable WordPress plugin.

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 

Just Do It

Follow me

💻 Website 🐦Twitter

🔔 Overview

A Gruntfile.js and package.json template ready to copy into your WordPress plugin projects. Just configure the package.json file to your requirements and run the Grunt commands below after installing the dependencies.

Developer Dependancies

These are the dependencies in use for testing, building, updating the language POT file and building a deployable plugin zipped up.

💽 Installation

  1. Install Node.js & NPM and Grunt by following the standard installation instructions or using Homebrew.

If you've installed NPM correctly, this should display the version:

$ npm --version

If you've install Grunt correctly, this should display the version:

$ grunt --version

  1. Change to the plugin root directory.

Install the Grunt dependencies by running the npm installer with the following command:

$ npm install --dev or $ npm install --only=dev

  1. Run tests.

$ grunt test

Add --force at the end to tell grunt to continue next tasks even if one fails.

$ grunt test --force

🐽 Grunt Commands

Build the plugin.

String Replacements (i.e. Plugin Version), Compresses the JavaScript, Checks for Text Domain issues and Updates the POT file.

$ grunt build

Similar to the build command except it does not check for text domains issues.

$ grunt dev

Checks for any text domain issues and updates the POT file.

$ grunt update-pot

Copies the plugin to create deployable plugin, then compresses the folder and then deletes the folder once compressed.

The zip file will be labelled as %= pkg.name %-v%= pkg.version %.zip

$ grunt zip

Contribute

If you or your company use Just Do It or appreciate the work I’m doing in open source, please consider supporting me directly so I can continue maintaining it.

You'll be helping to ensure I can spend the time not just fixing bugs, but keeping the project afloat. Any contribution you make is a big help and is greatly appreciated.

Please also consider starring and sharing 👍 the project repo! This helps the project getting known and grow with the community. 🙏

I accept one-time donations and monthly via BuyMeACoffee.com

  • My PayPal
  • BuyMeACoffee.com
  • Bitcoin (BTC): 3L4cU7VJsXBFckstfJdP2moaNhTHzVDkKQ
  • Ethereum (ETH): 0xc6a3C18cf11f5307bFa11F8BCBD51F355b6431cB
  • Litecoin (LTC): MNNy3xBK8sM8t1YUA2iAwdi9wRvZp9yRoi

Thank you for your support! 🙌

License

Just Do It is released under GNU General Public License v3.0.


About

"Just Do It" is designed to provide the basic requirements to help you run tasks automatically for you to save time out of your day running tests, version checking and building a deployable WordPress plugin.

Topics

Resources

Releases

No releases published

Packages

No packages published