postcss-discard-comments 1.1.1 → 1.2.1

package/CHANGELOG.md

@@ -1,3 +1,28 @@
+# 1.2.1
+
+* Improved performance by iterating the AST in a single pass.
+
+# 1.2.0
+
+* Adds support for user-directed removal of comments, with the `remove`
+  option (thanks to @dmitrykiselyov).
+* `removeAllButFirst` now operates on each CSS tree, rather than the first one
+  passed to the plugin.
+* Fixes to pass the PostCSS plugin guidelines.
+
+# 1.1.3
+
+* As PostCSS handles the source map content, there is no need to check for
+  the existence of a '#' at position 0 of the comment. This patch fixes this
+  behaviour.
+
+# 1.1.2
+
+* Fixes an issue where comment separated values were being incorrectly
+  transformed to not have spaces separating them instead, in `decl.value`.
+  e.g. `10px/*test*/20px` became `10px20px` in `decl.value` but not
+  `decl._value.raw`.
+
 # 1.1.1
 
 * Fixes a bug where non-special comments, with an exclamation mark in any part

package/LICENSE-MIT

@@ -1,4 +1,4 @@
-Copyright (c) 2015 Ben Briggs
+Copyright (c) Ben Briggs <beneb.info@gmail.com> (http://beneb.info)
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

package/README.md

@@ -2,7 +2,9 @@
 
 > Discard comments in your CSS files with PostCSS.
 
-Install via [npm](https://npmjs.org/package/postcss-discard-comments):
+## Install
+
+With [npm](https://npmjs.org/package/postcss-discard-comments) do:
 
 ```
 npm install postcss-discard-comments --save
@@ -10,14 +12,20 @@ npm install postcss-discard-comments --save
 
 ## Example
 
-```js
-var postcss = require('postcss')
-var comments = require('postcss-discard-comments');
+### Input
+
+```css
+h1/* heading */{
+    margin: 0 auto
+}
+```
 
-var css = 'h1/* heading */{margin:0 auto}';
-console.log(postcss(comments()).process(css).css);
+### Output
 
-// => 'h1{margin:0 auto}'
+```css
+h1 {
+    margin: 0 auto
+}
 ```
 
 This module discards comments from your CSS files; by default, it will remove
@@ -30,6 +38,27 @@ all regular comments (`/* comment */`) and preserve comments marked as important
 
 #### options
 
+##### remove(function)
+
+Type: `function`
+Return: `boolean`
+Variable: `comment` contains a comment without `/**/`
+
+For each comment, return true to remove, or false to keep the comment.
+
+```js
+function(comment) {}
+```
+
+```js
+var css = '/* headings *//*@ h1 */h1{margin:0 auto}/*@ h2 */h2{color:red}';
+console.log(postcss(comments({
+    remove: function(comment) { return comment[0] == "@"; }
+})).process(css).css);
+//=> /* headings */h1{margin:0 auto}h2{color:red}
+```
+**NOTE:** If you use the `remove` function other options will not be available.
+
 ##### removeAll
 
 Type: `boolean`
@@ -56,6 +85,11 @@ console.log(postcss(comments({removeAllButFirst: true})).process(css).css);
 //=> /*! heading */h1{margin:0 auto}h2{color:red}
 ```
 
+## Usage
+
+See the [PostCSS documentation](https://github.com/postcss/postcss#usage) for
+examples for your environment.
+
 ## Contributing
 
 Pull requests are welcome. If you add functionality, then please add unit tests

package/index.js

@@ -6,72 +6,70 @@ var postcss = require('postcss');
 var space = postcss.list.space;
 
 module.exports = postcss.plugin('postcss-discard-comments', function (options) {
-    var remover = new CommentRemover(options || {});
+    return function (css) {
+        var remover = new CommentRemover(options || {});
 
-    function replaceComments (source) {
-        if (!source) {
-            return;
-        }
-        var b = balanced.replacements({
-            source: source,
-            open: '/*',
-            close: '*/',
-            replace: function (comment, head, tail) {
-                if (remover.canRemove(comment)) {
-                    return ' ';
-                }
-                return head + comment + tail;
+        function replaceComments (source) {
+            if (!source) {
+                return;
             }
-        });
-        return space(b).join(' ');
-    }
+            var b = balanced.replacements({
+                source: source,
+                open: '/*',
+                close: '*/',
+                replace: function (comment, head, tail) {
+                    if (remover.canRemove(comment)) {
+                        return ' ';
+                    }
+                    return head + comment + tail;
+                }
+            });
+            return space(b).join(' ');
+        }
 
-    return function (css) {
-        css.eachComment(function (comment) {
-            if (remover.canRemove(comment.text)) {
-                comment.removeSelf();
+        css.eachInside(function (node) {
+            if (node.type === 'comment' && remover.canRemove(node.text)) {
+                return node.removeSelf();
             }
-        });
 
-        css.eachDecl(function (decl) {
-            decl.between = replaceComments(decl.between);
-            if (decl._value && decl._value.raw) {
-                decl._value.raw = replaceComments(decl._value.raw);
-            }
-            if (decl._important) {
-                decl._important = replaceComments(decl._important);
-                var b = balanced.matches({
-                    source: decl._important,
-                    open: '/*',
-                    close: '*/'
-                });
-                decl._important = b.length ? decl._important : '!important';
+            if (node.between) {
+                node.between = replaceComments(node.between);
             }
-        });
 
-        css.eachRule(function (rule) {
-            if (rule.between) {
-                rule.between = replaceComments(rule.between);
+            if (node.type === 'decl') {
+                if (node._value && node._value.raw) {
+                    var replaced = replaceComments(node._value.raw);
+                    node._value.raw = node._value.value = node.value = replaced;
+                }
+                if (node._important) {
+                    node._important = replaceComments(node._important);
+                    var b = balanced.matches({
+                        source: node._important,
+                        open: '/*',
+                        close: '*/'
+                    });
+                    node._important = b.length ? node._important : '!important';
+                }
+                return;
             }
-            if (rule._selector && rule._selector.raw) {
-                rule._selector.raw = replaceComments(rule._selector.raw);
+
+            if (node.type === 'rule' && node._selector && node._selector.raw) {
+                node._selector.raw = replaceComments(node._selector.raw);
+                return;
             }
-        });
 
-        css.eachAtRule(function (rule) {
-            if (rule.afterName) {
-                var commentsReplaced = replaceComments(rule.afterName);
-                if (!commentsReplaced.length) {
-                    rule.afterName = commentsReplaced + ' ';
-                } else {
-                    rule.afterName = ' ' + commentsReplaced + ' ';
+            if (node.type === 'atrule') {
+                if (node.afterName) {
+                    var commentsReplaced = replaceComments(node.afterName);
+                    if (!commentsReplaced.length) {
+                        node.afterName = commentsReplaced + ' ';
+                    } else {
+                        node.afterName = ' ' + commentsReplaced + ' ';
+                    }
+                }
+                if (node._params && node._params.raw) {
+                    node._params.raw = replaceComments(node._params.raw);
                 }
-            }
-            if (rule._params && rule._params.raw) {
-                rule._params.raw = replaceComments(rule._params.raw);
-            }
-            if (rule.between) {
-                rule.between = replaceComments(rule.between);
             }
         });
     };

package/lib/commentRemover.js

@@ -8,15 +8,20 @@ function CommentRemover (options) {
 }
 
 CommentRemover.prototype.canRemove = function (comment) {
-    var isImportant = comment.indexOf('!') === 0;
-    if (!isImportant && comment.indexOf('#') !== 0) {
-        return true;
-    } else if (isImportant) {
-        if (this.options.removeAll || this._hasFirst) {
+    var remove = this.options.remove;
+    if (remove) {
+        return remove(comment);
+    } else {
+        var isImportant = comment.indexOf('!') === 0;
+        if (!isImportant) {
             return true;
-        } else if (this.options.removeAllButFirst && !this._hasFirst) {
-            this._hasFirst = true;
-            return false;
+        } else if (isImportant) {
+            if (this.options.removeAll || this._hasFirst) {
+                return true;
+            } else if (this.options.removeAllButFirst && !this._hasFirst) {
+                this._hasFirst = true;
+                return false;
+            }
         }
     }
 };

package/package.json

@@ -1,24 +1,21 @@
 {
   "name": "postcss-discard-comments",
-  "version": "1.1.1",
+  "version": "1.2.1",
   "description": "Discard comments in your CSS files with PostCSS.",
   "main": "index.js",
   "scripts": {
-    "lint": "jshint index.js lib/commentRemover.js --reporter node_modules/jshint-stylish/stylish.js",
     "test": "tape test.js | tap-spec"
   },
   "keywords": [
     "css",
     "comments",
     "postcss",
-    "postcss-plugins"
+    "postcss-plugin"
   ],
   "license": "MIT",
   "devDependencies": {
-    "jshint": "^2.6.3",
-    "jshint-stylish": "^1.0.1",
-    "tap-spec": "^2.2.2",
-    "tape": "^3.5.0"
+    "tap-spec": "^4.0.2",
+    "tape": "^4.1.0"
   },
   "homepage": "https://github.com/ben-eb/postcss-discard-comments",
   "author": {
@@ -32,6 +29,6 @@
   },
   "dependencies": {
     "node-balanced": "0.0.14",
-    "postcss": "^4.1.2"
+    "postcss": "^4.1.16"
   }
 }