@madebyseed/seed-cli-tools 1.0.1 → 1.2.1

package/lib/commands/deploy.js

@@ -13,17 +13,18 @@ var _config = _interopRequireDefault(require("../config"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
 
-var logger = (0, _debug["default"])('slate-tools:deploy');
+var logger = (0, _debug["default"])("seed-tools:deploy");
 
 function _default(program) {
-  program.command('deploy').alias('d').description('Runs a full deploy of your theme\'s code to a Shopify store specified in config.yml. Existing files will be overwritten.').option('-e, --env <environment>[,<environment>...]', 'Shopify store(s) to deploy code to (specified in config.yml - default: development)', 'development').option('-m, --manual', 'outputs the compiled theme files to <theme>/upload/<theme>.zip for manual deployment').action(function () {
+  program.command("deploy").alias("d").description("Runs a full deploy of your theme's code to a Shopify store specified in seed.config.js. This runs shopify theme push with the --nodelete flag, so that files aren't deleted.").option("-e, --env <environment>[,<environment>...]", "Shopify store(s) to deploy code to (specified in seed.config.js)", "development").option("-s, --skip-optimizations", "Skips asset optimization steps such as compression, minification and purging.", false).action(function () {
     var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
     logger("--gulpfile ".concat(_config["default"].gulpFile));
     logger("--cwd ".concat(_config["default"].themeRoot));
-    var args = ['deploy', '--environment', options.env];
-    (0, _crossSpawn["default"])(_config["default"].gulp, args.concat(['--gulpfile', _config["default"].gulpFile, '--cwd', _config["default"].themeRoot]), {
+    var args = ["deploy", "--environment", options.env];
+    if (options.skipOptimizations) args.push("--skip-optimization");else process.env.NODE_ENV = "production";
+    (0, _crossSpawn["default"])(_config["default"].gulp, args.concat(["--gulpfile", _config["default"].gulpFile, "--cwd", _config["default"].themeRoot]), {
       detached: false,
-      stdio: 'inherit'
+      stdio: "inherit"
     });
   });
 }

package/lib/commands/watch.js

@@ -22,7 +22,7 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "d
 var logger = (0, _debug["default"])("seed-tools:watch");
 
 function _default(program) {
-  program.command("watch").alias("w").description("Watches files for code changes and immediately deploys updates to dev theme as they occur. " + "This uses shopify theme serve under the hood.").action(function () {
+  program.command("watch").alias("w").description("Watches files for code changes and immediately deploys updates to dev theme as they occur. " + "This uses shopify theme serve under the hood.").option("-o, --optimize", "Optimizes assets by compressing, minifying and purging.", false).action(function () {
     var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
     logger("--gulpfile ".concat(_config["default"].gulpFile));
     logger("--cwd ".concat(_config["default"].themeRoot));
@@ -48,6 +48,8 @@ function _default(program) {
     }
 
     var gulpArgs = ["watch", "--gulpfile", _config["default"].gulpFile, "--cwd", _config["default"].themeRoot, "--environment", options.env];
+    if (!options.optimize) gulpArgs.push("--skip-optimization");
+    process.env.NODE_ENV = options.optimize ? 'production' : 'development';
     (0, _crossSpawn["default"])(_config["default"].gulp, gulpArgs, {
       detached: false,
       stdio: "inherit"

package/lib/commands/zip.js

@@ -0,0 +1,27 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = _default;
+
+var _crossSpawn = _interopRequireDefault(require("cross-spawn"));
+
+var _debug = _interopRequireDefault(require("debug"));
+
+var _config = _interopRequireDefault(require("../config"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
+
+var logger = (0, _debug["default"])("seed-tools:zip");
+
+function _default(program) {
+  program.command("zip").alias("z").description("Rebuilds the theme's source files and compresses the output. The compressed file is written to <theme>/upload/<theme>.zip (can be used for manual upload).").action(function () {
+    logger("--gulpfile ".concat(_config["default"].gulpFile));
+    logger("--cwd ".concat(_config["default"].themeRoot));
+    (0, _crossSpawn["default"])(_config["default"].gulp, ["zip", "--gulpfile", _config["default"].gulpFile, "--cwd", _config["default"].themeRoot], {
+      detached: false,
+      stdio: "inherit"
+    });
+  });
+}

package/lib/config.js

@@ -22,7 +22,9 @@ var legacyGulpPath = (0, _path.join)(themeRoot, (0, _path.normalize)("node_modul
 var config = {
   gulpFile: (0, _path.join)(currentDirectory, "gulpfile.js"),
   gulp: (0, _fs.existsSync)(defaultGulpPath) ? defaultGulpPath : legacyGulpPath,
-  themeRoot: themeRoot
+  themeRoot: themeRoot,
+  seedConfig: (0, _path.join)(themeRoot, "seed.config.js"),
+  seedConfigDelimiter: "/** === delimiter */"
 };
 var _default = config;
 exports["default"] = _default;

package/lib/gulpfile.js

@@ -1,15 +1,19 @@
 "use strict";
 
-var gulp = require('gulp'); // const argv = require('yargs').argv;
+var gulp = require("gulp"); // imports gulp tasks from the `tasks` directory
 
 
-var runSequence = require('gulp4-run-sequence'); // imports gulp tasks from the `tasks` directory
-
+require("require-directory")(module, "./tasks");
+/**
+ * Does a full clean/rebuild of your theme
+ *
+ * @function watch
+ * @memberof slate-cli.tasks.watch
+ * @static
+ */
 
-require('require-directory')(module, './tasks');
 
-gulp.task('build', gulp.series('clean', gulp.parallel('build:js', 'build:vendor-js', 'build:css', 'build:assets', 'build:svg')));
-gulp.task('build:zip', gulp.series('clean', gulp.parallel('build:js', 'build:vendor-js', 'build:css', 'build:assets', 'build:svg')));
+gulp.task("build", gulp.series("clean", gulp.parallel("build:js", "build:vendor-js", "build:css", "build:assets", "build:svg")));
 /**
  * Does a full clean/rebuild of your theme and creates a `.zip` compatible with
  * shopify.
@@ -19,20 +23,27 @@ gulp.task('build:zip', gulp.series('clean', gulp.parallel('build:js', 'build:ven
  * @static
  */
 
-gulp.task('zip', function (done) {
-  runSequence('build:zip', 'compress', done);
-});
+gulp.task("zip", gulp.series("build", "compress"));
+/**
+ * Syncronizes the development theme settings with our src folder theme settings
+ *
+ * @function sync-settings
+ * @memberof seed-cli.tasks.deploy
+ * @static
+ */
+
+gulp.task("sync-settings", gulp.series("generate:tmp", "shopify:pull:dev:tmp", "sync-settings:tmp:src"));
 /**
  * Simple wrapper around src & dist watchers
  *
  * @summary Monitor your codebase for file changes and take the appropriate
- *   action
+ * action
  * @function watch
  * @memberof slate-cli.tasks.watch
  * @static
  */
 
-gulp.task('watch', gulp.series('build', gulp.parallel('watch:src', 'watch:dist')));
+gulp.task("watch", gulp.series("build", gulp.parallel("watch:src", "watch:dist", "shopify:serve:dist")));
 /**
  * Does a full (re)build followed by a full deploy, cleaning existing files on
  * the remote server and replacing them with the full set of files pushed to
@@ -40,9 +51,9 @@ gulp.task('watch', gulp.series('build', gulp.parallel('watch:src', 'watch:dist')
  *
  * @summary Deploy your built files to the Shopify Store set in
  *   `slate-cli.config`
- * @function deploy:manual
+ * @function deploy
  * @memberof slate-cli.tasks.deploy
  * @static
  */
 
-gulp.task('deploy', gulp.series('build', 'deploy:dist'));
+gulp.task("deploy", gulp.series("sync-settings", "build", "shopify:push:dist"));

package/lib/tasks/build-css.js

@@ -12,8 +12,7 @@ var plumber = require('gulp-plumber');
 
 var chokidar = require('chokidar');
 
-var config = require('./includes/config.js'); // const utils = require('./includes/utilities.js');
-
+var config = require('./includes/config.js');
 
 var messages = require('./includes/messages.js');
 /**

package/lib/tasks/build-js.js

@@ -2,6 +2,8 @@
 
 var gulp = require('gulp');
 
+var gulpif = require('gulp-if');
+
 var uglify = require('gulp-uglify');
 
 var include = require('gulp-include');
@@ -12,12 +14,11 @@ var chokidar = require('chokidar');
 
 var config = require('./includes/config.js');
 
-var messages = require('./includes/messages.js'); // const utils = require('./includes/utilities.js');
-
+var messages = require('./includes/messages.js');
 
 function processThemeJs() {
   messages.logProcessFiles('build:js');
-  return gulp.src([config.roots.js, "!".concat(config.roots.vendorJs)]).pipe(plumber()).pipe(include()).pipe(gulp.dest(config.dist.assets));
+  return gulp.src([config.roots.js, "!".concat(config.roots.vendorJs)]).pipe(plumber()).pipe(include()).pipe(gulpif(config.optimize, uglify())).pipe(gulp.dest(config.dist.assets));
 }
 
 function processVendorJs() {

package/lib/tasks/build-utils.js

@@ -1,18 +1,43 @@
 "use strict";
 
-var gulp = require('gulp');
+var gulp = require("gulp");
 
-var del = require('del');
+var gulpif = require("gulp-if");
 
-var zip = require('gulp-zip');
+var del = require("del");
 
-var size = require('gulp-size');
+var zip = require("gulp-zip");
 
-var plumber = require('gulp-plumber');
+var size = require("gulp-size");
 
-var config = require('./includes/config.js');
+var plumber = require("gulp-plumber");
 
-var utils = require('./includes/utilities.js');
+var config = require("./includes/config.js");
+
+var utils = require("./includes/utilities.js");
+
+var messages = require("./includes/messages.js");
+
+var assetsPaths = [config.src.assets, config.src.templates, config.src.sections, config.src.snippets, config.src.locales, config.src.config, config.src.layout];
+var themeSettingsAssets = [config.tmp.templates, config.tmp.config];
+/**
+ * Copies files from one fold to another, creating a new dir if doesn't exists and
+ * overwriting if it does exist
+ *
+ * @param {Array} files - files to copy
+ * @param {Object} srcOptions - second param for gulp.src function
+ * @param {String} dest - destination dir
+ * @returns {Stream}
+ * @private
+ */
+
+function copyFiles(files, srcOptions, dest) {
+  var log = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : false;
+  return gulp.src(files, srcOptions).pipe(plumber(utils.errorHandler)).pipe(gulpif(log, size({
+    showFiles: true,
+    pretty: true
+  }))).pipe(gulp.dest(dest));
+}
 /**
  * Clean up build dirs/files whenever doing a full/clean (re)build.
  *
@@ -22,8 +47,8 @@ var utils = require('./includes/utilities.js');
  */
 
 
-gulp.task('clean', function () {
-  return del(['upload', 'dist']);
+gulp.task("clean", function () {
+  return del(["upload", "dist", "tmp"]);
 });
 /**
  * Compress theme and build a shopify-compatible `.zip` file for uploading to store
@@ -33,11 +58,37 @@ gulp.task('clean', function () {
  * @static
  */
 
-gulp.task('compress', function () {
+gulp.task("compress", function () {
   var distFiles = "".concat(config.dist.root, "**/*");
-  var ignoreConfig = "!".concat(config.dist.root, "config.yml");
-  return gulp.src([distFiles, ignoreConfig]).pipe(plumber(utils.errorHandler)).pipe(zip("".concat(config.packageJson.name, ".zip") || 'theme.zip')).pipe(size({
+  return gulp.src([distFiles]).pipe(plumber(utils.errorHandler)).pipe(zip("".concat(config.packageJson.name, ".zip") || "theme.zip")).pipe(size({
     showFiles: true,
     pretty: true
-  })).pipe(gulp.dest('./upload/'));
+  })).pipe(gulp.dest("./upload/"));
+});
+/**
+ * Duplicates /src directory into a /tmp directory
+ *
+ * @function generate:tmp
+ * @memberof seed-cli.tasks.sync-settings
+ * @static
+ */
+
+gulp.task("generate:tmp", function () {
+  messages.logProcessFiles('Generating tmp folder...');
+  return copyFiles(assetsPaths, {
+    base: config.src.root
+  }, config.tmp.root);
+});
+/**
+ * Syncronizes the theme settings of /tmp directory into our src directory
+ *
+ * @function sync-settings:tmp:src
+ * @memberof seed-cli.tasks.sync-settings
+ * @static
+ */
+
+gulp.task("sync-settings:tmp:src", function () {
+  return copyFiles(themeSettingsAssets, {
+    base: config.tmp.root
+  }, config.src.root);
 });

package/lib/tasks/includes/config.js

@@ -1,22 +1,25 @@
 "use strict";
 
-var join = require('path').join;
+var join = require("path").join;
 
-var logger = require('debug')('seed-tools');
+var logger = require("debug")("seed-tools");
 
-var findRoot = require('find-root');
+var findRoot = require("find-root");
 
-var autoprefixer = require('autoprefixer');
+var autoprefixer = require("autoprefixer");
 
-var tailwindcss = require('tailwindcss');
+var tailwindcss = require("tailwindcss");
 
-var argv = require('minimist')(process.argv.slice(2));
+var cssnano = require("cssnano");
+
+var argv = require("minimist")(process.argv.slice(2));
 
 var themeRoot = findRoot(process.cwd());
+var tailwindConfig = 'tailwind.config.js';
 var pkg = {};
 
 try {
-  pkg = require(join(themeRoot, 'package.json'));
+  pkg = require(join(themeRoot, "package.json"));
 } catch (err) {
   logger(err);
 }
@@ -37,10 +40,9 @@ try {
  * @memberof seed-cli
  * @summary Configuring seed-cli
  *  @prop {String} environment - development | staging | production
- *  @prop {String} tkconfig - path to themekit config file
- *  @prop {String} scssLintConfig - path to scss-lint config file
  *  @prop {String} deployLog - path to deploy log file
  *  @prop {String} src - globs (multi-filename matching patterns) for various source files
+ *  @prop {String} tmp - globs (multi-filename matching patterns) for various tmp files
  *  @prop {Object} dist - paths to relevant folder locations in the distributable directory
  *  @prop {Object} roots - array of "root" (entry point) JS & CSS files
  *  @prop {Object} plugins - configuration objects passed to various plugins used in the task interface
@@ -48,49 +50,74 @@ try {
 
 
 var config = {
-  environment: argv.enviroment || 'development',
+  environment: argv.environment || "development",
+  optimize: !argv["skip-optimizations"],
   themeRoot: themeRoot,
   packageJson: pkg,
-  tkConfig: 'config.yml',
-  deployLog: 'deploy.log',
+  tailwindConfig: tailwindConfig,
+  seedConfig: "seed.config.js",
   src: {
-    root: 'src/',
-    js: 'src/scripts/**/*.{js,js.liquid}',
-    vendorJs: 'src/scripts/vendor/*.js',
-    json: 'src/**/*.json',
-    css: 'src/styles/**/*.{css,scss,scss.liquid}',
-    cssLint: 'src/styles/**/*.{css,scss}',
-    vendorCss: 'src/styles/vendor/*.{css,scss}',
-    assets: 'src/assets/**/*',
-    icons: 'src/icons/**/*.svg',
-    templates: 'src/templates/**/*',
-    snippets: 'src/snippets/*',
-    sections: 'src/sections/*',
-    locales: 'src/locales/*',
-    config: 'src/config/*',
-    layout: 'src/layout/*'
+    root: "src/",
+    js: "src/scripts/**/*.{js,js.liquid}",
+    vendorJs: "src/scripts/vendor/*.js",
+    json: "src/**/*.json",
+    css: "src/styles/**/*.{css,scss,scss.liquid}",
+    cssLint: "src/styles/**/*.{css,scss}",
+    vendorCss: "src/styles/vendor/*.{css,scss}",
+    assets: "src/assets/**/*",
+    icons: "src/icons/**/*.svg",
+    templates: "src/templates/**/*",
+    snippets: "src/snippets/*",
+    sections: "src/sections/*",
+    locales: "src/locales/*",
+    config: "src/config/*",
+    layout: "src/layout/*"
+  },
+  tmp: {
+    root: "tmp/",
+    js: "tmp/scripts/**/*.{js,js.liquid}",
+    vendorJs: "tmp/scripts/vendor/*.js",
+    json: "tmp/**/*.json",
+    css: "tmp/styles/**/*.{css,scss,scss.liquid}",
+    cssLint: "tmp/styles/**/*.{css,scss}",
+    vendorCss: "tmp/styles/vendor/*.{css,scss}",
+    assets: "tmp/assets/**/*",
+    icons: "tmp/icons/**/*.svg",
+    templates: "tmp/templates/**/*",
+    snippets: "tmp/snippets/*",
+    sections: "tmp/sections/*",
+    locales: "tmp/locales/*",
+    config: "tmp/config/*",
+    layout: "tmp/layout/*"
   },
   dist: {
-    root: 'dist/',
-    assets: 'dist/assets/',
-    snippets: 'dist/snippets/',
-    sections: 'dist/sections/',
-    layout: 'dist/layout/',
-    templates: 'dist/templates/',
-    locales: 'dist/locales/'
+    root: "dist/",
+    assets: "dist/assets/",
+    snippets: "dist/snippets/",
+    sections: "dist/sections/",
+    layout: "dist/layout/",
+    templates: "dist/templates/",
+    locales: "dist/locales/"
   },
   roots: {
-    js: 'src/scripts/*.{js,js.liquid}',
-    vendorJs: 'src/scripts/vendor.js',
-    css: 'src/styles/*.{css,scss}'
+    js: "src/scripts/*.{js,js.liquid}",
+    vendorJs: "src/scripts/vendor.js",
+    css: "src/styles/*.{css,scss}"
   },
   plugins: {
     cheerio: {
-      run: require('./utilities.js').processSvg
+      run: require("./utilities.js").processSvg
     },
     postcss: [tailwindcss({
-      config: join(themeRoot, 'tailwind.config.js')
+      config: join(themeRoot, tailwindConfig)
     }), autoprefixer()]
   }
 };
+
+if (config.optimize) {
+  config.plugins.postcss.push(cssnano({
+    preset: "default"
+  }));
+}
+
 module.exports = config;

package/lib/tasks/includes/messages.js

@@ -35,7 +35,7 @@ var messages = {
     log('running task', chalk.white('-'), chalk.cyan(processName));
   },
   logChildProcess: function logChildProcess(cmd) {
-    log('running task', chalk.bold('[child process]'), chalk.white('-'), chalk.cyan('theme', cmd));
+    log('running task', chalk.bold('[child process]'), chalk.white('-'), chalk.cyan(cmd));
   },
   logDeploys: function logDeploys(cmd, files) {
     var timestamp = "Deploy complete @ ".concat(new Date(), ". ");
@@ -56,16 +56,16 @@ var messages = {
     log('Updating JS Bundle...');
   },
   configChange: function configChange() {
-    return 'Changes to ThemeKit Config Detected: You may need to quit <slate watch>' + ' and run a full <slate deploy> as a result.';
+    return 'Changes to seed.config.js Detected: You may need to quit <seed watch>' + ' and run a full <seed deploy> as a result.';
   },
   translationsFailed: function translationsFailed() {
     return 'Translation errors detected.';
   },
   invalidThemeId: function invalidThemeId(themeId, env) {
-    log('Invalid theme id for', chalk.cyan("".concat(env, ": ").concat(themeId)), chalk.yellow('`theme_id` must be an integer or "live".'));
+    log('Invalid theme id for', chalk.cyan("".concat(env, ": ").concat(themeId)), chalk.yellow('`theme_id` must be a string.'));
   },
   configError: function configError() {
-    log('File missing:', chalk.yellow('`config.yml` does not exist. You need to add a config file before you can make changes to your Shopify store.'));
+    log('File missing:', chalk.yellow('`seed.config.js` does not exist. You need to add a config file before you can make changes to your Shopify store.'));
   },
   deployTo: function deployTo(environment) {
     log('Initiating deploy to', chalk.bold(environment));

package/lib/tasks/includes/utilities.js

@@ -6,12 +6,9 @@ var chalk = require("chalk");
 
 var log = require("fancy-log");
 
-var _ = require('lodash');
+var _ = require("lodash");
 
-var Promise = require('bluebird');
-
-var _require = require("../../utils"),
-    shopifyCLI = _require.shopifyCLI;
+var Promise = require("bluebird");
 
 var errors = [];
 /**
@@ -23,27 +20,6 @@ var errors = [];
  */
 
 var utilities = {
-  /**
-   * Launches shopify theme serve command to serve files on ./dist folder
-   * 
-   * @memberof seed-cli.utilities
-   * @returns {object} - ChildProcess
-   */
-  serveDist: function serveDist() {
-    return shopifyCLI.serve();
-  },
-
-  /**
-   * Launches shopify theme push command to deploy files on ./dist folder
-   * to a store's theme
-   * 
-   * @memberof seed-cli.utilities
-   * @returns {object} - ChildProcess
-   */
-  deployDist: function deployDist() {
-    return shopifyCLI.push();
-  },
-
   /**
    * Handles the output for any errors that might have been captured
    * during the build and zip Gulp tasks.
@@ -73,7 +49,7 @@ var utilities = {
     log(chalk.red(err));
     errors.push(err);
 
-    _this.emit('end');
+    _this.emit("end");
   },
 
   /**
@@ -100,32 +76,32 @@ var utilities = {
    * @param {fs} file - reference to current icon file?
    */
   processSvg: function processSvg($, file) {
-    var $svg = $('svg'); // eslint-disable-line no-var
+    var $svg = $("svg"); // eslint-disable-line no-var
 
     var $newSvg = $('<svg aria-hidden="true" focusable="false" role="presentation" class="icon" />'); // eslint-disable-line no-var
 
-    var fileName = file.relative.replace('.svg', ''); // eslint-disable-line no-var
+    var fileName = file.relative.replace(".svg", ""); // eslint-disable-line no-var
 
-    var viewBoxAttr = $svg.attr('viewbox'); // eslint-disable-line no-var
+    var viewBoxAttr = $svg.attr("viewbox"); // eslint-disable-line no-var
     // Add necessary attributes
 
     if (viewBoxAttr) {
-      var width = parseInt(viewBoxAttr.split(' ')[2], 10); // eslint-disable-line no-var
+      var width = parseInt(viewBoxAttr.split(" ")[2], 10); // eslint-disable-line no-var
 
-      var height = parseInt(viewBoxAttr.split(' ')[3], 10); // eslint-disable-line no-var
+      var height = parseInt(viewBoxAttr.split(" ")[3], 10); // eslint-disable-line no-var
 
       var widthToHeightRatio = width / height; // eslint-disable-line no-var
 
       if (widthToHeightRatio >= 1.5) {
-        $newSvg.addClass('icon--wide');
+        $newSvg.addClass("icon--wide");
       }
 
-      $newSvg.attr('viewBox', viewBoxAttr);
+      $newSvg.attr("viewBox", viewBoxAttr);
     } // Add required classes to full color icons
 
 
-    if (file.relative.indexOf('-full-color') >= 0) {
-      $newSvg.addClass('icon--full-color');
+    if (file.relative.indexOf("-full-color") >= 0) {
+      $newSvg.addClass("icon--full-color");
     }
 
     $newSvg.addClass(fileName).append($svg.contents());
@@ -145,8 +121,8 @@ var utilities = {
   createEventCache: function createEventCache(options) {
     _.defaults(options = options || {}, {
       // eslint-disable-line no-param-reassign
-      changeEvents: ['add', 'change'],
-      unlinkEvents: ['unlink']
+      changeEvents: ["add", "change"],
+      unlinkEvents: ["unlink"]
     });
     /**
      * A cache object used for caching `[chokidar]{@link https://github.com/paulmillr/chokidar}`