Merge pull request #126 from csscomb/tg/116-consistent-values

Change acceptable values (#116)

Author: mishanga

.csscomb.json

@@ -4,16 +4,16 @@
         "node_modules/**"
     ],
     "always-semicolon": true,
-    "block-indent": true,
-    "colon-space": true,
+    "block-indent": "    ",
+    "colon-space": ["", " "],
     "color-case": "lower",
     "color-shorthand": true,
-    "combinator-space": true,
+    "combinator-space": [" ", " "],
     "element-case": "lower",
     "eof-newline": true,
     "leading-zero": false,
     "remove-empty-rulesets": true,
-    "rule-indent": true,
+    "rule-indent": "    ",
     "stick-brace": "\n",
     "strip-spaces": true,
     "unitless-zero": true,

README.md

@@ -149,16 +149,16 @@ Example configuration:
     "verbose": true,
 
     "always-semicolon": true,
-    "block-indent": true,
-    "colon-space": true,
+    "block-indent": "    ",
+    "colon-space": ["", " "],
     "color-case": "lower",
     "color-shorthand": true,
     "element-case": "lower",
     "eof-newline": true,
     "leading-zero": false,
     "remove-empty-rulesets": true,
-    "rule-indent": true,
-    "stick-brace": true,
+    "rule-indent": "    ",
+    "stick-brace": "\n",
     "strip-spaces": true,
     "unitless-zero": true,
     "vendor-prefix-align": true
