@madebyseed/seed-cli-tools 1.0.0

package/.babelrc

@@ -0,0 +1,3 @@
+{
+  "presets": ["@babel/preset-env"]
+}

package/.eslintrc

@@ -0,0 +1,7 @@
+{
+  "env": {
+    "node": true
+  },
+  "parser": "babel-eslint",
+  "extends": "eslint:recommended"
+}

package/lib/commands/deploy.js

@@ -0,0 +1,29 @@
+"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"])('slate-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 () {
+    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]), {
+      detached: false,
+      stdio: 'inherit'
+    });
+  });
+}

package/lib/commands/watch.js

@@ -0,0 +1,56 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = _default;
+
+var _chalk = require("chalk");
+
+var _figures = _interopRequireDefault(require("figures"));
+
+var _crossSpawn = _interopRequireDefault(require("cross-spawn"));
+
+var _debug = _interopRequireDefault(require("debug"));
+
+var _config = _interopRequireDefault(require("../config"));
+
+var _utils = require("../utils");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
+
+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 () {
+    var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    logger("--gulpfile ".concat(_config["default"].gulpFile));
+    logger("--cwd ".concat(_config["default"].themeRoot));
+    var store = (0, _utils.getStoreName)(_config["default"].themeRoot);
+
+    if (!store) {
+      console.log("");
+      console.log((0, _chalk.red)("  ".concat(_figures["default"].cross, " no store field in seed.config.js")));
+      console.log("    Add 'store: <store.myshopify.com>' to your project seed.config.js");
+      console.log("");
+      return;
+    }
+
+    console.log("Logging into ".concat((0, _chalk.yellow)(store), " with Shopify CLI..."));
+
+    var loginProcess = _utils.shopifyCLI.login(store);
+
+    if (loginProcess.error) {
+      console.log("");
+      console.log((0, _chalk.red)("  ".concat(_figures["default"].cross, " Failed logging into ").concat(store, ", are you sure you're using the correct account?")));
+      console.log("");
+      return;
+    }
+
+    var gulpArgs = ["watch", "--gulpfile", _config["default"].gulpFile, "--cwd", _config["default"].themeRoot, "--environment", options.env];
+    (0, _crossSpawn["default"])(_config["default"].gulp, gulpArgs, {
+      detached: false,
+      stdio: "inherit"
+    });
+  });
+}

package/lib/config.js

