v0.0.14

Author: mishanga

.csscomb.json

@@ -10,6 +10,7 @@
     "color-shorthand": true,
     "combinator-space": true,
     "element-case": "lower",
+    "eof-newline": true,
     "leading-zero": false,
     "rule-indent": true,
     "stick-brace": "\n",

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 0.0.14 - 2013-09-12
+- Option: eof-newline (#55)
+- Verbose option (#62)
+- Some refactoring
+
 ## 0.0.13 - 2013-09-12
 - Fixed failing on empty files (#66)
 

README.md

@@ -40,12 +40,15 @@ Example configuration:
 ```json
 {
     "exclude": ["node_modules/**"],
+    "verbose": true,
+
     "always-semicolon": true,
     "block-indent": true,
     "colon-space": true,
     "color-case": "lower",
     "color-shorthand": true,
     "element-case": "lower",
+    "eof-newline": true,
     "leading-zero": false,
     "rule-indent": true,
     "stick-brace": true,
@@ -56,9 +59,30 @@ Example configuration:
 
 ## Options
 
+### verbose
+
+Available value: `{Boolean}` `true`
+
+Config mode: `{ "verbose": true }`
+```bash
+$ ./bin/csscomb ./test
+✓ test/integral.origin.css
+  test/integral.expect.css
+
+2 files processed
+1 file fixed
+96 ms spent
+```
+
+CLI mode:
+```bash
+$ ./bin/csscomb ./test --verbose
+$ ./bin/csscomb ./test -v
+```
+
 ### always-semicolon
 
-Available value: `{Boolean}` true
+Available value: `{Boolean}` `true`
 
 Example: `{ "always-semicolon": true }`
 
@@ -75,9 +99,9 @@ a { color: red; }
 **Note**: better to use with [rule-indent](#rule-indent)
 
 Available values:
-  * `{Boolean}` true (means 4 spaces)
+  * `{Boolean}` `true` (means 4 spaces)
   * `{Number}` of spaces
-  * `{String}` of whitespace characters (`/[ \t]*/`)
+  * `{String}` of whitespace characters (`/[ \t]+/`)
 
 Example: `{ "block-indent": 2 }`
 
@@ -98,7 +122,7 @@ a { color: red
 ### colon-space
 
 Available values:
-  * `{Boolean}` true (means `after`)
+  * `{Boolean}` `true` (means `after`)
   * `{String}`: `before`, `after`, `both` or any combination of whitespaces
   and/or a colon (` `, `: `, `\t:\n\t` etc.)
 
@@ -217,6 +241,18 @@ li > a { color: red }
 LI > A { color: red }
 ```
 
+### eof-newline
+
+Available values: `{Boolean}` `true` or `false`
+
+Example: `{ "eof-newline": true }`
+
+`a { color: red }` → `a { color: red }\n`
+
+Example: `{ "eof-newline": false }`
+
+`a { color: red }\n` → `a { color: red }`
+
 ### leading-zero
 
 Available values: `{Boolean}` `true` or `false`
@@ -236,9 +272,9 @@ p { padding: .5em }
 **Note**: better to use with [block-indent](#block-indent)
 
 Available values:
-  * `{Boolean}` true (means 4 spaces)
+  * `{Boolean}` `true` (means 4 spaces)
   * `{Number}` of spaces
-  * `{String}` of whitespace characters (`/[ \t]*/`)
+  * `{String}` of whitespace characters (`/[ \t]+/`)
 
 Example: `{ "rule-indent": 2 }`
 
@@ -300,8 +336,9 @@ p {
 ### stick-brace
 
 Available values:
-  * `{Boolean}` true (means 1 spaces)
-  * `{String}` of whitespace characters (`/[ \t\n]*/`)
+  * `{Boolean}` `true` (means 1 space)
+  * `{Number}` of spaces
+  * `{String}` of whitespace characters (`/[ \t\n]+/`)
 
 Example: `{ "stick-brace": "\n" }`
 
@@ -316,13 +353,13 @@ a
 
 ### strip-spaces
 
-Available value: `{Boolean}` true
+Available value: `{Boolean}` `true`
 
 Example: `{ "strip-spaces": true }`
 
-Before: `a { color: red } \nb { font-weight: normal }\n\n\n`
+`a { color: red } \n \n \n` → `a { color: red }\n`
 
-After: `a { color: red }\nb { font-weight: normal }\n`
+`a { color: red }\t` → `a { color: red }`
 
 ### unitless-zero
 

lib/cli.js

@@ -2,7 +2,7 @@
  * Command line implementation for CSSComb
  *
  * Usage example:
- * ./node_modules/.bin/csscomb file1 [dir1 [fileN [dirN]]]
+ * ./node_modules/.bin/csscomb [options] file1 [dir1 [fileN [dirN]]]
  */
 var fs = require('fs');
 var program = require('commander');
@@ -12,6 +12,7 @@ var Comb = require('./csscomb');
 program
     .version(require('../package.json').version)
     .usage('[options] <file ...>')
+    .option('-v, --verbose', 'verbose mode')
     .option('-c, --config [path]', 'configuration file path')
     .parse(process.argv);
 
@@ -24,12 +25,22 @@ var configPath = program.config || (process.cwd() + '/.csscomb.json');
 
 if (fs.existsSync(configPath)) {
     var comb = new Comb();
-    comb.configure(require(configPath));
+    var config = require(configPath);
+    var time = new Date();
+    config.verbose = program.verbose === true || config.verbose;
+    comb.configure(config);
     vow.all(program.args.map(function(path) {
         return comb.processPath(path);
     })).fail(function(e) {
         console.log('stack: ', e.stack);
         process.exit(1);
+    }).always(function() {
+        if (config.verbose) {
+            console.log('');
+            console.log(comb.processed + ' file' + (comb.processed === 1 ? '' : 's') + ' processed');
+            console.log(comb.changed + ' file' + (comb.changed === 1 ? '' : 's') + ' fixed');
+            console.log((new Date().getTime() - time.getTime()) + ' ms spent');
+        }
     });
 } else {
     console.log('Configuration file ' + configPath + ' was not found.');

lib/csscomb.js

@@ -17,6 +17,7 @@ var Comb = function() {
         'element-case',
         'leading-zero',
         'strip-spaces',
+        'eof-newline',
         'stick-brace',
         'colon-space',
         'combinator-space',
@@ -52,6 +53,10 @@ Comb.prototype = {
         this._exclude = (config.exclude || []).map(function(pattern) {
             return new minimatch.Minimatch(pattern);
         });
+
+        this.processed = 0;
+        this.changed = 0;
+        this._verbose = config.verbose;
     },
 
     /**
@@ -115,7 +120,13 @@ Comb.prototype = {
         var _this = this;
         if (this._shouldProcess(path) && path.match(/\.css$/)) {
             return vfs.read(path, 'utf8').then(function(data) {
-                return vfs.write(path, _this.processString(data, path), 'utf8');
+                var processedData = _this.processString(data, path);
+                var changed = data !== processedData;
+                return vfs.write(path, processedData, 'utf8').then(function() {
+                    _this.processed++;
+                    if (changed) _this.changed++;
+                    if (_this._verbose) console.log((changed ? '✓' : ' ') + ' ' + path);
+                });
             });
         }
         return null;

lib/options/block-indent.js

@@ -7,12 +7,12 @@ module.exports = {
      * @returns {Object|undefined}
      */
     setValue: function(value) {
-        this._value = false;
-        if (value === true) value = 4;
-        if (typeof value === 'number' && value === Math.abs(Math.round(value))) value = new Array(value + 1).join(' ');
-        if (typeof value === 'string' && value.match(/^[ \t]*$/)) this._value = value;
-        if (!this._value) return;
-        return this;
+        delete this._value;
+        if (value === true) this._value = '    ';
+        if (typeof value === 'number' && value === Math.abs(Math.round(value)))
+            this._value = new Array(value + 1).join(' ');
+        if (typeof value === 'string' && value.match(/^[ \t]+$/)) this._value = value;
+        if (typeof this._value === 'string') return this;
     },
 
     /**

lib/options/eof-newline.js

@@ -0,0 +1,33 @@
+module.exports = {
+
+    /**
+     * Sets handler value.
+     *
+     * @param {Boolean} value Option value
+     * @returns {Object|undefined}
+     */
+    setValue: function(value) {
+        if (value === true || value === false) {
+            this._value = value;
+            return this;
+        }
+    },
+
+    /**
+     * Processes tree node.
+     * @param {String} nodeType
+     * @param {node} node
+     */
+    process: function(nodeType, node) {
+        if (nodeType === 'stylesheet') {
+            var lastChild = node[node.length - 1];
+            if (lastChild[0] !== 's') {
+                lastChild = ['s', ''];
+                node.push(lastChild);
+            }
+            lastChild[1] = lastChild[1].replace(/\n$/, '');
+            if (this._value) lastChild[1] += '\n';
+        }
+    }
+
+};

lib/options/rule-indent.js

@@ -7,12 +7,12 @@ module.exports = {
      * @returns {Object|undefined}
      */
     setValue: function(value) {
-        this._value = false;
-        if (value === true) value = 4;
-        if (typeof value === 'number' && value === Math.abs(Math.round(value))) value = new Array(value + 1).join(' ');
-        if (typeof value === 'string' && value.match(/^[ \t]*$/)) this._value = value;
-        if (!this._value) return;
-        return this;
+        delete this._value;
+        if (value === true) this._value = '    ';
+        if (typeof value === 'number' && value === Math.abs(Math.round(value)))
+            this._value = new Array(value + 1).join(' ');
+        if (typeof value === 'string' && value.match(/^[ \t]+$/)) this._value = value;
+        if (typeof this._value === 'string') return this;
     },
 
     /**

lib/options/stick-brace.js

@@ -7,11 +7,12 @@ module.exports = {
      * @returns {Object|undefined}
      */
     setValue: function(value) {
-        this._value = false;
-        if (value === true) value = ' ';
-        if (typeof value === 'string' && value.match(/^[ \t\n]*$/)) this._value = value;
-        if (!this._value) return;
-        return this;
+        delete this._value;
+        if (value === true) this._value = ' ';
+        if (typeof value === 'number' && value === Math.abs(Math.round(value)))
+            this._value = new Array(value + 1).join(' ');
+        if (typeof value === 'string' && value.match(/^[ \t\n]+$/)) this._value = value;
+        if (typeof this._value === 'string') return this;
     },
 
     /**

lib/options/strip-spaces.js

@@ -19,13 +19,26 @@ module.exports = {
      */
     process: function(nodeType, node) {
         if (nodeType === 's') {
-            node[0] = node[0].replace(/[ \t]+\n/g, '\n');
+            node[0] = this._trim(node[0]);
         }
-
         if (nodeType === 'stylesheet') {
-            if (node[node.length - 1][0] === 's') node.pop();
-            node.push(['s', '\n']);
+            var lastChild = node[node.length - 1];
+            if (lastChild[0] === 's') {
+                lastChild[1] = this._trim(lastChild[1])
+                    .replace(/[ \t]+$/, '')
+                    .replace(/[\n]+/g, '\n');
+            }
         }
+    },
+
+    /**
+     * Trim trailing spaces on each line.
+     * @private
+     * @param {String} s Spaceful string
+     * @returns {String}
+     */
+    _trim: function(s) {
+        return s.replace(/[ \t]+\n/g, '\n');
     }
 
 };