@madebyseed/seed-cli-tools 1.0.1 → 1.2.1

package/src/utils.js

@@ -1,6 +1,7 @@
-import spawn from "cross-spawn"; 
+import spawn from "cross-spawn";
 import { join } from "path";
-import config from "./config"
+import { readFileSync, writeFileSync } from "fs";
+import config from "./config";
 
 /**
  * Wrappers for Shopify CLI commands
@@ -10,81 +11,150 @@ import config from "./config"
  * @memberof seed-cli
  */
 export const shopifyCLI = {
-
   /**
    * shopify login
-   * 
+   *
    * @memberof seed-cli.shopifyCLI
    * @param {string} store - store's myshopify domain name
    * @param {boolean} async - login asynchronously
-   * 
+   *
    * @returns {object} - spawnSync object or, node's <ChildProcess> object if async
    */
   login: (store, async = false) => {
-    const args = ['login', '--store', store];
+    const args = ["login", "--store", store];
     const options = {
       env: process.env,
       stdio: "inherit",
       shell: true,
-    }
-  
-    if (async) 
-      return spawn('shopify', args, options);
-    else 
-      return spawn.sync('shopify', args, options);
+    };
+
+    if (async) return spawn("shopify", args, options);
+    else return spawn.sync("shopify", args, options);
   },
 
   /**
    * shopify theme serve
-   * 
+   *
    * @memberof seed-cli.shopifyCLI
    * @returns {object} - node's ChildProcess
    */
-  serve: () => {
-    return spawn('shopify theme', ['serve'], {
-      cwd: config.themeRoot + '/dist',
+  serve: (options = {}) => {
+    return spawn("shopify theme", ["serve"], {
+      cwd: config.themeRoot + "/dist",
       env: process.env,
       stdio: "inherit",
       shell: true,
-    })
+      ...options,
+    });
   },
 
   /**
    * shopify theme push
-   * 
+   *
    * @memberof seed-cli.shopifyCLI
    * @returns {object} - node's ChildProcess
    */
-  push: () => {
-    return spawn('shopify theme', ['push'], {
-      cwd: config.themeRoot + '/dist',
+  pull: (themeId = null, dir = "./src") => {
+    let args = ["pull"];
+    if (themeId) args = args.concat(["--themeid", themeId, dir]);
+
+    return spawn("shopify theme", args, {
       env: process.env,
       stdio: "inherit",
       shell: true,
-    })
-  }
-}
+    });
+  },
+
+  /**
+   * shopify theme push
+   *
+   * @memberof seed-cli.shopifyCLI
+   * @returns {object} - node's ChildProcess
+   */
+  push: (themeId = null) => {
+    let args = ["push", "--nodelete"];
+    if (themeId) args = args.concat(["--themeid", themeId]);
+
+    return spawn("shopify theme", args, {
+      cwd: config.themeRoot + "/dist",
+      env: process.env,
+      stdio: "inherit",
+      shell: true,
+    });
+  },
+};
 
 /**
  * Get seed.config.js from project root dir
- * 
+ *
  * @param {string} themeRoot - the path to theme root dir
  */
 export function getSeedConfig(themeRoot) {
-  return require(join(themeRoot, 'seed.config.js'));
+  return require(join(themeRoot, "seed.config.js"));
 }
 
 /**
- * Get store name from seed.config.js 
- * 
+ * Get store name from seed.config.js
+ *
  * @param {string} themeRoot - the path to theme root dir
  */
 export function getStoreName(themeRoot) {
   return getSeedConfig(themeRoot).store;
 }
 
+/**
+ * Get theme ID from seed.config.js
+ *
+ * @param {string} themeRoot - the path to theme root dir
+ * @param {string} environment - theme name/environment
+ * @returns {string} themeID
+ */
+export function getThemeID(themeRoot, environment) {
+  return getSeedConfig(themeRoot).themes[environment];
+}
 
+/**
+ * Get dev theme ID from seed.config.js
+ *
+ * @param {string} themeRoot - the path to theme root dir
+ * @returns {string} - development store theme ID
+ */
+export function getDevThemeID(themeRoot) {
+  return getSeedConfig(themeRoot).developmentThemeId;
+}
 
+/**
+ * Given a string, finds the first themeID and returns it, if no themeID found
+ * returns false.
+ *
+ * @param {string} string - string to extract theme id from
+ * @return {string|boolean} - themeID or false if not found
+ */
+export function extractThemeId(string) {
+  const regex = /\d{12}/;
+  const match = string.match(regex);
+  return match && match.length ? match[0] : false;
+}
 
+/**
+ * Logs out to terminal the output of a piped child process
+ *
+ * @param {child_process} serveProcess shopify cli serve spawned child process
+ */
+export function logChildProcessOutput(process) {
+  process.stdout.on("data", (data) => {
+    console.log(data);
+  });
+}
 
-
+/**
+ * Writes the development theme ID as a key to seed config file
+ *
+ * @param {string} themeID - development theme ID
+ */
+export function setDevThemeID(themeID) {
+  let data = readFileSync(config.seedConfig, { encoding: "utf8" });
+  data = data.split(config.seedConfigDelimiter);
+  data[1] = `\n  developmentThemeId: '${themeID}'` + "\n};";
+  writeFileSync(config.seedConfig, data.join(config.seedConfigDelimiter));
+}

package/lib/tasks/deploy.js

@@ -1,19 +0,0 @@
-"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/src/tasks/deploy.js

@@ -1,15 +0,0 @@
-const gulp = require('gulp');
-const 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', () => {
-  console.log("Running Shopify theme push on ./dist...")
-  return utils.deployDist();
-})