@@ -0,0 +1,28 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+
+var _path = require("path");
+
+var _fs = require("fs");
+
+var _findRoot = _interopRequireDefault(require("find-root"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
+
+var workingDirectory = process.cwd();
+var currentDirectory = __dirname;
+var themeRoot = (0, _findRoot["default"])(workingDirectory);
+var defaultGulpPath = (0, _path.join)(themeRoot, (0, _path.normalize)("node_modules/.bin/gulp")); // Legacy path for older versions of Node.
+
+var legacyGulpPath = (0, _path.join)(themeRoot, (0, _path.normalize)("node_modules/seed-cli-tools/node_modules/.bin/gulp"));
+var config = {
+  gulpFile: (0, _path.join)(currentDirectory, "gulpfile.js"),
+  gulp: (0, _fs.existsSync)(defaultGulpPath) ? defaultGulpPath : legacyGulpPath,
+  themeRoot: themeRoot
+};
+var _default = config;
+exports["default"] = _default;

package/lib/gulpfile.js

@@ -0,0 +1,48 @@
+"use strict";
+
+var gulp = require('gulp'); // const argv = require('yargs').argv;
+
+
+var runSequence = require('gulp4-run-sequence'); // imports gulp tasks from the `tasks` directory
+
+
+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')));
+/**
+ * Does a full clean/rebuild of your theme and creates a `.zip` compatible with
+ * shopify.
+ *
+ * @function zip
+ * @memberof slate-cli.tasks
+ * @static
+ */
+
+gulp.task('zip', function (done) {
+  runSequence('build:zip', 'compress', done);
+});
+/**
+ * Simple wrapper around src & dist watchers
+ *
+ * @summary Monitor your codebase for file changes and take the appropriate
+ *   action
+ * @function watch
+ * @memberof slate-cli.tasks.watch
+ * @static
+ */
+
+gulp.task('watch', gulp.series('build', gulp.parallel('watch:src', 'watch: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
+ * `dist` in the build
+ *
+ * @summary Deploy your built files to the Shopify Store set in
+ *   `slate-cli.config`
+ * @function deploy:manual
+ * @memberof slate-cli.tasks.deploy
+ * @static
+ */
+
+gulp.task('deploy', gulp.series('build', 'deploy:dist'));

package/lib/tasks/build-assets.js

@@ -0,0 +1,89 @@
+"use strict";
+
+var gulp = require('gulp');
+
+var plumber = require('gulp-plumber');
+
+var chokidar = require('chokidar');
+
+var vinylPaths = require('vinyl-paths');
+
+var del = require('del');
+
+var size = require('gulp-size');
+
+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];
+/**
+ * Copies assets to the `/dist` directory
+ *
+ * @param {Array} files
+ * @returns {Stream}
+ * @private
+ */
+
+function processAssets(files) {
+  messages.logProcessFiles('build:assets');
+  return gulp.src(files, {
+    base: config.src.root
+  }).pipe(plumber(utils.errorHandler)).pipe(size({
+    showFiles: true,
+    pretty: true
+  })).pipe(gulp.dest(config.dist.root));
+}
+/**
+ * Deletes specified files
+ *
+ * @param {Array} files
+ * @returns {Stream}
+ * @private
+ */
+
+
+function removeAssets(files) {
+  messages.logProcessFiles('remove:assets');
+  var mapFiles = files.map(function (file) {
+    var distFile = file.replace(config.src.root, config.dist.root);
+    return distFile;
+  });
+  return gulp.src(mapFiles).pipe(plumber(utils.errorHandler)).pipe(vinylPaths(del)).pipe(size({
+    showFiles: true,
+    pretty: true
+  }));
+}
+/**
+ * Copies assets to the `/dist` directory
+ *
+ * @function build:assets
+ * @memberof seed-cli.tasks.build
+ * @static
+ */
+
+
+gulp.task('build:assets', function () {
+  return processAssets(assetsPaths);
+});
+/**
+ * Watches assets in the `/src` directory
+ *
+ * @function watch:assets
+ * @memberof seed-cli.tasks.watch
+ * @static
+ */
+
+gulp.task('watch:assets', function () {
+  var eventCache = utils.createEventCache();
+  chokidar.watch(assetsPaths, {
+    ignored: /(^|[/\\])\../,
+    ignoreInitial: true
+  }).on('all', function (event, path) {
+    messages.logFileEvent(event, path);
+    eventCache.addEvent(event, path);
+    utils.processCache(eventCache, processAssets, removeAssets);
+  });
+});

package/lib/tasks/build-css.js

@@ -0,0 +1,58 @@
+"use strict";
+
+var gulp = require('gulp');
+
+var sass = require('gulp-sass')(require('sass'));
+
+var postcss = require('gulp-postcss');
+
+var cssimport = require('gulp-cssimport');
+
+var plumber = require('gulp-plumber');
+
+var chokidar = require('chokidar');
+
+var config = require('./includes/config.js'); // const utils = require('./includes/utilities.js');
+
+
+var messages = require('./includes/messages.js');
+/**
+ * Concatenate css via gulp-cssimport and copys to the `/dist` folder
+ *
+ * @param {Array} files
+ * @returns {Stream}
+ * @private
+ */
+
+
+function processCss() {
+  return gulp.src(config.roots.css).pipe(plumber()).pipe(sass().on('error', sass.logError)).pipe(postcss(config.plugins.postcss)).pipe(cssimport()).pipe(gulp.dest(config.dist.assets));
+}
+/**
+ * Concatenate css via gulp-cssimport
+ *
+ * @function build:css
+ * @memberof seed-cli.tasks.build
+ * @static
+ */
+
+
+gulp.task('build:css', function () {
+  return processCss();
+});
+/**
+ * Watches css in the `/src` directory
+ *
+ * @function watch:css
+ * @memberof seed-cli.tasks.watch
+ * @static
+ */
+
+gulp.task('watch:css', function () {
+  chokidar.watch(config.src.css, {
+    ignoreInitial: true
+  }).on('all', function (event, path) {
+    messages.logFileEvent(event, path);
+    processCss();
+  });
+});

package/lib/tasks/build-js.js

@@ -0,0 +1,52 @@
+"use strict";
+
+var gulp = require('gulp');
+
+var uglify = require('gulp-uglify');
+
+var include = require('gulp-include');
+
+var plumber = require('gulp-plumber');
+
+var chokidar = require('chokidar');
+
+var config = require('./includes/config.js');
+
+var messages = require('./includes/messages.js'); // const utils = require('./includes/utilities.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));
+}
+
+function processVendorJs() {
+  messages.logProcessFiles('build:vendor-js');
+  return gulp.src(config.roots.vendorJs).pipe(plumber()).pipe(include()).pipe(uglify({
+    mangle: true,
+    compress: true
+  })).pipe(gulp.dest(config.dist.assets));
+}
+
+gulp.task('build:js', function () {
+  return processThemeJs();
+});
+gulp.task('watch:js', function () {
+  chokidar.watch([config.src.js, "!".concat(config.roots.vendorJs), "!".concat(config.src.vendorJs)], {
+    ignoreInitial: true
+  }).on('all', function (event, path) {
+    messages.logFileEvent(event, path);
+    processThemeJs();
+  });
+});
+gulp.task('build:vendor-js', function () {
+  return processVendorJs();
+});
+gulp.task('watch:vendor-js', function () {
+  chokidar.watch([config.roots.vendorJs, config.src.vendorJs], {
+    ignoreInitial: true
+  }).on('all', function (event, path) {
+    messages.logFileEvent(event, path);
+    processVendorJs();
+  });
+});

package/lib/tasks/build-svg.js

@@ -0,0 +1,94 @@
+"use strict";
+
+var gulp = require('gulp');
+
+var vinylPaths = require('vinyl-paths');
+
+var del = require('del');
+
+var size = require('gulp-size');
+
+var chokidar = require('chokidar');
+
+var svgmin = require('gulp-svgmin');
+
+var cheerio = require('gulp-cheerio');
+
+var extReplace = require('gulp-ext-replace');
+
+var plumber = require('gulp-plumber');
+
+var config = require('./includes/config.js');
+
+var utils = require('./includes/utilities.js');
+
+var messages = require('./includes/messages.js');
+/**
+ * Processing for SVGs prior to deployment - adds accessibility markup, and converts
+ * the file to a liquid snippet.
+ *
+ * @param {String|Array} files - glob/array of files to match & send to the stream
+ * @returns {Stream}
+ * @private
+ */
+
+
+function processIcons(files) {
+  messages.logProcessFiles('build:svg');
+  return gulp.src(files).pipe(plumber(utils.errorHandler)).pipe(svgmin()).pipe(cheerio(config.plugins.cheerio)).pipe(extReplace('.liquid')).pipe(size({
+    showFiles: true,
+    pretty: true
+  })).pipe(gulp.dest(config.dist.snippets));
+}
+/**
+ * Cleanup/remove liquid snippets from the `dist` directory during watch tasks if
+ * any underlying SVG files in the `src` folder have been removed.
+ *
+ * @param {String|Array} files - glob/array of files to match & send to the stream
+ * @returns {Stream}
+ * @private
+ */
+
+
+function removeIcons(files) {
+  messages.logProcessFiles('remove:svg');
+  var mapFiles = files.map(function (file) {
+    var distFile = file.replace('src/icons', 'dist/snippets');
+    var snippetFile = distFile.replace('.svg', '.liquid');
+    return snippetFile;
+  });
+  return gulp.src(mapFiles).pipe(plumber(utils.errorHandler)).pipe(vinylPaths(del)).pipe(size({
+    showFiles: true,
+    pretty: true
+  }));
+}
+/**
+ * Pre-processing for svg icons
+ *
+ * @function build:svg
+ * @memberof slate-cli.tasks.build
+ * @static
+ */
+
+
+gulp.task('build:svg', function () {
+  return processIcons(config.src.icons);
+});
+/**
+ * Watches source svg icons for changes...
+ *
+ * @function watch:svg
+ * @memberof slate-cli.tasks.watch
+ * @static
+ */
+
+gulp.task('watch:svg', function () {
+  var cache = utils.createEventCache();
+  chokidar.watch([config.src.icons], {
+    ignoreInitial: true
+  }).on('all', function (event, path) {
+    messages.logFileEvent(event, path);
+    cache.addEvent(event, path);
+    utils.processCache(cache, processIcons, removeIcons);
+  });
+});

package/lib/tasks/build-utils.js

@@ -0,0 +1,43 @@
+"use strict";
+
+var gulp = require('gulp');
+
+var del = require('del');
+
+var zip = require('gulp-zip');
+
+var size = require('gulp-size');
+
+var plumber = require('gulp-plumber');
+
+var config = require('./includes/config.js');
+
+var utils = require('./includes/utilities.js');
+/**
+ * Clean up build dirs/files whenever doing a full/clean (re)build.
+ *
+ * @function build:clean
+ * @memberof slate-cli.tasks.build
+ * @static
+ */
+
+
+gulp.task('clean', function () {
+  return del(['upload', 'dist']);
+});
+/**
+ * Compress theme and build a shopify-compatible `.zip` file for uploading to store
+ *
+ * @function compress
+ * @memberof slate-cli.tasks.deploy
+ * @static
+ */
+
+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({
+    showFiles: true,
+    pretty: true
+  })).pipe(gulp.dest('./upload/'));
+});