@@ -330,10 +330,10 @@ div {
 
 **Note**: better to use with [rule-indent](#rule-indent)
 
-Available values:
-  * `{Boolean}` `true` (means 4 spaces)
-  * `{Number}` of spaces
-  * `{String}` of whitespace characters (`/[ \t]+/`)
+Acceptable values:
+  * `{Number}` of spaces;
+  * `{String}` of whitespaces or tabs. If there is any other character in the
+    string, the value will not be set.
 
 Example: `{ "block-indent": 2 }`
 
@@ -351,59 +351,54 @@ a { color: red
 }
 ```
 
-### colon-space
-
-Available values:
-  * `{Boolean}` `true` (means `after`) or `false` (no whitespace at all)
-  * `{String}`: `before`, `after`, `both` or any combination of whitespaces
-  and/or a colon (` `, `: `, `\t:\n\t` etc.)
-  * `{Array}` with two `{String}` values: for setting left and right whitespace around a colon
-
-Example: `{ "colon-space": true }`
+Example: `{ "block-indent": "  " }`
 
 ```css
 /* before */
-a { color:red }
+  a { color: red }
+  @media all { a { color: green } }
 
 /* after */
-a { color: red }
+a { color: red
+}
+@media all {
+  a { color: green
+  }
+}
 ```
 
-Example: `{ "colon-space": ":\n\t\t" }`
 
-```css
-/* before */
-a {
-  color: red;
-}
+### colon-space
 
-/* after */
-a {
-  color:
-    red;
-}
-```
+Acceptable value is `{Array}` with 2 elements of following types:
+  * `{Number}` of spaces;
+  * `{String}` of whitespaces or tabs. If there is any other character in the
+    string, the value will not be set.
 
-Example: `{ "colon-space": "" }`
+The first element of the array sets spaces before colon, and the second one sets
+spaces after colon.
+
+Example: `{ "colon-space": ["\t", "\t"] }`
 
 ```css
 /* before */
 a { color: red }
 
 /* after */
-a { color:red }
+a { color	:	red }
 ```
 
-Example: `{ "colon-space": ["\t", "\t"] }`
+Example: `{ "colon-space": [0, 1] }`
 
 ```css
 /* before */
-a { color: red }
+a { color:red }
 
 /* after */
-a { color	:	red }
+a { color: red }
 ```
 
+
 ### color-case
 
 Available values: `{String}` `lower` or `upper`
@@ -434,42 +429,36 @@ b { color: #fc0 }
 
 ### combinator-space
 
-Available values:
-  * `{Boolean}`: `true` sets one space, `false` removes the spaces.
-  * `{String}`: any combination of whitespaces.
-  * `{Array}` with two `{String}` values: for setting left and right whitespace.
-
-Example: `{ "combinator-space": true }`
-
-```css
-/* before */
-a>b { color: red }
+Acceptable value is `{Array}` with 2 elements of following types:
+  * `{Number}` of spaces;
+  * `{String}` of whitespaces, tabs or new lines. If there is any other
+    character in the string, the value will not be set.
 
-/* after */
-a > b { color: red }
-```
+The first element of the array sets spaces before combinator, and the second
+one sets spaces after combinator.
 
-Example: `{ "combinator-space": "" }`
+Example: `{ "combinator-space": [" ", "\n"] }`
 
 ```css
 /* before */
-a > b { color: red }
+a>b { color: red }
 
 /* after */
-a>b { color: red }
+a >
+b { color: red }
 ```
 
-Example: `{ "combinator-space": [" ", "\n"] }`
+Example: `{ "combinator-space": [1, 1] }`
 
 ```css
 /* before */
 a>b { color: red }
 
 /* after */
-a >
-b { color: red }
+a > b { color: red }
 ```
 
+
 ### element-case
 
 Available values: `{String}` `lower` or `upper`
@@ -522,10 +511,10 @@ Example: `{ "remove-empty-rulesets": true }` - remove rulesets that have no decl
 
 **Note**: better to use with [block-indent](#block-indent)
 
-Available values:
-  * `{Boolean}` `true` (means 4 spaces)
-  * `{Number}` of spaces
-  * `{String}` of whitespace characters (`/[ \t]+/`)
+Acceptable values:
+  * `{Number}` of spaces;
+  * `{String}` of whitespaces or tabs. If there is any other character in the
+    string, the value will not be set.
 
 Example: `{ "rule-indent": 2 }`
 
@@ -539,6 +528,19 @@ a {
   margin:0 }
 ```
 
+Example: `{ "rule-indent": "  " }`
+
+```css
+/* before */
+a { color:red; margin:0 }
+
+/* after */
+a {
+  color:red;
+  margin:0 }
+```
+
+
 ### sort-order
 
 **Note**: you can use an example of [.csscomb.json](https://github.com/csscomb/csscomb.js/blob/master/.csscomb.json) to set your own sort order
@@ -615,10 +617,10 @@ p {
 
 ### stick-brace
 
-Available values:
-  * `{Boolean}` `true` (means 1 space)
-  * `{Number}` of spaces
-  * `{String}` of whitespace characters (`/[ \t\n]+/`)
+Acceptable values:
+  * `{Number}` of spaces;
+  * `{String}` of whitespaces, tabs or newlines. If there is any other
+    character in the string, the value will not be set.
 
 Example: `{ "stick-brace": "\n" }`
 
@@ -631,6 +633,17 @@ a
 { color:red }
 ```
 
+Example: `{ "stick-brace": 1 }`
+
+```css
+/* before */
+a{ color:red }
+
+/* after */
+a { color:red }
+```
+
+
 ### strip-spaces
 
 Available value: `{Boolean}` `true`

lib/options/block-indent.js

@@ -3,15 +3,18 @@ module.exports = {
     /**
      * Sets handler value.
      *
-     * @param {String|Number|Boolean} value Option value
+     * @param {String|Number} value Option value
      * @returns {Object|undefined}
      */
     setValue: function(value) {
         delete this._value;
-        if (value === true) this._value = '    ';
-        if (typeof value === 'number' && value === Math.abs(Math.round(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;
+        } else if (typeof value === 'string' && value.match(/^[ \t]+$/)) {
+            this._value = value;
+        }
+
         if (typeof this._value === 'string') return this;
     },
 

lib/options/colon-space.js

@@ -3,39 +3,31 @@ module.exports = {
     /**
      * Sets handler value.
      *
-     * @param {String|Boolean} value Option value
+     * @param {Array} value Option value
      * @returns {Object|undefined}
      */
     setValue: function(value) {
-        this._value = false;
-        if (value === true)
-            value = 'after';
-        if (value === false)
-            value = '';
-        if (value === 'both')
-            this._value = [' ', ' '];
-        if (value === 'before')
-            this._value = [' ', ''];
-        if (value === 'after')
-            this._value = ['', ' '];
-        if (value.constructor === Array && value[0].match(/^[ \t]*$/) && value[1].match(/^[ \t]*$/))
-            this._value = value;
-        if (typeof value === 'string') {
-            if (value.match(/^[ \t]*$/)) {
-                this._value = ['', value];
-            } else {
-                var detectSpaces = value.match(/^(([ \t]*):)?([ \t]*)$/);
-                if (detectSpaces) {
-                    if (detectSpaces[1]) {
-                        this._value = [detectSpaces[2], detectSpaces[3]];
-                    } else {
-                        this._value = ['', detectSpaces[3]];
-                    }
-                }
-            }
+        delete this._value;
+
+        if (value.constructor !== Array) return;
+
+        if (typeof value[0] === 'number' &&
+            value[0] === Math.abs(Math.round(value[0]))) {
+            value[0] = new Array(value[0] + 1).join(' ');
+        } else if (typeof value[0] !== 'string' ||
+            !value[0].match(/^[ \t\n]*$/)) {
+            return;
+        }
+
+        if (typeof value[1] === 'number' &&
+            value[1] === Math.abs(Math.round(value[1]))) {
+            value[1] = new Array(value[1] + 1).join(' ');
+        } else if (typeof value[1] !== 'string' ||
+            !value[1].match(/^[ \t\n]*$/)) {
+            return;
         }
 
-        if (!this._value) return;
+        this._value = value;
         return this;
     },
 

lib/options/combinator-space.js

@@ -3,19 +3,33 @@ module.exports = {
     /**
      * Sets handler value.
      *
-     * @param {String|Boolean|Array} value Option value
-     * @returns {Object}
+     * @param {Array} value Option value
+     * @returns {Object|undefined}
      */
     setValue: function(value) {
-        this._value = false;
-        if (value === true) value = ' ';
-        if (value === false) value = '';
-        if (typeof value === 'string' && value.match(/^[ \t\n]*$/)) {
-            this._value = [value, value];
+        delete this._value;
+
+        if (value.constructor !== Array) return;
+
+        if (typeof value[0] === 'number' &&
+            value[0] === Math.abs(Math.round(value[0]))) {
+            value[0] = new Array(value[0] + 1).join(' ');
+        } else if (typeof value[0] !== 'string' ||
+            !value[0].match(/^[ \t\n]*$/)) {
+            return;
         }
-        if (value.constructor === Array) this._value = value;
-        if (!this._value) return;
+
+        if (typeof value[1] === 'number' &&
+            value[1] === Math.abs(Math.round(value[1]))) {
+            value[1] = new Array(value[1] + 1).join(' ');
+        } else if (typeof value[1] !== 'string' ||
+            !value[1].match(/^[ \t\n]*$/)) {
+            return;
+        }
+
+        this._value = value;
         return this;
+ 
     },
 
     /**