position: true by default

Author: jonathanong

History.md

@@ -4,6 +4,7 @@
  * rename source to filename
    - `source` is now the CSS string
    - `filename` is now the optional filename
+ * changed default `options.position` value to `true`
 
 1.7.0 / 2013-12-21
 ==================

Readme.md

@@ -24,6 +24,26 @@ console.log(JSON.stringify(output_obj, null, 2));
 
 ````
 
+## API
+
+### var ast = parse(css, [options])
+
+`options`:
+
+- `filename` - recommended for debugging
+- `position` - `true` by default.
+
+### Errors
+
+Errors will have `err.position` where `position` is:
+
+- `start` - start line and column numbers
+- `end` - end line and column numbers
+- `filename` - filename if passed to options
+- `source` - source CSS string
+
+If you create any errors in plugins such as in [rework](https://github.com/visionmedia/rework), you __must__ set the `position` as well for consistency.
+
 ## Example
 
 css:

index.js

@@ -1,5 +1,6 @@
 module.exports = function(css, options){
   options = options || {};
+  options.position = options.position === false ? false : true;
 
   /**
    * Positional.

test/css-parse.js

@@ -16,9 +16,22 @@ describe('parse(str)', function(){
     it('should parse ' + file, function(){
       var css = read(path.join('test', 'cases', file + '.css'), 'utf8');
       var json = read(path.join('test', 'cases', file + '.json'), 'utf8');
-      var ret = parse(css, { position: true, filename: file + '.css' });
+      var ret = parse(css, { filename: file + '.css' });
       ret = JSON.stringify(ret, null, 2);
       ret.should.equal(json);
     })
   });
+
+  it('should save the filename and source', function(){
+    var css = 'booty {\n  size: large;\n}\n';
+    var ast = parse(css, {
+      filename: 'booty.css'
+    });
+
+    var position = ast.stylesheet.rules[0].position
+    position.start.should.be.ok;
+    position.end.should.be.ok;
+    position.filename.should.equal('booty.css');
+    position.source.should.equal(css);
+  });
 })