package/lib/tasks/deploy.js

@@ -0,0 +1,19 @@
+"use strict";
+
+var gulp = require('gulp');
+
+var utils = require('./includes/utilities.js');
+/**
+ * Initiates shopify's cli command 'shopify theme push' on the dist folder, 
+ * pushing it to stores theme
+ * 
+ * @function deploy:dist
+ * @memberof seed-cli.tasks.deploy
+ * @static
+ */
+
+
+gulp.task('deploy:dist', function () {
+  console.log("Running Shopify theme push on ./dist...");
+  return utils.deployDist();
+});

package/lib/tasks/includes/config.js

@@ -0,0 +1,96 @@
+"use strict";
+
+var join = require('path').join;
+
+var logger = require('debug')('seed-tools');
+
+var findRoot = require('find-root');
+
+var autoprefixer = require('autoprefixer');
+
+var tailwindcss = require('tailwindcss');
+
+var argv = require('minimist')(process.argv.slice(2));
+
+var themeRoot = findRoot(process.cwd());
+var pkg = {};
+
+try {
+  pkg = require(join(themeRoot, 'package.json'));
+} catch (err) {
+  logger(err);
+}
+/**
+ * seed-cli configuration object
+ * ## Markdown stuff
+ *
+ * It's a big description written in `markdown`
+ *
+ * Example:
+ *
+ * ```javascript
+ * $('something')
+ *   .something(else);
+ * ```
+ *
+ * @namespace config
+ * @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 {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
+ */
+
+
+var config = {
+  environment: argv.enviroment || 'development',
+  themeRoot: themeRoot,
+  packageJson: pkg,
+  tkConfig: 'config.yml',
+  deployLog: 'deploy.log',
+  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/*'
+  },
+  dist: {
+    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}'
+  },
+  plugins: {
+    cheerio: {
+      run: require('./utilities.js').processSvg
+    },
+    postcss: [tailwindcss({
+      config: join(themeRoot, 'tailwind.config.js')
+    }), autoprefixer()]
+  }
+};
+module.exports = config;