Merge pull request #79 from csscomb/eof-newline

Option: eof-newline (close #50)

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",

README.md

@@ -48,6 +48,7 @@ Example configuration:
     "color-case": "lower",
     "color-shorthand": true,
     "element-case": "lower",
+    "eof-newline": true,
     "leading-zero": false,
     "rule-indent": true,
     "stick-brace": true,
@@ -238,6 +239,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`
@@ -341,9 +354,9 @@ 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/csscomb.js

@@ -17,6 +17,7 @@ var Comb = function() {
         'element-case',
         'leading-zero',
         'strip-spaces',
+        'eof-newline',
         'stick-brace',
         'colon-space',
         'combinator-space',

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/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');
     }
 
 };

test/eof-newline.js

@@ -0,0 +1,34 @@
+var Comb = require('../lib/csscomb');
+var assert = require('assert');
+
+describe('options/eof-newline', function() {
+    var comb;
+    beforeEach(function() {
+        comb = new Comb();
+    });
+    it('Invalid value should not change trim trailing brac', function() {
+        comb.configure({ 'eof-newline': 'foobar' });
+        assert.equal(
+            comb.processString('a { color: red }  \n'),
+            'a { color: red }  \n'
+        );
+    });
+    it('Boolean true value should insert line-break at eof', function() {
+        comb.configure({ 'eof-newline': true });
+        assert.equal(
+            comb.processString(
+                'a {color:red}  '
+            ),
+            'a {color:red}  \n'
+        );
+    });
+    it('Boolean false value should remove line-break from eof', function() {
+        comb.configure({ 'eof-newline': false });
+        assert.equal(
+            comb.processString(
+                'a {color:red}  \n'
+            ),
+            'a {color:red}  '
+        );
+    });
+});

test/strip-spaces.js

@@ -6,24 +6,33 @@ describe('options/strip-space', function() {
     beforeEach(function() {
         comb = new Comb();
     });
-    it('Invalid value should not change trim trailing brace', function() {
+    it('Invalid value should not trim trailing spaces', function() {
         comb.configure({ 'strip-spaces': 'foobar' });
         assert.equal(
-            comb.processString('a { color: red }'),
-            'a { color: red }'
+            comb.processString('a { color: red }  \n'),
+            'a { color: red }  \n'
         );
     });
-    it('True Boolean value should trim all trailing spaces', function() {
+    it('Boolean true value should trim all trailing spaces', function() {
         comb.configure({ 'strip-spaces': true });
         assert.equal(
             comb.processString(
                 'a { color: red }   \n' +
-                'a{color:red}\t /* foobar */ \n' +
-                'a {color:red}'
+                'a{color:red}\t /* foobar */\t \n' +
+                'a {color:red}  \n   \n'
             ),
             'a { color: red }\n' +
             'a{color:red}\t /* foobar */\n' +
             'a {color:red}\n'
         );
     });
+    it('Boolean true value should trim trailing spaces at eof', function() {
+        comb.configure({ 'strip-spaces': true });
+        assert.equal(
+            comb.processString(
+                'a {color:red}  '
+            ),
+            'a {color:red}'
+        );
+    });
 });