postcss-discard-comments 5.0.3 → 5.1.2

package/package.json

@@ -1,11 +1,13 @@
 {
   "name": "postcss-discard-comments",
-  "version": "5.0.3",
+  "version": "5.1.2",
   "description": "Discard comments in your CSS files with PostCSS.",
   "main": "src/index.js",
+  "types": "types/index.d.ts",
   "files": [
     "src",
-    "LICENSE-MIT"
+    "LICENSE-MIT",
+    "types"
   ],
   "keywords": [
     "css",
@@ -32,6 +34,5 @@
   },
   "peerDependencies": {
     "postcss": "^8.2.15"
-  },
-  "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/src/index.js

@@ -2,11 +2,25 @@
 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(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);
@@ -19,13 +33,17 @@ function pluginCreator(opts = {}) {
     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 = commentParser(source).reduce((value, [type, start, end]) => {
       const contents = source.slice(start, end);
 
@@ -58,7 +76,7 @@ function pluginCreator(opts = {}) {
           return;
         }
 
-        if (node.raws.between) {
+        if (typeof node.raws.between === 'string') {
           node.raws.between = replaceComments(node.raws.between, list.space);
         }
 
@@ -70,7 +88,9 @@ 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) {
@@ -82,6 +102,8 @@ function pluginCreator(opts = {}) {
             const b = matchesComments(node.raws.important);
 
             node.raws.important = b.length ? node.raws.important : '!important';
+          } else {
+            node.value = replaceComments(node.value, list.space);
           }
 
           return;

package/src/lib/commentParser.js

@@ -1,5 +1,11 @@
 'use strict';
+
+/**
+ * @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;

package/src/lib/commentRemover.js

@@ -1,8 +1,13 @@
 '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;
 

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;
+}