Merge pull request postcss#109 from michael-ciniawsky/fixes

Better Error handling

Author: RyanZim

README.md

@@ -40,18 +40,18 @@ cat input.css | postcss [OPTIONS] > output.css
 |Name|Type|Default|Description|
 |:---|:--:|:-----:|:----------|
 |`-d, --dir`|`{String}`|`undefined`|Output Directory|
+|`-x, --ext`|`{String}`|`extname(output)`|Output File Extension|
 |`-o, --output`|`{String}`|`undefined`|Output File|
-|`-r, --replace`|`{String}`|`undefined`|Input <=> Output|
-|`-x, --extension`|`{String}`|`extname(output)`|Output File Extension|
+|`-r, --replace`|`{String}`|`undefined`|Replace Input <=> Output|
 |`-p, --parser`|`{String}`|`undefined`|Custom PostCSS Parser|
 |`-s, --syntax`|`{String}`|`undefined`|Custom PostCSS Syntax|
 |`-s, --stringifier`|`{String}`|`undefined`|Custom PostCSS Stringifier|
-|`-w, --watch`|`{Boolean}`|`false`|Watch files for changes and recompile as needed
-|`-u, --use`|`{Array}`|`[]`|List of PostCSS Plugins|
-|`-m, --map`|`{Boolean}`|`{ inline: true }`|External Sourcemap|
+|`-w, --watch`|`{Boolean}`|`false`|Enable Watch Mode|
+|`-u, --use`|`{Array}`|`[]`|PostCSS Plugins|
+|`-m, --map`|`{Boolean}`|`{ inline: true }`|External Sourcemaps|
 |`--no-map`|`{Boolean}`|`false`|Disable Sourcemaps|
-|`-e, --env`|`{String}`|`process.env.NODE_ENV`|Shortcut for setting `$NODE_ENV`|
-|`-c, --config`|`{String}`|`dirname(file)`|Path to `postcss.config.js`|
+|`-e, --env`|`{String}`|`process.env.NODE_ENV`|Sets `$NODE_ENV`|
+|`-c, --config`|`{String}`|`dirname(file)`|PostCSS Config Path `postcss.config.js`|
 |`-h, --help`|`{Boolean}`|`false`|CLI Help|
 |`-v, --version`|`{Boolean}`|`false`|CLI Version|
 
@@ -63,7 +63,6 @@ cat input.css | postcss [OPTIONS] > output.css
 If you need to pass options to your plugins, or have a long plugin chain, you'll want to use a configuration file.
 
 **postcss.config.js**
-
 ```js
 module.exports = {
   parser: 'sugarss',
@@ -85,7 +84,6 @@ For more advanced usage it's recommend to to use a function in `postcss.config.j
 |`options`|`{Object}`|`map, parser, syntax, stringifier`|PostCSS Options|
 
 **postcss.config.js**
-
 ```js
 module.exports = (ctx) => ({
   map: ctx.options.map,
@@ -105,7 +103,6 @@ postcss input.sss -p sugarss -o output.css -m
 ```
 
 **postcss.config.js**
