Merge pull request #1130 from colin-marshall/package-task

Reintroduce package task

.gitignore

@@ -7,3 +7,4 @@ config.yml
 *.log
 .idea/
 *.swp
+packaged/

README.md

@@ -58,6 +58,14 @@ When building for production, the CSS and JS will be minified. To minify the ass
 $ npm run build
 ```
 
+#### To create a .zip file of your theme, run:
+
+```
+$ npm run package
+```
+
+Running this command will build and minify the theme's assets and place a .zip archive of the theme in the `packaged` directory. This excludes the developer files/directories from your theme like `/node_modules`, `/src`, etc. to keep the theme lightweight for transferring the theme to a staging or production server.
+
 ### Project structure
 
 In the `/src` folder you will the working files for all your assets. Every time you make a change to a file that is watched by Gulp, the output will be saved to the `/dist` folder. The contents of this folder is the compiled code that you should not touch (unless you have a good reason for it).

config-default.yml

@@ -24,6 +24,21 @@ PATHS:
   # Paths to JavaScript entry points for webpack to bundle modules
   entries:
     - "src/assets/js/app.js"
+  # Paths for the package task to include/exclude in .zip archive
+  package:
+    - "**/*"
+    - "!**/node_modules/**"
+    - "!**/packaged/**"
+    - "!**/src/**"
+    - "!**/codesniffer.ruleset.xml"
+    - "!**/composer.json"
+    - "!**/composer.lock"
+    - "!**/config.yml"
+    - "!**/config.default.yml"
+    - "!**/gulpfile.babel.js"
+    - "!**/package.json"
+    - "!**/package-lock.json"
+    - "!**/webpack.config.js"
 
 # Set to true if you want static asset revisioning, helpful for cache busting
 REVISIONING: false    

gulpfile.babel.js

@@ -8,6 +8,7 @@ import gulp          from 'gulp';
 import rimraf        from 'rimraf';
 import yaml          from 'js-yaml';
 import fs            from 'fs';
+import dateFormat    from 'dateformat';
 import webpackStream from 'webpack-stream';
 import webpack2      from 'webpack';
 import named         from 'vinyl-named';
@@ -67,6 +68,10 @@ gulp.task('build',
 gulp.task('default',
   gulp.series('build', server, watch));
 
+// Package task
+gulp.task('package',
+  gulp.series('build', archive));
+
 // Delete the "dist" folder
 // This happens every time a build starts
 function clean(done) {
@@ -146,6 +151,17 @@ function images() {
     .pipe(gulp.dest(PATHS.dist + '/assets/img'));
 }
 
+// Create a .zip archive of the theme
+function archive() {
+  var time = dateFormat(new Date(), "yyyy-mm-dd_HH-MM");
+  var pkg = JSON.parse(fs.readFileSync('./package.json'));
+  var title = pkg.name + '_' + time + '.zip';
+
+  return gulp.src(PATHS.package)
+    .pipe($.zip(title))
+    .pipe(gulp.dest('packaged'));
+}
+
 // Start BrowserSync to preview the site in
 function server(done) {
   browser.init({

package.json

@@ -9,7 +9,8 @@
   "scripts": {
     "start": "gulp",
     "dev": "gulp build --dev",
-    "build": "gulp build --production"
+    "build": "gulp build --production",
+    "package": "gulp package --production"
   },
   "keywords": [
     "FoundationPress",
@@ -48,6 +49,7 @@
     "gulp-sourcemaps": "^1.6.0",
     "gulp-uglify": "^1.2.0",
     "gulp-util": "^3.0.8",
+    "gulp-zip": "^4.0.0",
     "js-yaml": "^3.4.6",
     "panini": "^1.3.0",
     "rimraf": "^2.4.3",