Grunt WP plugin tasks

Last Commit	18540f3 (September 1, 2025 12:00 am)
Repository	https://github.com/magicoli/grunt-wp-plugin-tasks
License	GNU AFFERO GENERAL PUBLIC LICENSE

(formerly barely known as olib-dev)

Dev libraries that might or might not be useful for WordPress plugins developers.

See the sister project magicoli/grunt-translation-tasks to use in a generic project (using gettext insttead of WP-specific framework).

Provides

• makereadmetxt: Builds or updates the WordPress standard plugin readme.txt compiling and reformatting README.md, INSTALLATION.md, FAQ.md, CHANGELOG.md.
• i18n: Prepares internationalization assets, updating text domains, generating POT, and converting PO files to MO.
• makemo: Converts PO files to MO using WP CLI.

Installation

1. Clone the repository into your plugin’s subfolder (e.g., at dev/grunt-wp-plugin-tasks).
2. Exclude this subfolder from distribution (e.g., add dev/grunt-wp-plugin-tasks to your .distignore).
3. Add the following workspace configuration to your plugin’s package.json:

   "workspaces": {
    "packages": [
      "dev/grunt-wp-plugin-tasks"
    ]
   }

4. Run "npm install" to install dependencies.
5. In your plugin’s Gruntfile.js
   • Define your plugin slug name slug (e.g. ‘my-plugin’)
   • Load the custom tasks with:

     // ...existing code...
     const pluginName = 'YOURPLUGINSLUG'; // replace with your slug
     require('./dev/grunt-wp-plugin-tasks/grunt-wp-plugin-tasks.js')(grunt, pluginName);
     // ...existing code...

6. Run "grunt" or invoke specific tasks (e.g., "grunt i18n") as needed.