Merge pull request #7 from AoDev/upgrade

refactor: upgrade to postCSS 5, standard code style

Author: AoDev

.eslintrc

@@ -0,0 +1,137 @@
+{
+  "ecmaFeatures": {
+    "modules": true,
+    "experimentalObjectRestSpread": true
+  },
+
+  "env": {
+    "browser": true,
+    "es6": true,
+    "node": true
+  },
+
+  "plugins": [
+    "standard"
+  ],
+
+  "globals": {
+    "document": false,
+    "navigator": false,
+    "window": false,
+    "expect": false,
+    "sinon": false,
+    "afterEach": false,
+    "describe": false,
+    "beforeEach": false,
+    "inject": false,
+    "it": false
+  },
+
+  "rules": {
+    "accessor-pairs": 2,
+    "arrow-spacing": [2, { "before": true, "after": true }],
+    "block-spacing": [2, "always"],
+    "brace-style": [2, "1tbs", { "allowSingleLine": true }],
+    "comma-dangle": [2, "never"],
+    "comma-spacing": [2, { "before": false, "after": true }],
+    "comma-style": [2, "last"],
+    "constructor-super": 2,
+    "curly": [2, "multi-line"],
+    "dot-location": [2, "property"],
+    "eol-last": 2,
+    "eqeqeq": [2, "allow-null"],
+    "generator-star-spacing": [2, { "before": true, "after": true }],
+    "handle-callback-err": [2, "^(err|error)$" ],
+    "indent": [2, 2, { "SwitchCase": 1 }],
+    "key-spacing": [2, { "beforeColon": false, "afterColon": true }],
+    "new-cap": [2, { "newIsCap": true, "capIsNew": false }],
+    "new-parens": 2,
+    "no-array-constructor": 2,
+    "no-caller": 2,
+    "no-class-assign": 2,
+    "no-cond-assign": 2,
+    "no-const-assign": 2,
+    "no-control-regex": 2,
+    "no-debugger": 2,
+    "no-delete-var": 2,
+    "no-dupe-args": 2,
+    "no-dupe-class-members": 2,
+    "no-dupe-keys": 2,
+    "no-duplicate-case": 2,
+    "no-empty-character-class": 2,
+    "no-empty-label": 2,
+    "no-eval": 2,
+    "no-ex-assign": 2,
+    "no-extend-native": 2,
+    "no-extra-bind": 2,
+    "no-extra-boolean-cast": 2,
+    "no-extra-parens": [2, "functions"],
+    "no-fallthrough": 2,
+    "no-floating-decimal": 2,
+    "no-func-assign": 2,
+    "no-implied-eval": 2,
+    "no-inner-declarations": [2, "functions"],
+    "no-invalid-regexp": 2,
+    "no-irregular-whitespace": 2,
+    "no-iterator": 2,
+    "no-label-var": 2,
+    "no-labels": 2,
+    "no-lone-blocks": 2,
+    "no-mixed-spaces-and-tabs": 2,
+    "no-multi-spaces": 2,
+    "no-multi-str": 2,
+    "no-multiple-empty-lines": [2, { "max": 1 }],
+    "no-native-reassign": 2,
+    "no-negated-in-lhs": 2,
+    "no-new": 2,
+    "no-new-func": 2,
+    "no-new-object": 2,
+    "no-new-require": 2,
+    "no-new-wrappers": 2,
+    "no-obj-calls": 2,
+    "no-octal": 2,
+    "no-octal-escape": 2,
+    "no-proto": 2,
+    "no-redeclare": 2,
+    "no-regex-spaces": 2,
+    "no-return-assign": 2,
+    "no-self-compare": 2,
+    "no-sequences": 2,
+    "no-shadow-restricted-names": 2,
+    "no-spaced-func": 2,
+    "no-sparse-arrays": 2,
+    "no-this-before-super": 2,
+    "no-throw-literal": 2,
+    "no-trailing-spaces": 2,
+    "no-undef": 2,
+    "no-undef-init": 2,
+    "no-unexpected-multiline": 2,
+    "no-unneeded-ternary": 2,
+    "no-unreachable": 2,
+    "no-unused-vars": [2, { "vars": "all", "args": "none" }],
+    "no-useless-call": 2,
+    "no-with": 2,
+    "one-var": [2, { "initialized": "never" }],
+    "operator-linebreak": [2, "after", { "overrides": { "?": "before", ":": "before" } }],
+    "padded-blocks": [2, "never"],
+    "quotes": [2, "single", "avoid-escape"],
+    "radix": 2,
+    "semi": [2, "never"],
+    "space-after-keywords": [2, "always"],
+    "space-before-blocks": [2, "always"],
+    "space-before-function-paren": [2, "always"],
+    "space-in-parens": [2, "never"],
+    "space-infix-ops": 2,
+    "space-return-throw-case": 2,
+    "space-unary-ops": [2, { "words": true, "nonwords": false }],
+    "spaced-comment": [2, "always", { "markers": ["global", "globals", "eslint", "eslint-disable", "*package", "!", ","] }],
+    "use-isnan": 2,
+    "valid-typeof": 2,
+    "wrap-iife": [2, "any"],
+    "yoda": [2, "never"],
+
+    "standard/object-curly-even-spacing": [2, "either"],
+    "standard/array-bracket-even-spacing": [2, "either"],
+    "standard/computed-property-even-spacing": [2, "even"]
+  }
+}

