Merge pull request #1 from uicrooks/dev

v0.2.0

Author: sergejcodes

README.md

@@ -14,13 +14,43 @@
 <h2 align="center">Shopify Theme Lab CLI</h2>
 
 Command Line Interface for [Shopify Theme Lab](https://github.com/uicrooks/shopify-theme-lab).
+> There is no need to install this package locally, `npx` takes care of everything, simply run the commands in your terminal.
 <!-- title / description (end) -->
 
+<!-- system requirements (start) -->
+## System requirements
+
+- Node.js >= `12.0.0`
+<!-- system requirements (end) -->
+
 <!-- commands (start) -->
 ## Commands
+> For all options you can also use the shorthand version, which is the first letter only, with a single dash in front e.g. For `--password` it's `-p`.
 
-Create a local development environment
+**Create a local development environment:**
 ```sh
 $ npx themelab create <directory-name>
 ```
+
+**Create a local development environment from a git repo:**
+```sh
+$ npx themelab create <directory-name> --repo https://github.com/user/repo
+```
+
+**Initialize a remote Shopify theme and create a local config file:**
+> Run in the root directory of your Shopify Theme Lab project!
+```sh
+$ npx themelab shopify:init --password [your-api-password] --store [your-store.myshopify.com] --env [dev or live] --name ['theme name']
+```
+
+**Create a local config file (connect to an existing theme on a remote store):**
+> Run in the root directory of your Shopify Theme Lab project!
+```sh
+$ npx themelab shopify:init --password [your-api-password] --store [your-store.myshopify.com] --env [dev or live] --id [theme-id]
+```
+
+**Display help:**
+```sh
+$ npx themelab --help
+```
 <!-- commands (end) -->

bin/themelab.js

@@ -9,17 +9,31 @@ const { program } = require('commander')
  * setup
  */
 program
+  .storeOptionsAsProperties(false)
   .version(`Shopify Theme Lab CLI ${require('../package').version}`, '-v, --version', 'output the version number')
   .usage('<command> [options]')
 
 /**
  * commands
  */
 program
-  .command('create <project-name>')
-  .description('initialize a Shopify Theme Lab project')
-  .action((projectName) => {
-    require('../lib/create')(projectName)
+  .command('create <directory>')
+  .description('create a Shopify Theme Lab environment')
+  .option('-r, --repo <url>', 'use a git repository url')
+  .action((directory, cmd) => {
+    require('../lib/create')(directory, cmd)
+  })
+
+program
+  .command('shopify:init')
+  .description('initialize theme on remote Shopify store and a local config')
+  .requiredOption('-p, --password <password>', 'Shopify plugin API password')
+  .requiredOption('-s, --store <store>', '[your-store].myshopify.com')
+  .option('-e, --env <env>', 'Environment [dev] or [live]', 'dev')
+  .option('-n, --name <name>', 'Theme name', 'Shopify Theme Lab')
+  .option('-i, --id <id>', 'If you provide a theme id, the command only creates a local config')
+  .action((cmd) => {
+    require('../lib/shopify-init')(cmd)
   })
 
 /**

lib/create.js

@@ -5,22 +5,22 @@ const clone = require('git-clone')
 const spinner = require('./utils/spinner')
 const config = require('./config')
 
-module.exports = async (directory) => {
-  const currentDirectory = process.cwd()
-  const targetDirectory = directory.replace(/\s/, '-')
-  const destinationPath = path.resolve(__dirname, `${currentDirectory}/${targetDirectory}`)
+module.exports = async (directory, cmd) => {
+  spinner.start()
 
-  if (fs.existsSync(destinationPath)) {
-    console.error(chalk.red('directory already exists'))
-    process.exit()
-  }
+  const currentDirectory = process.cwd()
+  const targetDirectory = path.resolve(__dirname, `${currentDirectory}/${directory}`)
+  const repo = cmd.opts().repo || config.repo.env
 
-  await clone(config.repo.env, destinationPath, {} , async () => {
-    spinner.start()
+  clone(repo, targetDirectory, {} , async (e) => {
+    if (e) {
+      spinner.fail(chalk`{red Error: ${e}}`)
+      process.exit()
+    }
 
-    await fs.remove(path.resolve(destinationPath, '.git')) // remove .git directory
+    // remove .git directory
+    await fs.remove(path.resolve(targetDirectory, '.git'))
 
-    console.log(chalk.green(`✓ Shopify Theme Lab project successfully created in ${targetDirectory} directory`))
-    spinner.stop()
+    spinner.succeed(chalk`{green successfully created Shopify Theme Lab environment}`)
   })
 }

lib/shopify-init.js

@@ -0,0 +1,117 @@
+const path = require('path')
+const fs = require('fs-extra')
+const chalk = require('chalk')
+const yaml = require('yaml')
+const axios = require('axios')
+const themeKit = require('@shopify/themekit')
+
+module.exports = async (cmd) => {
+  /**
+   * variables
+   */
+  const options = cmd.opts()
+  const currentDirectory = process.cwd()
+  const configPath = path.resolve(__dirname, `${currentDirectory}/.config/shopify/shopify.${options.env}.yml`)
+  let themeId = options.id || null
+
+  /**
+   * check env value
+   */
+  if (!options.env.match(/^(dev|live)$/)) {
+    console.error(chalk`{red Error: env should be {inverse dev} or {inverse live}}`)
+    process.exit()
+  }
+
+  /**
+   * initialize local config and a remote Shopify theme
+   */
+  const initTheme = async () => {
+    // initialize empty theme on shopify store
+    if (!options.id) {
+      try {
+        const response = await axios.post(
+          `https://${options.store}/admin/api/2020-10/themes.json`,
+          { theme: { name: options.name } },
+          { headers: { 'X-Shopify-Access-Token': options.password } }
+        )
+
+        // assign theme id
+        themeId = response.data.theme.id.toString()
+      } catch (e) {
+        console.error(chalk`{red Error: ${e}}`)
+        process.exit()
+      }
+    }
+
+    // create yaml config
+    const yamlConfig = yaml.stringify({
+      [options.env]: {
+        password: options.password,
+        theme_id: themeId,
+        store: options.store,
+        directory: 'shopify',
+        ignores: [
+          '.config/shopify/.shopifyignore'
+        ]
+      }
+    })
+
+    // write Shopify config file
+    try {
+      await fs.outputFile(configPath, yamlConfig)
+    } catch (e) {
+      console.error(chalk`{red Error: ${e}}`)
+      process.exit()
+    }
+
+    if (!options.id) {
+      // write settings_data.json to shopify/config
+      try {
+        const settingsData = {
+          current: 'Default',
+          presets: {
+            Default: {
+              sections: {
+                'dynamic-section': {
+                  type: 'dynamic-section',
+                  category: 'Text'
+                }
+              },
+              content_for_index: [
+                'dynamic-section'
+              ]
+            }
+          }
+        }
+
+        const settingsFilePath = path.resolve(__dirname, `${currentDirectory}/shopify/config/settings_data.json`)
+
+        // check if settings_data.json already exists and if not then create that file
+        if (!fs.existsSync(settingsFilePath)) {
+          await fs.outputFile(settingsFilePath, JSON.stringify(settingsData, null, 2))
+        }
+      } catch (e) {
+        console.error(chalk`{red Error: ${e}}`)
+        process.exit()
+      }
+
+      // upload Shopify theme to remote
+      try {
+        await themeKit.command('deploy', {
+          config: configPath,
+          env: options.env
+        })
+      } catch (e) {
+        console.error(chalk`{red Error: ${e}}`)
+        process.exit()
+      }
+    }
+
+    console.log(chalk`{green ✓ theme successfully initialized}`)
+  }
+
+  /**
+   * initialize theme
+   */
+  initTheme()
+}

lib/utils/spinner.js

@@ -10,7 +10,9 @@ const ora = require('ora')
  * start: spinner.start('text')
  * stop: spinner.stop()
  */
-const spinner = ora()
+const spinner = ora({
+  color: 'yellow'
+})
 
 /**
  * export