Merge pull request #64 from gmetais/listErrors

Add a listError option for parsing

Author: conradz

Readme.md

@@ -57,13 +57,23 @@ result.map // source map object
 
 ### Errors
 
-Errors will have `error.position`, just like [`node.position`](#position). The
-error contains the source position in the message. To get the error message
-without the position use `error.reason`.
+Errors thrown during parsing have the following properties:
+
+- message: `String`. The full error message with the source position.
+- reason: `String`. The error message without position.
+- filename: `String` or `undefined`. The value of `options.source` if
+  passed to `css.parse`. Otherwise `undefined`.
+- line: `Integer`.
+- column: `Integer`.
+- source: `String`. The portion of code that couldn't be parsed.
+
+When parsing with the `silent` option, errors are listed in the
+`parsingErrors` property of the [`stylesheet`](#stylesheet) node instead
+of being thrown.
 
 If you create any errors in plugins such as in
-[rework](https://github.com/reworkcss/rework), you __must__ set the `position`
-as well for consistency.
+[rework](https://github.com/reworkcss/rework), you __must__ set the same
+properties for consistency.
 
 ## AST
 
@@ -115,6 +125,8 @@ The root node returned by `css.parse`.
 - stylesheet: `Object`:
   - rules: `Array` of nodes with the types `rule`, `comment` and any of the
     at-rule types.
+  - parsingErrors: `Array` of `Error`s. Errors collected during parsing when
+    option `silent` is true.
 
 #### rule
 

lib/parse/index.js

@@ -56,29 +56,35 @@ module.exports = function(css, options){
    * Error `msg`.
    */
 
-  function error(msg) {
-    if (options.silent === true) {
-      return false;
-    }
+  var errorsList = [];
 
+  function error(msg) {
     var err = new Error(options.source + ':' + lineno + ':' + column + ': ' + msg);
     err.reason = msg;
     err.filename = options.source;
     err.line = lineno;
     err.column = column;
     err.source = css;
-    throw err;
+
+    if (options.silent) {
+      errorsList.push(err);
+    } else {
+      throw err;
+    }
   }
 
   /**
    * Parse stylesheet.
    */
 
   function stylesheet() {
+    var rulesList = rules();
+
     return {
       type: 'stylesheet',
       stylesheet: {
-        rules: rules()
+        rules: rulesList,
+        parsingErrors: errorsList
       }
     };
   }

test/parse.js

@@ -52,6 +52,28 @@ describe('parse(str)', function() {
     }).not.throw();
   });
 
+  it('should list the parsing errors and continue parsing', function() {
+    var result = parse('foo { color= red; } bar { color: blue; } baz {}} boo { display: none}', { 
+      silent: true,
+      source: 'foo.css'
+    });
+
+    var rules = result.stylesheet.rules;
+    rules.length.should.be.above(2);
+
+    var errors = result.stylesheet.parsingErrors;
+    errors.length.should.equal(2);
+
+    errors[0].should.have.a.property('message');
+    errors[0].should.have.a.property('reason');
+    errors[0].should.have.a.property('filename');
+    errors[0].filename.should.equal('foo.css');
+    errors[0].should.have.a.property('line');
+    errors[0].should.have.a.property('column');
+    errors[0].should.have.a.property('source');
+
+  });
+
   it('should set parent property', function() {
     var result = parse(
       'thing { test: value; }\n' +