postcss-colormin 5.2.5 → 5.3.0

package/package.json

@@ -1,11 +1,13 @@
 {
   "name": "postcss-colormin",
-  "version": "5.2.5",
+  "version": "5.3.0",
   "description": "Minify colors in your CSS files with PostCSS.",
   "main": "src/index.js",
+  "types": "types/index.d.ts",
   "files": [
     "src",
-    "LICENSE-MIT"
+    "LICENSE-MIT",
+    "types"
   ],
   "keywords": [
     "color",
@@ -37,6 +39,7 @@
     "node": "^10 || ^12 || >=14.0"
   },
   "devDependencies": {
+    "@types/caniuse-api": "^3.0.2",
     "postcss": "^8.2.15"
   },
   "peerDependencies": {

package/src/index.js

@@ -4,11 +4,16 @@ const { isSupported } = require('caniuse-api');
 const valueParser = require('postcss-value-parser');
 const minifyColor = require('./minifyColor');
 
+/**
+ * @param {{nodes: valueParser.Node[]}} parent
+ * @param {(node: valueParser.Node, index: number, parent: {nodes: valueParser.Node[]}) => false | undefined} callback
+ * @return {void}
+ */
 function walk(parent, callback) {
   parent.nodes.forEach((node, index) => {
     const bubble = callback(node, index, parent);
 
-    if (node.nodes && bubble !== false) {
+    if (node.type === 'function' && bubble !== false) {
       walk(node, callback);
     }
   });
@@ -23,6 +28,10 @@ function walk(parent, callback) {
 const browsersWithTransparentBug = new Set(['ie 8', 'ie 9']);
 const mathFunctions = new Set(['calc', 'min', 'max', 'clamp']);
 
+/**
+ * @param {valueParser.Node} node
+ * @return {boolean}
+ */
 function isMathFunctionNode(node) {
   if (node.type !== 'function') {
     return false;
@@ -30,6 +39,11 @@ function isMathFunctionNode(node) {
   return mathFunctions.has(node.value.toLowerCase());
 }
 
+/**
+ * @param {string} value
+ * @param {Record<string, boolean>} options
+ * @return {string}
+ */
 function transform(value, options) {
   const parsed = valueParser(value);
 
@@ -39,7 +53,7 @@ function transform(value, options) {
         const { value: originalValue } = node;
 
         node.value = minifyColor(valueParser.stringify(node), options);
-        node.type = 'word';
+        /** @type {string} */ (node.type) = 'word';
 
         const next = parent.nodes[index + 1];
 
@@ -48,10 +62,14 @@ function transform(value, options) {
           next &&
           (next.type === 'word' || next.type === 'function')
         ) {
-          parent.nodes.splice(index + 1, 0, {
-            type: 'space',
-            value: ' ',
-          });
+          parent.nodes.splice(
+            index + 1,
+            0,
+            /** @type {valueParser.SpaceNode} */ ({
+              type: 'space',
+              value: ' ',
+            })
+          );
         }
       } else if (isMathFunctionNode(node)) {
         return false;
@@ -64,6 +82,11 @@ function transform(value, options) {
   return parsed.toString();
 }
 
+/**
+ * @param {Record<string, boolean>} options
+ * @param {string[]} browsers
+ * @return {Record<string, boolean>}
+ */
 function addPluginDefaults(options, browsers) {
   const defaults = {
     // Does the browser support 4 & 8 character hex notation
@@ -75,12 +98,17 @@ function addPluginDefaults(options, browsers) {
   };
   return { ...defaults, ...options };
 }
-
+/**
+ * @type {import('postcss').PluginCreator<Record<string, boolean>>}
+ * @param {Record<string, boolean>} config
+ * @return {import('postcss').Plugin}
+ */
 function pluginCreator(config = {}) {
   return {
     postcssPlugin: 'postcss-colormin',
 
     prepare(result) {
+      /** @type {typeof result.opts & browserslist.Options} */
       const resultOptions = result.opts || {};
       const browsers = browserslist(null, {
         stats: resultOptions.stats,

package/src/minifyColor.js

@@ -3,13 +3,14 @@ const { colord, extend } = require('colord');
 const namesPlugin = require('colord/plugins/names');
 const minifierPlugin = require('colord/plugins/minify');
 
-extend([namesPlugin, minifierPlugin]);
+extend(/** @type {any[]} */ ([namesPlugin, minifierPlugin]));
 
 /**
  * Performs color value minification
  *
  * @param {string} input - CSS value
- * @param {boolean} options - object with colord.minify() options
+ * @param {Record<string, boolean>} options  object with colord.minify() options
+ * @return {string}
  */
 module.exports = function minifyColor(input, options = {}) {
   const instance = colord(input);

package/types/index.d.ts

@@ -0,0 +1,10 @@
+export = pluginCreator;
+/**
+ * @type {import('postcss').PluginCreator<Record<string, boolean>>}
+ * @param {Record<string, boolean>} config
+ * @return {import('postcss').Plugin}
+ */
+declare function pluginCreator(config?: Record<string, boolean>): import('postcss').Plugin;
+declare namespace pluginCreator {
+    const postcss: true;
+}

package/types/minifyColor.d.ts

@@ -0,0 +1,2 @@
+declare function _exports(input: string, options?: Record<string, boolean>): string;
+export = _exports;