postcss-discard-comments 5.0.3 → 5.1.0

package/package.json

@@ -1,11 +1,13 @@
 {
   "name": "postcss-discard-comments",
-  "version": "5.0.3",
+  "version": "5.1.0",
   "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",

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,6 +33,11 @@ function pluginCreator(opts = {}) {
     return result;
   }
 
+  /**
+   * @param {string} source
+   * @param {(s: string) => string[]} space
+   * @return {string}
+   */
   function replaceComments(source, space, separator = ' ') {
     const key = source + '@|@' + separator;
 
@@ -59,7 +78,10 @@ function pluginCreator(opts = {}) {
         }
 
         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') {
@@ -70,7 +92,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) {

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