postcss-convert-values 5.0.4 → 5.1.0

package/package.json

@@ -1,11 +1,13 @@
 {
   "name": "postcss-convert-values",
-  "version": "5.0.4",
+  "version": "5.1.0",
   "description": "Convert values with PostCSS (e.g. ms -> s)",
   "main": "src/index.js",
+  "types": "types/index.d.ts",
   "files": [
     "LICENSE-MIT",
-    "src"
+    "src",
+    "types"
   ],
   "keywords": [
     "css",

package/src/index.js

@@ -1,6 +1,6 @@
 'use strict';
 const valueParser = require('postcss-value-parser');
-const convert = require('./lib/convert');
+const convert = require('./lib/convert.js');
 
 const LENGTH_UNITS = new Set([
   'em',
@@ -36,10 +36,13 @@ const keepWhenZero = new Set([
   'line-height',
 ]);
 
-/*
+/**
  * Numbers without digits after the dot are technically invalid,
  * but in that case css-value-parser returns the dot as part of the unit,
  * so we use this to remove the dot.
+ *
+ * @param {string} item
+ * @return {string}
  */
 function stripLeadingDot(item) {
   if (item.charCodeAt(0) === '.'.charCodeAt(0)) {
@@ -49,6 +52,12 @@ function stripLeadingDot(item) {
   }
 }
 
+/**
+ * @param {valueParser.Node} node
+ * @param {Options} opts
+ * @param {boolean} keepZeroUnit
+ * @return {void}
+ */
 function parseWord(node, opts, keepZeroUnit) {
   const pair = valueParser.unit(node.value);
   if (pair) {
@@ -76,6 +85,10 @@ function parseWord(node, opts, keepZeroUnit) {
   }
 }
 
+/**
+ * @param {valueParser.WordNode} node
+ * @return {void}
+ */
 function clampOpacity(node) {
   const pair = valueParser.unit(node.value);
   if (!pair) {
@@ -89,20 +102,31 @@ function clampOpacity(node) {
   }
 }
 
+/**
+ * @param {import('postcss').Declaration} decl
+ * @return {boolean}
+ */
 function shouldKeepZeroUnit(decl) {
   const { parent } = decl;
   const lowerCasedProp = decl.prop.toLowerCase();
   return (
     (decl.value.includes('%') &&
       (lowerCasedProp === 'max-height' || lowerCasedProp === 'height')) ||
-    (parent.parent &&
-      parent.parent.name &&
-      parent.parent.name.toLowerCase() === 'keyframes' &&
+    (parent &&
+      parent.parent &&
+      parent.parent.type === 'atrule' &&
+      /** @type {import('postcss').AtRule} */ (
+        parent.parent
+      ).name.toLowerCase() === 'keyframes' &&
       lowerCasedProp === 'stroke-dasharray') ||
     keepWhenZero.has(lowerCasedProp)
   );
 }
-
+/**
+ * @param {Options} opts
+ * @param {import('postcss').Declaration} decl
+ * @return {void}
+ */
 function transform(opts, decl) {
   const lowerCasedProp = decl.prop.toLowerCase();
   if (
@@ -150,7 +174,13 @@ function transform(opts, decl) {
 }
 
 const plugin = 'postcss-convert-values';
-
+/**
+ * @typedef {{precision: boolean | number, angle?: boolean, time?: boolean, length?: boolean}} Options */
+/**
+ * @type {import('postcss').PluginCreator<Options>}
+ * @param {Options} opts
+ * @return {import('postcss').Plugin}
+ */
 function pluginCreator(opts = { precision: false }) {
   return {
     postcssPlugin: plugin,

package/src/lib/convert.js

@@ -15,7 +15,10 @@ const angleConv = new Map([
   ['turn', 360],
   ['deg', 1],
 ]);
-
+/**
+ * @param {number} number
+ * @return {string}
+ */
 function dropLeadingZero(number) {
   const value = String(number);
 
@@ -31,19 +34,33 @@ function dropLeadingZero(number) {
 
   return value;
 }
-
+/**
+ * @param {number} number
+ * @param {string} originalUnit
+ * @param {Map<string, number>} conversions
+ * @return {string}
+ */
 function transform(number, originalUnit, conversions) {
   let conversionUnits = [...conversions.keys()].filter((u) => {
     return originalUnit !== u;
   });
 
-  const base = number * conversions.get(originalUnit);
+  const base = number * /** @type {number} */ (conversions.get(originalUnit));
 
   return conversionUnits
-    .map((u) => dropLeadingZero(base / conversions.get(u)) + u)
+    .map(
+      (u) =>
+        dropLeadingZero(base / /** @type {number} */ (conversions.get(u))) + u
+    )
     .reduce((a, b) => (a.length < b.length ? a : b));
 }
 
+/**
+ * @param {number} number
+ * @param {string} unit
+ * @param {{time?: boolean, length?: boolean, angle?: boolean}} options
+ * @return {string}
+ */
 module.exports = function (number, unit, { time, length, angle }) {
   let value = dropLeadingZero(number) + (unit ? unit : '');
   let converted;

package/types/index.d.ts

@@ -0,0 +1,19 @@
+export = pluginCreator;
+/**
+ * @typedef {{precision: boolean | number, angle?: boolean, time?: boolean, length?: boolean}} Options */
+/**
+ * @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 = {
+    precision: boolean | number;
+    angle?: boolean;
+    time?: boolean;
+    length?: boolean;
+};
+declare var postcss: true;

package/types/lib/convert.d.ts

@@ -0,0 +1,6 @@
+declare function _exports(number: number, unit: string, { time, length, angle }: {
+    time?: boolean;
+    length?: boolean;
+    angle?: boolean;
+}): string;
+export = _exports;