postcss 0.3.4 → 0.3.5

package/ChangeLog.md

@@ -1,3 +1,7 @@
+## 0.3.5
+* Allow to use `Root` or `Result` as first argument in `process()`.
+* Save parsed AST to `Result#root`.
+
 ## 0.3.4
 * Better space symbol detect to read UTF-8 BOM correctly.
 

package/README.md

@@ -26,10 +26,19 @@ Sponsored by [Evil Martians](http://evilmartians.com/).
 * [Autoprefixer] adds vendor prefixes by Can I Use data.
 * [grunt-pixrem], `rem` unit polyfill.
 * [CSS MQPacker] joins same media queries.
-
-[Autoprefixer]: https://github.com/ai/autoprefixer
-[grunt-pixrem]: https://github.com/robwierzbowski/grunt-pixrem
-[CSS MQPacker]: https://github.com/hail2u/node-css-mqpacker
+* [RTLCSS] mirrors styles for right-to-left locales.
+* [CSSWring] and [grunt-csswring] CSS minifier with full source map support.
+* [Grunt-webpcss] to duplicate images in CSS to WebP for supported browsers.
+* [Pleeease] is a pack of various postprocessors.
+
+[grunt-csswring]: https://github.com/princed/grunt-csswring
+[Grunt-webpcss]:  https://github.com/lexich/grunt-webpcss
+[Autoprefixer]:   https://github.com/ai/autoprefixer
+[grunt-pixrem]:   https://github.com/robwierzbowski/grunt-pixrem
+[CSS MQPacker]:   https://github.com/hail2u/node-css-mqpacker
+[Pleeease]:       http://pleeease.io/
+[CSSWring]:       https://github.com/hail2u/node-csswring
+[RTLCSS]:         https://github.com/MohammadYounes/rtlcss
 
 ## Quick Example
 
@@ -183,6 +192,39 @@ Because of this background difference, PostCSS:
 
 ## Usage
 
+You can parse CSS by `postcss.parse()` method, which returns CSS AST:
+
+```js
+var postcss = require('postcss');
+
+var css = postcss.parse('a { color: black }');
+```
+
+Then you can change this AST. Use `css.list` to get childs.
+Properties `rule.selector`, `decl.prop`, `decl.value`, `atrule.name`
+and `atrule.params` contain data.
+
+Don’t use underscore properties (like `_selector`, `_params` and `_value`),
+because they are only for comments save magic
+(See [Raw Properties](#Raw Properties) below). Use getters and setters instead
+(like `selector`, `selectors`, `params` and `value`).
+
+```js
+css.list[0].value = 'white';
+```
+
+After changes you can get new CSS and modification’s source map:
+
+```js
+var result = css.toResult(options);
+
+result.css //=> 'a { color: white }'
+result.map //=> '{"version":3, … }'
+```
+
+Methods `postcss.parse()` and `CSS#toResult()` are low level API, for most cases
+it will be better to create processors with simplier API and chaining.
+
 ### Processor
 
 The function `postcss(fn)` creates a processor from your function:
@@ -247,6 +289,14 @@ processor.process(wrong, { from: 'main.css' });
 //=> Can't parse CSS: Unclosed block at line 1:1 in main.css
 ```
 
+You can also use result from previous postprocessor or already parsed `Root`
+as argument in next one:
+
+```js
+result = processor1.process(css)
+processor2.process(result)
+```
+
 ### Multiple Inputs
 
 The function `postcss()` generates processor only for one input.
@@ -566,7 +616,7 @@ Because CSS have nested structure, PostCSS also contains recursive iterator
 
 ```js
 root.eachInside(function (node, i) {
-    console.log(node.type ' inside ' + parent.type);
+    console.log(node.type + ' inside ' + node.parent.type);
 });
 ```
 
@@ -590,6 +640,8 @@ root.eachComment(function (comment, i) {
 })
 ```
 
+You can break iteration by `return false`.
+
 ### Root Node
 
 `Root` node contains entire CSS tree. Its children can be only `Comment`,

package/lib/map-generator.js

@@ -153,9 +153,9 @@
       this.applyPrevMap();
       this.addAnnotation();
       if (this.isInline()) {
-        return new Result(this.css);
+        return new Result(this.root, this.css);
       } else {
-        return new Result(this.css, this.map.toString());
+        return new Result(this.root, this.css, this.map.toString());
       }
     };
 
@@ -229,7 +229,7 @@
       if (this.isMap()) {
         return this.generateMap();
       } else {
-        return new Result(this.root.toString());
+        return new Result(this.root);
       }
     };
 

package/lib/parse.js

@@ -1,7 +1,7 @@
 (function() {
-  var AtRule, Comment, Declaration, Parser, Raw, Root, Rule, SyntexError;
+  var AtRule, Comment, Declaration, Parser, Raw, Root, Rule, SyntaxError;
 
-  SyntexError = require('./syntax-error');
+  SyntaxError = require('./syntax-error');
 
   Declaration = require('./declaration');
 
@@ -316,7 +316,7 @@
           column: this.column
         };
       }
-      throw new SyntexError(message, this.source, position, this.opts.from);
+      throw new SyntaxError(message, this.source, position, this.opts.from);
     };
 
     Parser.prototype.move = function() {

package/lib/postcss.js

@@ -1,5 +1,5 @@
 (function() {
-  var AtRule, Comment, Declaration, PostCSS, Root, Rule, postcss,
+  var AtRule, Comment, Declaration, PostCSS, Result, Root, Rule, postcss,
     __slice = [].slice;
 
   Declaration = require('./declaration');
@@ -8,6 +8,8 @@
 
   AtRule = require('./at-rule');
 
+  Result = require('./result');
+
   Rule = require('./rule');
 
   Root = require('./root');
@@ -27,7 +29,7 @@
       if (opts == null) {
         opts = {};
       }
-      parsed = postcss.parse(css, opts);
+      parsed = css instanceof Root ? css : css instanceof Result ? parsed = css.root : postcss.parse(css, opts);
       _ref = this.processors;
       for (_i = 0, _len = _ref.length; _i < _len; _i++) {
         processor = _ref[_i];

package/lib/result.js

@@ -2,8 +2,12 @@
   var Result;
 
   Result = (function() {
-    function Result(css, map) {
+    function Result(root, css, map) {
+      this.root = root;
       this.css = css;
+      if (this.css == null) {
+        this.css = this.root.toString();
+      }
       if (map) {
         this.map = map;
       }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "postcss",
-  "version": "0.3.4",
+  "version": "0.3.5",
   "description": "Framework for CSS postprocessors",
   "keywords": ["css", "parser", "postproccessor"],
   "author": "Andrey Sitnik <andrey@sitnik.ru>",
@@ -15,11 +15,11 @@
   },
   "devDependencies": {
     "coffee-script": "1.7.1",
-    "fs-extra":      "0.8.1",
+    "fs-extra":      "0.9.1",
     "gonzales":      "1.0.7",
-    "rework":        "0.20.2",
-    "should":        "3.1.3",
-    "mocha":         "1.17.1",
+    "rework":        "0.20.3",
+    "should":        "4.0.0",
+    "mocha":         "1.20.0",
     "cssom":         "0.3.0"
   },
   "main": "lib/postcss",