Updating Docs and adding two new optional params to the watch command.

Author: manifestinteractive

bin/cli.js

@@ -41,9 +41,13 @@ const argv = yargs
   .command('list', 'List Configured SFCC Clients')
   .command('delete <client> [instance]', 'Delete Config for Client')
   .command('watch [client] [instance]', 'Watch for Changes and Push Updates', {
-    spinner: {
-      describe: 'Show the watch spinner',
-      default: true
+    log: {
+      describe: 'Pipe Output to Log File ~/.sffc-cli.log',
+      default: false
+    },
+    'errors-only': {
+      describe: 'Only Show Notification for Errors',
+      default: false
     }
   })
   .example('$0 delete my-client sandbox', 'Delete my-client sandbox config')
@@ -56,7 +60,7 @@ const command = argv._[0]
 
 try {
   debug(`Executing ${command}`)
-  require(path.join(__dirname, `../commands/${command}.js`))()
+  require(path.join(__dirname, `../commands/${command}.js`))(argv)
 } catch (err) {
   if (err.code === 'MODULE_NOT_FOUND') {
     console.log(chalk.red.bold(`\n✖ Command 'sfcc ${command}' not recognized\n`))

commands/watch.js

@@ -1,18 +1,23 @@
 const argv = require('minimist')(process.argv.slice(2))
 const chalk = require('chalk')
 const chokidar = require('chokidar')
-const debounce = require('lodash/debounce')
-const notifier = require('node-notifier')
 const ora = require('ora')
 const path = require('path')
 
+const logger = require('../lib/logger')()
+const notify = require('../lib/notify')()
 const config = require('../lib/config')()
 const upload = require('../lib/upload')
 
-module.exports = async () => {
+module.exports = options => {
   let client = argv['_'][1] || null
   let instance = argv['_'][2] || null
   let watching = null
+  let errorMessage
+  let logMessage
+
+  const useLog = options.log
+  const errorsOnly = options.errorsOnly
 
   if (client && instance) {
     watching = config.get(client, instance)
@@ -27,42 +32,74 @@ module.exports = async () => {
   }
 
   if (watching) {
-    const debouncedNotify = debounce(args => notifier.notify(args), 150)
+    let spinner
     const watcher = chokidar.watch('dir', {
       ignored: [/[/\\]\./, '**/node_modules/**'],
       ignoreInitial: true,
       persistent: true,
+      awaitWriteFinish: true,
       atomic: true
     })
 
-    let text = `Watching ${client} ${instance} [Ctrl-C to Cancel]`
-    let spinner = ora(text).start()
-
     // Add Instance Directory to Watch List
     watcher.add(watching.d)
 
     // Watch for File Changes
     watcher.on('change', file => {
-      upload({file, spinner, watching, client, instance})
+      upload({file, spinner, watching, client, instance, options})
     })
     watcher.on('add', file => {
-      upload({file, spinner, watching, client, instance})
+      upload({file, spinner, watching, client, instance, options})
     })
 
-    // Watch for Removing Files
-    watcher.on('unlink', upload)
+    // @TODO: Watch for Removing Files
+    watcher.on('unlink', file => {
+      console.log('UNLINK', file)
+    })
 
     // Watch for Errors
-    watcher.on('error', upload)
+    watcher.on('error', error => {
+      notify({
+        title: `${client} ${instance}`,
+        icon: path.join(__dirname, '../icons/', 'sfcc-error.png'),
+        subtitle: 'WATCH FAILED',
+        message: error,
+        sound: true,
+        wait: true
+      })
 
-    debouncedNotify({
-      title: `${client} ${instance}`,
-      icon: path.join(__dirname, '../icons/', 'sfcc-cli.png'),
-      subtitle: 'STARTING WATCHER',
-      message: 'Waiting for Changes ...'
+      errorMessage = `✖ Watch Error for '${client}' '${instance}': ${error}.`
+      if (useLog) {
+        logger.log(errorMessage)
+      } else {
+        console.log(chalk.red.bold(`\n${errorMessage}`))
+      }
+    })
+
+    watcher.on('ready', () => {
+      if (!errorsOnly) {
+        notify({
+          title: `${client} ${instance}`,
+          icon: path.join(__dirname, '../icons/', 'sfcc-cli.png'),
+          subtitle: 'STARTING WATCHER',
+          message: 'Waiting for Changes ...'
+        })
+      }
+
+      logMessage = `Watching ${client} ${instance}`
+      if (useLog) {
+        logger.log(logMessage, true)
+      } else {
+        spinner = ora(`${logMessage} [Ctrl-C to Cancel]`).start()
+      }
     })
   } else if (client && instance) {
-    console.log(chalk.red(`\n× Config does not contain client '${client}' with instance '${instance}'.`))
-    console.log('Use ' + chalk.cyan('sfcc setup') + ' to get started.\n')
+    errorMessage = `✖ Config does not contain client '${client}' with instance '${instance}'.`
+    if (useLog) {
+      logger.log(errorMessage)
+    } else {
+      console.log(chalk.red.bold(`\n${errorMessage}`))
+      console.log('Use ' + chalk.cyan('sfcc setup') + ' to get started.\n')
+    }
   }
 }

docs/usage.md

@@ -3,11 +3,12 @@
 **[↤ Developer Overview](../README.md)**
 
 Usage
----
+===
 
 > Here is how SFCC CLI can help you with you local development
 
-### Watch
+`sfcc watch`
+---
 
 Watch for any changes to your projects source code, and automagically upload in the background, while you use whatever IDE you want.
 
@@ -23,32 +24,51 @@ If needed to setup multiple clients, or multiple instances for the same client,
 sfcc watch <client> <instance>
 ```
 
-### List
+If you don't want to get notified of every upload, but would rather only get notified about errors, you can pass `--errors-only`:
+
+```bash
+sfcc watch <client> <instance> --errors-only
+```
+
+If you would like to run the watcher as a background process, but capture the log output, you can pass `--log`, and a log will be created at `~/.sfcc-cli.log` ( log is truncated to last 500 lines each time you start a new `watch` ):
+
+```bash
+sfcc watch <client> <instance> --log &
+```
+
+NOTE: To run the background process, you'll need to make sure to add a `&` to the end of the command.  You should see output from that command that looks like `[2] 6768`.  You can bring the process to the foreground by running using the number in the brackets, and running a command like `fg %2`.  You can get a list of all jobs running in the background by running `jobs`.
+
+`sfcc list`
+---
 
 To get a list of your current clients & instances, you can run:
 
 ```bash
 sfcc list
 ```
 
-### Delete
 
-To delete a configuration option, you can pass in a client and instance you want to delete.  Or just delete everything for that clients:
+`sfcc delete`
+---
+
+To delete a configuration option, you can pass in a client and instance you want to delete.  Or just delete everything for that client:
 
 ```bash
 sfcc delete <client> <instance>
 sfcc delete <client>
 ```
 
-### Help
+
+`sfcc help`
+---
 
 You can get help at any time by running:
 
 ```bash
 sfcc help
 ```
 
-You can get help on a specific command by just added `help` to the end of the command:
+You can get help on a specific command by just adding `help` to the end of the command:
 
 ```bash
 sfcc watch help

icons/sfcc-cli.png

@@ -0,0 +1,29 @@
+const fs = require('fs-extra')
+const homedir = require('os').homedir()
+const path = require('path')
+const truncate = require('truncate-logs')
+
+module.exports = () => {
+  const logFile = path.join(homedir, '.sfcc-cli.log')
+
+  fs.ensureFileSync(logFile)
+
+  const createMessage = message => {
+    return new Date().toLocaleString('en-US', {hour12: false}).replace(', ', '-') + ': ' + message + '\n'
+  }
+
+  const log = (message, start) => {
+    // Starting a new Watch, let's clean out some old junk to keep log file down
+    if (start) {
+      truncate([logFile], {lines: 500})
+    }
+
+    fs.appendFile(logFile, createMessage(message), function(err) {
+      if (err) throw err
+    })
+  }
+
+  return {
+    log
+  }
+}

icons/sfcc-error.png

@@ -0,0 +1,6 @@
+const debounce = require('lodash/debounce')
+const notifier = require('node-notifier')
+
+module.exports = () => {
+  return debounce(args => notifier.notify(args), 150)
+}

icons/sfcc-success.png

@@ -1,36 +1,43 @@
-const debounce = require('lodash/debounce')
-const notifier = require('node-notifier')
 const path = require('path')
 const pRetry = require('p-retry')
 
+const logger = require('../lib/logger')()
+const notify = require('../lib/notify')()
 const write = require('./write')
 const mkdirp = require('./mkdirp')
 
-module.exports = async ({file, spinner, watching, client, instance}) => {
+module.exports = async ({file, spinner, watching, client, instance, options}) => {
   const src = path.relative(process.cwd(), file)
-  const debouncedNotify = debounce(args => notifier.notify(args), 150)
   const uploading = new Set()
 
+  const useLog = options.log
+  const errorsOnly = options.errorsOnly
+
   if (!uploading.has(src)) {
     const dir = path.dirname(file).replace(path.normalize(watching.d), '')
     const dest = path.join('/', 'Cartridges', watching.v, dir)
+    const text = `Watching ${client} ${instance} [Ctrl-C to Cancel]`
 
     uploading.add(src)
 
-    debouncedNotify({
-      title: `${client} ${instance}`,
-      icon: path.join(__dirname, '../icons/', 'sfcc-uploading.png'),
-      subtitle: 'UPLOADING ...',
-      message: `${path.basename(src)} => ${dest}`
-    })
+    if (!errorsOnly) {
+      notify({
+        title: `${client} ${instance}`,
+        icon: path.join(__dirname, '../icons/', 'sfcc-uploading.png'),
+        subtitle: 'UPLOADING ...',
+        message: `${path.basename(src)} => ${dest}`
+      })
+    }
 
-    let text = `Watching ${client} ${instance} [Ctrl-C to Cancel]`
+    let logMessage = `Uploading ${file.replace(watching.d, '.')} ...`
 
-    spinner.stopAndPersist({
-      text: `Uploading ${file.replace(watching.d, '.')} ...`
-    })
-    spinner.text = text
-    spinner.start()
+    if (useLog) {
+      logger.log(logMessage)
+    } else {
+      spinner.stopAndPersist({text: logMessage})
+      spinner.text = text
+      spinner.start()
+    }
 
     try {
       const request = {
@@ -47,25 +54,37 @@ module.exports = async ({file, spinner, watching, client, instance}) => {
       await pRetry(tryToMkdir, {retries: 5})
       await pRetry(tryToWrite, {retries: 5})
 
-      debouncedNotify({
-        title: `${client} ${instance}`,
-        icon: path.join(__dirname, '../icons/', 'sfcc-success.png'),
-        subtitle: 'UPLOAD COMPLETE',
-        message: `${path.basename(src)} => ${dest}`
-      })
+      if (!errorsOnly) {
+        notify({
+          title: `${client} ${instance}`,
+          icon: path.join(__dirname, '../icons/', 'sfcc-success.png'),
+          subtitle: 'UPLOAD COMPLETE',
+          message: `${path.basename(src)} => ${dest}`
+        })
+      }
 
-      spinner.text = `${path.basename(src)} pushed to ${client} ${instance}`
-      spinner.succeed()
+      logMessage = `${path.basename(src)} pushed to ${client} ${instance}`
 
-      setTimeout(() => {
-        spinner.text = text
-        spinner.start()
-      }, 3000)
+      if (useLog) {
+        logger.log(logMessage)
+      } else {
+        spinner.text = logMessage
+        spinner.succeed()
+
+        setTimeout(() => {
+          spinner.text = text
+          spinner.start()
+        }, 3000)
+      }
     } catch (err) {
-      spinner.text = err.message
-      spinner.fail()
+      if (useLog) {
+        logger.log('✖ ' + err.message)
+      } else {
+        spinner.text = err.message
+        spinner.fail()
+      }
 
-      debouncedNotify({
+      notify({
         title: `${client} ${instance}`,
         icon: path.join(__dirname, '../icons/', 'sfcc-error.png'),
         subtitle: 'UPLOAD FAILED',