Gruntfile.js

@@ -32,7 +32,7 @@ module.exports = function (grunt) {
     mochaTest: {
       all: {
         options: { reporter: 'spec' },
-        src: ['test/spec.js']
+        src: ['./**/*.spec.js']
       }
     }
   })

README.md

@@ -1,22 +1,25 @@
 CSS Byebye
 ===========
 
-[![Join the chat at https://gitter.im/AoDev/css-byebye](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/AoDev/css-byebye?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-
 CSS Byebye is a node module that lets you explicitly remove the CSS rules that you don't want.
 
+---------
+
+[![Join the chat at https://gitter.im/AoDev/css-byebye](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/AoDev/css-byebye?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://github.com/feross/standard)
+[![Build Status](https://travis-ci.org/AoDev/css-byebye.svg)](https://travis-ci.org/AoDev/css-byebye)
 
 Description
 ------------
 
-It's very simple: pass him a list of selectors that you want to exclude and it will remove them and the associated rules from your CSS.
+It's very simple: pass a list of selectors that you want to exclude and it will remove them and the associated rules from your CSS.
 
 I've found some cases where this approach is easier than using more powerful tools like uncss.
 Use what's best for you and give some feedback :)
 
 CSS Byebye is built with [postcss](https://github.com/postcss/postcss).
 
-A grunt task for CSS Byebye exists: [grunt-css-byeby](https://github.com/AoDev/grunt-css-byebye).
+A grunt task for CSS Byebye exists: [grunt-css-byebye](https://github.com/AoDev/grunt-css-byebye).
 
 
 Usage
@@ -44,41 +47,61 @@ If you provide a string, it will remove the rule(s) for this exact selector.
 
 ### Examples ###
 
+Some CSS:
+
+```css
+ a { font-size: 12px; }
+ .hello .h1 { background: red }
+ .world { color: blue }
+```
+
+Using the plugin:
+
 ```js
 var postcss = require('postcss')
 var cssbyebye = require('css-byebye')
 
-var css = 'a { font-size: 12px; } .hello .h1 { background: red } .world { color: blue }'
 var rulesToRemove = ['.hello .h1', '.world']
 var options = { rulesToRemove: rulesToRemove, map: false }
+
+// pretend that css var contains the css above
 var result = postcss(cssbyebye(options)).process(css)
 ```
 
 `result` will be an object like this:
 
-```css
+```js
 {
   css: 'a { font-size: 12px; }'
 }
 ```
 
-If you use the postcss map option, then it will be added to the result object.
+If you use the postcss `map` option, then source map will be added to the result object.
 
 
 #### You can mix strings and regular expressions
 
 ```js
-var rulesToRemove = ['.hello', /.*\.world.*/]
+var rulesToRemove = [
+  '.hello',
+  /.*\.world.*/
+]
 ```
 
-In this case, it would remove a rule with the exact selector `.hello` and any rule
-that contains the `.world` class.
+In this case, it would:
+* remove a rule with the exact selector `.hello`
+* remove any rule that contains the `.world` class.
 
 
 
 Changelog
 ----------
 
+### 2015-09-25 v1.0.1
+* Upgrade to postCSS 5.x
+* Docs improved.
+* The project uses js standard code style.
+
 ### 2015-06-09 v1.0.0
 * **Breaking changes** and bumped to 1.0.0
 * Update to last postCSS version

lib/css-byebye.js

@@ -2,93 +2,82 @@
  * @module css-byebye
  */
 
-
 var postcss = require('postcss')
 
-
 /**
  * Escape a string so that it can be turned into a regex
  * @param  {String} str String to transform
  * @return {String}     Escaped string
  */
-function escapeRegExp(str) {
-  return str.replace(/[\-\[\]\/\{\}\(\)\*\+\?\.\\\^\$\|]/g, "\\$&");
+function escapeRegExp (str) {
+  return str.replace(/[\-\[\]\/\{\}\(\)\*\+\?\.\\\^\$\|]/g, '\\$&')
 }
 
-
 /**
  * Turn strings from rules to remove into a regexp to concat them later
  * @param  {Mixed Array} rulesToRemove
  * @return {RegExp Array}
  */
-function regexize(rulesToRemove) {
+function regexize (rulesToRemove) {
   var rulesRegexes = []
   for (var i = 0, l = rulesToRemove.length; i < l; i++) {
-    if (typeof rulesToRemove[i] == 'string') {
-      rulesRegexes.push(new RegExp('^\s*' + escapeRegExp(rulesToRemove[i])+ '\s*$'))
-    }
-    else {
+    if (typeof rulesToRemove[i] === 'string') {
+      rulesRegexes.push(new RegExp('^\s*' + escapeRegExp(rulesToRemove[i]) + '\s*$'))
+    } else {
       rulesRegexes.push(rulesToRemove[i])
     }
   }
   return rulesRegexes
 }
 
-
 /**
  * Concat various regular expressions into one
  * @param  {RegExp Array} regexes
  * @return {RegExp}       concatanated regexp
  */
-function concatRegexes(regexes) {
-
+function concatRegexes (regexes) {
   var rconcat = ''
 
   if (Array.isArray(regexes)) {
-
     for (var i = 0, l = regexes.length; i < l; i++) {
       rconcat += regexes[i].source + '|'
     }
 
-    rconcat = rconcat.substr(0, rconcat.length -1)
+    rconcat = rconcat.substr(0, rconcat.length - 1)
 
     return new RegExp(rconcat)
   }
 }
 
-
 /**
  * Return the actual postcss plugin to remove rules from the css
  */
 var cssbyebye = postcss.plugin('css-byebye', function (options) {
-
-  return function byebye(css) {
+  return function byebye (css) {
     var remregexes = regexize(options.rulesToRemove)
     var regex = concatRegexes(remregexes)
-    var count = 0
 
-    var filterRule = function filterRule(rule) {
+    css.walkRules(filterRule)
 
+    function filterRule (rule) {
       var selectors = rule.selectors
       var filtered = []
 
       for (var j = 0, len = selectors.length; j < len; j++) {
-        if (selectors[j].match(regex) === null)
+        if (selectors[j].match(regex) === null) {
           filtered.push(selectors[j])
+        }
       }
 
-      if (filtered.length > 1)
+      if (filtered.length > 1) {
         rule.selector = filtered.join(', ')
-      else if (filtered.length == 1)
+      } else if (filtered.length === 1) {
         rule.selector = filtered[0].trim()
-      else {
-        rule.removeSelf()
+      } else {
+        rule.remove()
       }
     }
-
-    css.eachRule(filterRule)
   }
 })
 
-
 module.exports = cssbyebye

test/spec.js renamed to lib/css-byebye.spec.js

@@ -4,9 +4,7 @@ var cssbyebye = require('../lib/css-byebye')
 var postcss = require('postcss')
 
 describe('cssbyebye', function () {
-
-  it('should remove ruleset(s) with a selector that contains any of the given selectors to remove ', function (done) {
-
+  it('should remove ruleset(s) that matches any given selectors to remove ', function (done) {
     var css = 'a { font-size: 12px; } .hello .h1 { background: red } .world { color: blue }'
     var rulesToRemove = ['.hello .h1', '.world']
     var expected = 'a { font-size: 12px; }'
@@ -18,7 +16,6 @@ describe('cssbyebye', function () {
   })
 
   it('should remove only the matching selector(s) from a group of selectors', function (done) {
-
     var css = '.hello .world, .title, #id { color: red }'
     var rulesToRemove = ['.hello .world']
     var expected = '.title, #id { color: red }'
@@ -30,16 +27,13 @@ describe('cssbyebye', function () {
   })
 
   it('should support regex matching', function (done) {
-
     var css = '.item {} .item .desc { background: red } .list .item {}'
     var rulesToRemove = [/^\.item/]
-    var expected =  '.list .item {}'
+    var expected = '.list .item {}'
     var options = { rulesToRemove: rulesToRemove, map: false }
     var result = postcss(cssbyebye(options)).process(css)
 
     assert.strictEqual(result.css, expected)
     done()
   })
 })
-
-