-
 ```js
 module.exports = (ctx) => ({
   map: ctx.options.map,

index.js

@@ -3,9 +3,9 @@
 const fs = require('fs-promise')
 const path = require('path')
 
+const ora = require('ora')
 const stdin = require('get-stdin')
 const chalk = require('chalk')
-const ora = require('ora')
 const globber = require('globby')
 const chokidar = require('chokidar')
 
@@ -134,6 +134,8 @@ let output = argv.output
 
 if (argv.map) argv.map = { inline: false }
 
+const spinner = ora()
+
 let config = {
   options: {
     map: argv.map !== undefined ? argv.map : { inline: true },
@@ -146,7 +148,7 @@ let config = {
       try {
         return require(plugin)()
       } catch (e) {
-        error(`PluginError: Cannot find module '${plugin}'`)
+        error(`Plugin Error: Cannot find module '${plugin}'`)
       }
     })
     : []
@@ -159,23 +161,21 @@ Promise.resolve()
   .then(() => {
     if (input && input.length) return globber(input)
 
-    console.warn(chalk.bold.yellow('Warning: No files passed, reading from stdin\n'))
-
-    if (argv.replace || argv.dir) error('Cannot use --dir or --replace when reading from stdin')
+    if (argv.replace || argv.dir) error('Input Error: Cannot use --dir or --replace when reading from stdin')
 
     if (argv.watch) {
-      error('Cannot run in watch mode when reading from stdin')
+      error('Input Error: Cannot run in watch mode when reading from stdin')
     }
 
     return ['stdin']
   })
   .then((i) => {
     if (!i || !i.length) {
-      error('You must pass a valid list of files to parse')
+      error('Input Error: You must pass a valid list of files to parse')
     }
 
     if (i.length > 1 && !argv.dir && !argv.replace) {
-      error('Must use --dir or --replace with multiple input files')
+      error('Input Error: Must use --dir or --replace with multiple input files')
     }
 
     input = i
@@ -227,8 +227,8 @@ function files (files) {
     if (file === 'stdin') {
       return stdin()
         .then((content) => {
-          if (!content) return error('Error: Did not receive any stdin')
-          css(content, 'stdin')
+          if (!content) return error('Input Error: Did not receive any STDIN')
+          return css(content, 'stdin')
         })
     }
 
@@ -254,7 +254,8 @@ function css (css, file) {
 
   const time = process.hrtime()
 
-  const spinner = ora(`Processing ${file}`).start()
+  spinner.text = `Processing ${file}`
+  spinner.start()
 
   return rc(ctx, argv.config)
     .then(() => {
@@ -276,10 +277,9 @@ function css (css, file) {
         options.to = path.resolve(options.to)
       }
 
-      // Can't use external sourcemaps when writing to stdout:
       if (!options.to && config.options.map && !config.options.map.inline) {
         spinner.fail()
-        error('Cannot output external sourcemaps when writing to stdout')
+        error('Output Error: Cannot output external sourcemaps when writing to STDOUT')
       }
 
       return postcss(config.plugins)
@@ -302,7 +302,13 @@ function css (css, file) {
                 )
               )
             }
-          } else process.stdout.write(result.css, 'utf8')
+          } else {
+            spinner.text = chalk.bold.green(
+              `Finished ${file} (${Math.round(process.hrtime(time)[1] / 1e6)}ms)`
+            )
+            spinner.succeed()
+            return process.stdout.write(result.css, 'utf8')
+          }
 
           return Promise.all(tasks)
             .then(() => {
@@ -317,8 +323,7 @@ function css (css, file) {
               return result
             })
         })
-    }).catch(err => {
-      // Fail spinner and send error up the promise chain
+    }).catch((err) => {
       spinner.fail()
       throw err
     })
@@ -342,21 +347,26 @@ function dependencies (results) {
 
 function error (err) {
   if (typeof err === 'string') {
-    // Manual error
-    console.error(chalk.bold.red(err))
+    spinner.fail(chalk.bold.red(err))
   } else if (err.name === 'CssSyntaxError') {
-    // CSS Syntax Error
-    console.error(chalk.bold.red(`${err.file}`))
-    err.message = err.message
-      .substr(err.file.length + 1)
-      .replace(/:\s/, '] ')
+    console.error('\n')
+
+    spinner.text = spinner.text.replace('Processing ', '')
+    spinner.fail(chalk.bold.red(`Syntax Error: ${spinner.text}`))
+
+    if (err.file) {
+      err.message = err.message.substr(err.file.length + 1)
+    } else {
+      err.message = err.message.replace('<css input>:', '')
+    }
+
+    err.message = err.message.replace(/:\s/, '] ')
+
     console.error('\n', chalk.bold.red(`[${err.message}`))
-    console.error('\n', err.showSourceCode(), '\n')
-    // If watch mode, don't exit the process:
+    console.error('\n', err.showSourceCode(), '\n\n')
+
     if (argv.watch) return
   } else {
-    // JS Error
-    // Don't use chalk here; we want a JS stack trace:
     console.error(err)
   }
   process.exit(1)

package.json

@@ -3,7 +3,9 @@
   "version": "3.0.0-beta",
   "description": "CLI for PostCSS",
   "main": "index.js",
-  "engines": { "node": ">=4" },
+  "engines": {
+    "node": ">=4"
+  },
   "bin": {
     "postcss": "./bin/postcss"
   },
@@ -20,20 +22,24 @@
     "get-stdin": "^5.0.1",
     "globby": "^6.1.0",
     "ora": "^1.1.0",
-    "postcss": "^5.2.11",
+    "postcss": "^5.2.16",
     "postcss-load-config": "^1.1.0",
     "postcss-reporter": "^3.0.0",
-    "yargs": "^6.6.0"
+    "yargs": "^7.0.2"
   },
   "devDependencies": {
-    "ava": "^0.18.1",
-    "coveralls": "^2.11.15",
+    "ava": "^0.18.2",
+    "coveralls": "^2.12.0",
     "nyc": "^10.1.2",
     "postcss-import": "^9.1.0",
-    "standard": "^8.6.0",
+    "standard": "^9.0.1",
     "sugarss": "^0.2.0",
     "uuid": "^3.0.1"
   },
+  "files": [
+    "bin",
+    "index.js"
+  ],
   "keywords": [
     "cli",
     "postcss",

test/error.js

@@ -12,23 +12,23 @@ test('multiple input files && --output', (t) => {
   )
   .then(({ err, code }) => {
     t.is(code, 1, 'expected non-zero error code')
-    t.regex(err, /Must use --dir or --replace/)
+    t.regex(err, /Input Error: Must use --dir or --replace/)
   })
 })
 
 test('multiple input files && writing to stdout', (t) => {
   return cli(['test/fixtures/*.css'])
   .then(({ err, code }) => {
     t.is(code, 1, 'expected non-zero error code')
-    t.regex(err, /Must use --dir or --replace/)
+    t.regex(err, /Input Error: Must use --dir or --replace/)
   })
 })
 
 test('--map && writing to stdout', (t) => {
   return cli(['test/fixtures/a.css', '--map'])
   .then(({ err, code }) => {
     t.is(code, 1, 'expected non-zero error code')
-    t.regex(err, /Cannot output external sourcemaps when writing to stdout/)
+    t.regex(err, /Output Error: Cannot output external sourcemaps when writing to STDOUT/)
   })
 })
 
@@ -56,7 +56,7 @@ test('PluginError', (t) => {
   )
   .then(({ err, code }) => {
     t.is(code, 1, 'expected non-zero error code')
-    t.regex(err, /PluginError: Cannot find module 'postcss-plugin'/)
+    t.regex(err, /Plugin Error: Cannot find module 'postcss-plugin'/)
   })
 })