Merge pull request #113 from csscomb/tg/always-semicolon

always-semicolon: Support for scss and less

Author: mishanga

README.md

@@ -196,6 +196,8 @@ CLI mode:
 
 ### always-semicolon
 
+Whether to add a semicolon after the last value/mixin.
+
 Available value: `{Boolean}` `true`
 
 Example: `{ "always-semicolon": true }`
@@ -208,6 +210,45 @@ a { color: red }
 a { color: red; }
 ```
 
+Example: `{ "always-semicolon": true }` (scss file):
+
+```scss
+// before
+div {
+    color: tomato;
+    @include nani
+    }
+
+// after
+div {
+    color: tomato;
+    @include nani;
+    }
+```
+
+Note that in `*.scss` and `*.less` files semicolons are not added after `}`
+even if it's part of a value:
+
+```scss
+// before
+div {
+    color: tomato;
+    font: {
+        family: fantasy;
+        size: 16px
+        }
+    }
+
+// after
+div {
+    color: tomato;
+    font: {
+        family: fantasy;
+        size: 16px;
+        }
+    }
+```
+
 ### block-indent
 
 **Note**: better to use with [rule-indent](#rule-indent)

lib/options/always-semicolon.js

@@ -5,6 +5,7 @@ module.exports = {
      *
      * @param {String|Boolean} value Option value
      * @returns {Object|undefined}
+     * TODO: This option accepts only boolean
      */
     setValue: function(value) {
         this._value = value === true;
@@ -20,31 +21,53 @@ module.exports = {
     process: function(nodeType, node) {
         if (nodeType === 'block') {
             for (var i = node.length; i--;) {
-                var nodeItem = node[i];
-                var type = nodeItem[0];
+                var currentNode = node[i];
+                var currentNodeType = currentNode[0];
+                var nodeWithoutSemicolon;
 
-                if (type === 'declDelim') break;
+                // Skip nodes that already have `;` at the end:
+                if (currentNodeType === 'declDelim') break;
 
-                if (type === 'declaration') {
-                    // Look for value node:
-                    var value;
-                    for (var k = nodeItem.length; k--;) {
-                        if (nodeItem[k][0] === 'value') {
-                            value = nodeItem[k];
+                // Add semicolon only after declarations and includes.
+                // If current node is include, insert semicolon right into it.
+                // If it's declaration, look for value node:
+                if (currentNodeType === 'include') {
+                    nodeWithoutSemicolon = currentNode;
+                } else if (currentNodeType === 'declaration') {
+                    for (var k = currentNode.length; k--;) {
+                        if (currentNode[k][0] === 'value') {
+                            nodeWithoutSemicolon = currentNode[k];
                             break;
                         }
                     }
+                } else {
+                    continue;
+                }
 
-                    var space = [];
-                    for (var j = value.length; j--;) {
-                        if (['s', 'commentML', 'commentSL'].indexOf(value[j][0]) === -1) break;
-                        space.unshift(value.splice(j)[0]);
-                    }
-                    node.splice.apply(node, [i + 1, 0, ['declDelim']].concat(space));
-                    break;
+                var space = [];
+                var isBlock = false;
+
+                // Check if there are spaces and comments at the end of the node:
+                for (var j = nodeWithoutSemicolon.length; j--;) {
+                    var lastNode = nodeWithoutSemicolon[j][0];
+                    // If the node's last child is block, do not add semicolon:
+                    // TODO: Add syntax check and run the code only for scss
+                    if (lastNode === 'block') {
+                        isBlock = true;
+                        break;
+                    } else if (['s', 'commentML', 'commentSL'].indexOf(lastNode) === -1) break;
+
+                    space.unshift(nodeWithoutSemicolon[j]);
                 }
+
+                if (isBlock) break;
+
+                // Temporarily remove last spaces and comments and insert `;`
+                // before them:
+                nodeWithoutSemicolon.splice(nodeWithoutSemicolon.length - space.length);
+                node.splice.apply(node, [i + 1, 0, ['declDelim']].concat(space));
+                break;
             }
         }
     }
-
 };

test/always-semicolon-less.js

@@ -0,0 +1,100 @@
+var Comb = require('../lib/csscomb');
+var assert = require('assert');
+var fs = require('fs');
+
+describe('options/always-semicolon (scss)', function() {
+    var comb;
+    var input;
+    var expected;
+
+    function readFile(path) {
+        return fs.readFileSync('test/always-semicolon-less/' + path, 'utf8');
+    }
+
+    beforeEach(function() {
+        comb = new Comb();
+        comb.configure({ 'always-semicolon': true });
+    });
+
+    it('Should not add semicolon to condition (single-line style)', function() {
+        input = readFile('condition.less');
+
+        assert.equal(comb.processString(input, 'less'), input);
+    });
+
+    it('Should not add semicolon to condition (multi-line style)', function() {
+        input = readFile('condition-multiline.less');
+
+        assert.equal(comb.processString(input, 'less'), input);
+    });
+
+    it('Should add semicolon to last included mixin if missing. Test 1 (single-line style)', function() {
+        input = readFile('include-1.less');
+        expected = readFile('include-1.expected.less');
+
+        assert.equal(comb.processString(input, 'less'), expected);
+    });
+
+    it('Should add semicolon to last included mixin if missing. Test 1 (multi-line style)', function() {
+        input = readFile('include-1-multiline.less');
+        expected = readFile('include-1-multiline.expected.less');
+
+        assert.equal(comb.processString(input, 'less'), expected);
+    });
+
+    it('Should add semicolon to last included mixin if missing. Test 2 (single-line style)', function() {
+        input = readFile('include-2.less');
+        expected = readFile('include-2.expected.less');
+
+        assert.equal(comb.processString(input, 'less'), expected);
+    });
+
+    it('Should add semicolon to last included mixin if missing. Test 2 (multi-line style)', function() {
+        input = readFile('include-2-multiline.less');
+        expected = readFile('include-2-multiline.expected.less');
+
+        assert.equal(comb.processString(input, 'less'), expected);
+    });
+
+    it('Should add semicolon to last included mixin if missing. Test 3 (single-line style)', function() {
+        input = readFile('include-3.less');
+        expected = readFile('include-3.expected.less');
+
+        assert.equal(comb.processString(input, 'less'), expected);
+    });
+
+    it('Should add semicolon to last included mixin if missing. Test 3 (multi-line style)', function() {
+        input = readFile('include-3-multiline.less');
+        expected = readFile('include-3-multiline.expected.less');
+
+        assert.equal(comb.processString(input, 'less'), expected);
+    });
+
+    it('Should add semicolon to last included mixin if missing. Test 4 (single-line style)', function() {
+        input = readFile('include-4.less');
+        expected = readFile('include-4.expected.less');
+
+        assert.equal(comb.processString(input, 'less'), expected);
+    });
+
+    it('Should add semicolon to last included mixin if missing. Test 4 (multi-line style)', function() {
+        input = readFile('include-4-multiline.less');
+        expected = readFile('include-4-multiline.expected.less');
+
+        assert.equal(comb.processString(input, 'less'), expected);
+    });
+
+    it('Should add semicolon to last included mixin if missing. Test 5 (single-line style)', function() {
+        input = readFile('include-5.less');
+        expected = readFile('include-5.expected.less');
+
+        assert.equal(comb.processString(input, 'less'), expected);
+    });
+
+    it('Should add semicolon to last included mixin if missing. Test 5 (multi-line style)', function() {
+        input = readFile('include-5-multiline.less');
+        expected = readFile('include-5-multiline.expected.less');
+
+        assert.equal(comb.processString(input, 'less'), expected);
+    });
+});

test/always-semicolon-less/condition-multiline.less

@@ -0,0 +1,6 @@
+div {
+    @color: tomato;
+    when (@color = tomato) {
+        top: 0;
+        }
+    }

test/always-semicolon-less/condition.less

@@ -0,0 +1 @@
+div { @color: tomato; when (@color = tomato) { top: 0; } }

test/always-semicolon-less/include-1-multiline.expected.less

@@ -0,0 +1,4 @@
+div {
+    color: tomato;
+    .nani;
+    }

test/always-semicolon-less/include-1-multiline.less

@@ -0,0 +1,4 @@
+div {
+    color: tomato;
+    .nani
+    }

test/always-semicolon-less/include-1.expected.less

@@ -0,0 +1 @@
+div { color: tomato; .nani; }

test/always-semicolon-less/include-1.less

@@ -0,0 +1 @@
+div { color: tomato; .nani }

test/always-semicolon-less/include-2-multiline.expected.less

@@ -0,0 +1,4 @@
+div {
+    color: tomato;
+    .nani(2px);
+    }