π β If 500 people signup here, I will build a video series for WPGulp.
Use Gulp with WordPress. An advanced but portable Gulp workflow for WordPress. Start using Gulp with your WordPress plugins and themes.
Read: Introducing WPGulp: An Easy to Use WordPress Gulp Boilerplate
- Live reloads browser with BrowserSync
- CSS: Sass to CSS conversion, error catching, Autoprefixing, Sourcemaps, CSS minification, and Merging Media Queries
- JS: Concatenates & uglifies Vendor and Custom JS files
- Images: Minifies PNG, JPEG, GIF and SVG images
- Watches files for changes in CSS or JS
- Watches files for changes in PHP
- Corrects the line endings
- InjectCSS instead of browser page reload
- Generates .pot file for i18n and l10n
- Download
gulpfile.js
,package.json
, and.gitignore
files inside the root folder of your WordPress plugin or WordPress theme - If you have cURL installed then you can run the following command to download all three files in one go (just make sure you open the root folder of your WordPress plugin or WordPress theme and download these files in the root):
curl -O https://raw.githubusercontent.com/ahmadawais/WPGulp/master/package.json && curl -O https://raw.githubusercontent.com/ahmadawais/WPGulp/master/gulpfile.js && curl -O https://raw.githubusercontent.com/ahmadawais/WPGulp/master/.gitignore
Configure the project variables E.g. paths, translation data, etc in gulpfile.js
. Project variables can be found between the following two comments
// START Editing Project Variables.
{PROJECT VARIABLES}
// STOP Editing Project Variables.
You need to have NodeJS & NPM installed. If it is installed, skip to installing Gulp. Otherwise download NodeJS and install it. After installing NodeJS you can verify the install of both NodeJS and Node Package Manager by typing the following commands. This step needs to be followed only once, if you don't have NodeJS installed. No need to repeat it ever again.
node -v
# Results into v4.2.6
npm -v
# Results into 3.9.0
NodeJS and NPM are installed, now we need to install Gulp
globally. To do that, run the following command
# For MAC OS X; run the following command with super user
sudo npm install --global gulp
# For Linux; run the following command
npm install --global gulp
We are in the root folder of our WordPress plugin or WordPress theme at the moment, let's install the Node Dependencies. In the terminal run this command and wait for it to download all the NodeJS dependencies. It's a one time process and can take about 5 mins depending on the internet speed of your connection.
# For MAC OS X run the following command with super user
sudo npm install
# For Linux run the following command
npm install
Once the NodeJS dependencies are downloaded just run the following command to get up and running with WPGulp
# To start gulp
gulp
# To stop gulp press CTRL (β) + C
To optiomize images and generate WP POT translation file, you can run the following commands
# To optimize images
gulp images
# To generate WP POT translation file.
gulp translate
- Delete old files and download the latest
gulpfile.js
,package.json
, and.gitignore
files in the root of your WP project. - Open your WordPress project (plugin/theme) root folder in the terminal and run
# For MAC OS X run the following command with super user
sudo npm install
# For Linux run the following command
npm install
Wait for the new dependencies to be downloaded.
Once the download is complete type gulp
and boom!
- Built with
Mac OS X
but tested and works well withLinux
as well asWindows
. - You must have Git and NodeJS, and Gulp installed globally.
Checkout a basic WordPress theme implementation with WPGulp called WPGulpTheme. This theme demonstrates the architecture followed by default within WPGulp, which is most definitely optional.
It's hard to maintain a FOSS free and open source software project on my own. Which is why there's a backlog and an incomplete to-do list.
- Build WPGulp βοΈ
- Write an introductory blog post about WPGulp βοΈ
- Improve documentation with more easy to follow details βοΈ
- Find sponsorship to produce free of cost video tutorials for WPGulp β¦
- Write about the new WPGulp tasks,
gulp images
to optimize images andgulp translate
to generate WP POT translation file.
I am looking for WordPress β¦ developers to contribute. I am open to all kinds of new NodeJS packages and workflows. I can always host custom, opioniated workflows in form of a separate branch and WPGulp. Just make sure you follow the WordPress Coding Standards.
- FIX: Required
gulp-wp-pot
- FIX: Required
gulp-sort
- IMPROVEMENT: Better docs for Translation variables
- NEW: Documentation update
README.md
- TASK: Image optimization
gulp images
- TASK: WP POT Translation file generation
gulp translate
- BrowserSync
- LineEndings
- First version
- CSS, JS, PHP and Watch Routines
Released under GNU GPLv2.0 or later license. Copyright Ahmad Awais
π β If 500 people signup here, I will build a video series for WPGulp.