postcss-discard-comments 5.0.2 → 5.1.1

package/package.json

@@ -1,11 +1,13 @@
 {
   "name": "postcss-discard-comments",
-  "version": "5.0.2",
+  "version": "5.1.1",
   "description": "Discard comments in your CSS files with PostCSS.",
-  "main": "dist/index.js",
+  "main": "src/index.js",
+  "types": "types/index.d.ts",
   "files": [
-    "dist",
-    "LICENSE-MIT"
+    "src",
+    "LICENSE-MIT",
+    "types"
   ],
   "keywords": [
     "css",
@@ -33,9 +35,5 @@
   "peerDependencies": {
     "postcss": "^8.2.15"
   },
-  "scripts": {
-    "prebuild": "rimraf dist",
-    "build": "babel src --config-file ../../babel.config.json --out-dir dist --ignore \"**/__tests__/\""
-  },
   "readme": "# [postcss][postcss]-discard-comments\n\n> Discard comments in your CSS files with PostCSS.\n\n\n## Install\n\nWith [npm](https://npmjs.org/package/postcss-discard-comments) do:\n\n```\nnpm install postcss-discard-comments --save\n```\n\n\n## Example\n\n### Input\n\n```css\nh1/* heading */{\n    margin: 0 auto\n}\n```\n\n### Output\n\n```css\nh1 {\n    margin: 0 auto\n}\n```\n\nThis module discards comments from your CSS files; by default, it will remove\nall regular comments (`/* comment */`) and preserve comments marked as important\n(`/*! important */`).\n\nNote that this module does not handle source map comments because they are not\navailable to it; PostCSS handles this internally, so if they are removed then\nyou will have to [configure source maps in PostCSS][maps].\n\n[maps]: https://github.com/postcss/postcss/blob/master/docs/source-maps.md\n\n\n## API\n\n### comments([options])\n\n#### options\n\n##### remove(function)\n\nType: `function`\nReturn: `boolean`\nVariable: `comment` contains a comment without `/**/`\n\nFor each comment, return true to remove, or false to keep the comment.\n\n```js\nfunction(comment) {}\n```\n\n```js\nvar css = '/* headings *//*@ h1 */h1{margin:0 auto}/*@ h2 */h2{color:red}';\nconsole.log(postcss(comments({\n    remove: function(comment) { return comment[0] == \"@\"; }\n})).process(css).css);\n//=> /* headings */h1{margin:0 auto}h2{color:red}\n```\n**NOTE:** If you use the `remove` function other options will not be available.\n\n##### removeAll\n\nType: `boolean`\nDefault: `false`\n\nRemove all comments marked as important.\n\n```js\nvar css = '/*! heading */h1{margin:0 auto}/*! heading 2 */h2{color:red}';\nconsole.log(postcss(comments({removeAll: true})).process(css).css);\n//=> h1{margin:0 auto}h2{color:red}\n```\n\n##### removeAllButFirst\n\nType: `boolean`\nDefault: `false`\n\nRemove all comments marked as important, but the first one.\n\n```js\nvar css = '/*! heading */h1{margin:0 auto}/*! heading 2 */h2{color:red}';\nconsole.log(postcss(comments({removeAllButFirst: true})).process(css).css);\n//=> /*! heading */h1{margin:0 auto}h2{color:red}\n```\n\n\n## Usage\n\nSee the [PostCSS documentation](https://github.com/postcss/postcss#usage) for\nexamples for your environment.\n\n\n## Contributors\n\nSee [CONTRIBUTORS.md](https://github.com/cssnano/cssnano/blob/master/CONTRIBUTORS.md).\n\n\n## License\n\nMIT © [Ben Briggs](http://beneb.info)\n\n\n[postcss]: https://github.com/postcss/postcss\n"
 }

package/{dist → src}/index.js

@@ -1,39 +1,50 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _commentRemover = _interopRequireDefault(require("./lib/commentRemover"));
-
-var _commentParser = _interopRequireDefault(require("./lib/commentParser"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
+'use strict';
+const CommentRemover = require('./lib/commentRemover');
+const commentParser = require('./lib/commentParser');
+
+/** @typedef {object} Options
+ *  @property {boolean=} removeAll
+ *  @property {boolean=} removeAllButFirst
+ *  @property {(s: string) => boolean=} remove
+ */
+/**
+ * @type {import('postcss').PluginCreator<Options>}
+ * @param {Options} opts
+ * @return {import('postcss').Plugin}
+ */
 function pluginCreator(opts = {}) {
-  const remover = new _commentRemover.default(opts);
+  const remover = new CommentRemover(opts);
   const matcherCache = new Map();
   const replacerCache = new Map();
 
+  /**
+   * @param {string} source
+   * @return {[number, number, number][]}
+   */
   function matchesComments(source) {
     if (matcherCache.has(source)) {
       return matcherCache.get(source);
     }
 
-    const result = (0, _commentParser.default)(source).filter(([type]) => type);
+    const result = commentParser(source).filter(([type]) => type);
+
     matcherCache.set(source, result);
+
     return result;
   }
 
+  /**
+   * @param {string} source
+   * @param {(s: string) => string[]} space
+   * @return {string}
+   */
   function replaceComments(source, space, separator = ' ') {
     const key = source + '@|@' + separator;
 
     if (replacerCache.has(key)) {
       return replacerCache.get(key);
     }
-
-    const parsed = (0, _commentParser.default)(source).reduce((value, [type, start, end]) => {
+    const parsed = commentParser(source).reduce((value, [type, start, end]) => {
       const contents = source.slice(start, end);
 
       if (!type) {
@@ -46,25 +57,30 @@ function pluginCreator(opts = {}) {
 
       return `${value}/*${contents}*/`;
     }, '');
+
     const result = space(parsed).join(' ');
+
     replacerCache.set(key, result);
+
     return result;
   }
 
   return {
     postcssPlugin: 'postcss-discard-comments',
 
-    OnceExit(css, {
-      list
-    }) {
-      css.walk(node => {
+    OnceExit(css, { list }) {
+      css.walk((node) => {
         if (node.type === 'comment' && remover.canRemove(node.text)) {
           node.remove();
+
           return;
         }
 
         if (node.raws.between) {
-          node.raws.between = replaceComments(node.raws.between, list.space);
+          node.raws.between = replaceComments(
+            /** @type {string} */ (node.raws.between),
+            list.space
+          );
         }
 
         if (node.type === 'decl') {
@@ -75,26 +91,47 @@ function pluginCreator(opts = {}) {
               node.value = replaceComments(node.value, list.space);
             }
 
-            node.raws.value = null;
+            /** @type {null | {value: string, raw: string}} */ (
+              node.raws.value
+            ) = null;
           }
 
           if (node.raws.important) {
-            node.raws.important = replaceComments(node.raws.important, list.space);
+            node.raws.important = replaceComments(
+              node.raws.important,
+              list.space
+            );
+
             const b = matchesComments(node.raws.important);
+
             node.raws.important = b.length ? node.raws.important : '!important';
+          } else {
+            node.value = replaceComments(node.value, list.space);
           }
 
           return;
         }
 
-        if (node.type === 'rule' && node.raws.selector && node.raws.selector.raw) {
-          node.raws.selector.raw = replaceComments(node.raws.selector.raw, list.space, '');
+        if (
+          node.type === 'rule' &&
+          node.raws.selector &&
+          node.raws.selector.raw
+        ) {
+          node.raws.selector.raw = replaceComments(
+            node.raws.selector.raw,
+            list.space,
+            ''
+          );
+
           return;
         }
 
         if (node.type === 'atrule') {
           if (node.raws.afterName) {
-            const commentsReplaced = replaceComments(node.raws.afterName, list.space);
+            const commentsReplaced = replaceComments(
+              node.raws.afterName,
+              list.space
+            );
 
             if (!commentsReplaced.length) {
               node.raws.afterName = commentsReplaced + ' ';
@@ -104,16 +141,16 @@ function pluginCreator(opts = {}) {
           }
 
           if (node.raws.params && node.raws.params.raw) {
-            node.raws.params.raw = replaceComments(node.raws.params.raw, list.space);
+            node.raws.params.raw = replaceComments(
+              node.raws.params.raw,
+              list.space
+            );
           }
         }
       });
-    }
-
+    },
   };
 }
 
 pluginCreator.postcss = true;
-var _default = pluginCreator;
-exports.default = _default;
-module.exports = exports.default;
+module.exports = pluginCreator;

package/{dist → src}/lib/commentParser.js

@@ -1,11 +1,11 @@
-"use strict";
+'use strict';
 
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = commentParser;
-
-function commentParser(input) {
+/**
+ * @param {string} input
+ * @return {[number, number, number][]}
+ */
+module.exports = function commentParser(input) {
+  /** @type [number, number, number][] */
   const tokens = [];
   const length = input.length;
   let pos = 0;
@@ -17,6 +17,7 @@ function commentParser(input) {
     if (~next) {
       tokens.push([0, pos, next]);
       pos = next;
+
       next = input.indexOf('*/', pos + 2);
       tokens.push([1, pos + 2, next]);
       pos = next + 2;
@@ -27,6 +28,4 @@ function commentParser(input) {
   }
 
   return tokens;
-}
-
-module.exports = exports.default;
+};

package/{dist → src}/lib/commentRemover.js

@@ -1,14 +1,13 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
+'use strict';
 
+/** @param {import('../index.js').Options} options */
 function CommentRemover(options) {
   this.options = options;
 }
-
+/**
+ * @param {string} comment
+ * @return {boolean | undefined}
+ */
 CommentRemover.prototype.canRemove = function (comment) {
   const remove = this.options.remove;
 
@@ -30,6 +29,4 @@ CommentRemover.prototype.canRemove = function (comment) {
   }
 };
 
-var _default = CommentRemover;
-exports.default = _default;
-module.exports = exports.default;
+module.exports = CommentRemover;

package/types/index.d.ts

@@ -0,0 +1,21 @@
+export = pluginCreator;
+/** @typedef {object} Options
+ *  @property {boolean=} removeAll
+ *  @property {boolean=} removeAllButFirst
+ *  @property {(s: string) => boolean=} remove
+ */
+/**
+ * @type {import('postcss').PluginCreator<Options>}
+ * @param {Options} opts
+ * @return {import('postcss').Plugin}
+ */
+declare function pluginCreator(opts?: Options): import('postcss').Plugin;
+declare namespace pluginCreator {
+    export { postcss, Options };
+}
+type Options = {
+    removeAll?: boolean | undefined;
+    removeAllButFirst?: boolean | undefined;
+    remove?: ((s: string) => boolean) | undefined;
+};
+declare var postcss: true;

package/types/lib/commentParser.d.ts

@@ -0,0 +1,2 @@
+declare function _exports(input: string): [number, number, number][];
+export = _exports;

package/types/lib/commentRemover.d.ts

@@ -0,0 +1,14 @@
+export = CommentRemover;
+/** @param {import('../index.js').Options} options */
+declare function CommentRemover(options: import('../index.js').Options): void;
+declare class CommentRemover {
+    /** @param {import('../index.js').Options} options */
+    constructor(options: import('../index.js').Options);
+    options: import("../index.js").Options;
+    /**
+     * @param {string} comment
+     * @return {boolean | undefined}
+     */
+    canRemove(comment: string): boolean | undefined;
+    _hasFirst: boolean | undefined;
+}