Move plugin types into d.ts

svg · Nov 11, 2022 · e2e65cf · e2e65cf
1 parent a40fa21
commit e2e65cf
Show file tree

Hide file tree

Showing 51 changed files with 263 additions and 189 deletions.
diff --git a/plugins/addAttributesToSVGElement.js b/plugins/addAttributesToSVGElement.js
@@ -47,10 +47,7 @@ plugins: [
  *
  * @author April Arcus
  *
- * @type {import('../lib/types').Plugin<{
- *   attribute?: string | Record<string, null | string>,
- *   attributes?: Array<string | Record<string, null | string>>
- * }>}
+ * @type {import('./plugins-types').Plugin<'addAttributesToSVGElement'>}
  */
 exports.fn = (root, params) => {
   if (!Array.isArray(params.attributes) && !params.attribute) {

diff --git a/plugins/addClassesToSVGElement.js b/plugins/addClassesToSVGElement.js
@@ -49,10 +49,7 @@ plugins: [
  *
  * @author April Arcus
  *
- * @type {import('../lib/types').Plugin<{
- *   className?: string,
- *   classNames?: Array<string>
- * }>}
+ * @type {import('./plugins-types').Plugin<'addClassesToSVGElement'>}
  */
 exports.fn = (root, params) => {
   if (

diff --git a/plugins/cleanupAttrs.js b/plugins/cleanupAttrs.js
@@ -13,11 +13,7 @@ const regSpaces = /\s{2,}/g;
  *
  * @author Kir Belevich
  *
- * @type {import('../lib/types').Plugin<{
- *   newlines?: boolean,
- *   trim?: boolean,
- *   spaces?: boolean
- * }>}
+ * @type {import('./plugins-types').Plugin<'cleanupAttrs'>}
  */
 exports.fn = (root, params) => {
   const { newlines = true, trim = true, spaces = true } = params;

diff --git a/plugins/cleanupEnableBackground.js b/plugins/cleanupEnableBackground.js
@@ -18,7 +18,7 @@ exports.description =
  *
  * @author Kir Belevich
  *
- * @type {import('../lib/types').Plugin<void>}
+ * @type {import('./plugins-types').Plugin<'cleanupEnableBackground'>}
  */
 exports.fn = (root) => {
   const regEnableBackground =

diff --git a/plugins/cleanupIds.js b/plugins/cleanupIds.js
@@ -123,13 +123,7 @@ const getIdString = (arr) => {
  *
  * @author Kir Belevich
  *
- * @type {import('../lib/types').Plugin<{
- *   remove?: boolean,
- *   minify?: boolean,
- *   preserve?: Array<string>,
- *   preservePrefixes?: Array<string>,
- *   force?: boolean,
- * }>}
+ * @type {import('./plugins-types').Plugin<'cleanupIds'>}
  */
 exports.fn = (_root, params) => {
   const {

diff --git a/plugins/cleanupListOfValues.js b/plugins/cleanupListOfValues.js
@@ -32,12 +32,7 @@ const absoluteLengths = {
  *
  * @author kiyopikko
  *
- * @type {import('../lib/types').Plugin<{
- *   floatPrecision?: number,
- *   leadingZero?: boolean,
- *   defaultPx?: boolean,
- *   convertToPx?: boolean
- * }>}
+ * @type {import('./plugins-types').Plugin<'cleanupListOfValues'>}
  */
 exports.fn = (_root, params) => {
   const {

diff --git a/plugins/cleanupNumericValues.js b/plugins/cleanupNumericValues.js
@@ -25,12 +25,7 @@ const absoluteLengths = {
  *
  * @author Kir Belevich
  *
- * @type {import('../lib/types').Plugin<{
- *   floatPrecision?: number,
- *   leadingZero?: boolean,
- *   defaultPx?: boolean,
- *   convertToPx?: boolean
- * }>}
+ * @type {import('./plugins-types').Plugin<'cleanupNumericValues'>}
  */
 exports.fn = (_root, params) => {
   const {

diff --git a/plugins/collapseGroups.js b/plugins/collapseGroups.js
@@ -49,7 +49,7 @@ const hasAnimatedAttr = (node, name) => {
  *
  * @author Kir Belevich
  *
- * @type {import('../lib/types').Plugin<void>}
+ * @type {import('./plugins-types').Plugin<'collapseGroups'>}
  */
 exports.fn = () => {
   return {

diff --git a/plugins/convertColors.js b/plugins/convertColors.js
@@ -61,13 +61,7 @@ const convertRgbToHex = ([r, g, b]) => {
  *
  * @author Kir Belevich
  *
- * @type {import('../lib/types').Plugin<{
- *   currentColor?: boolean | string | RegExp,
- *   names2hex?: boolean,
- *   rgb2hex?: boolean,
- *   shorthex?: boolean,
- *   shortname?: boolean,
- * }>}
+ * @type {import('./plugins-types').Plugin<'convertColors'>}
  */
 exports.fn = (_root, params) => {
   const {

diff --git a/plugins/convertEllipseToCircle.js b/plugins/convertEllipseToCircle.js
@@ -10,7 +10,7 @@ exports.description = 'converts non-eccentric <ellipse>s to <circle>s';
  *
  * @author Taylor Hunt
  *
- * @type {import('../lib/types').Plugin<void>}
+ * @type {import('./plugins-types').Plugin<'convertEllipseToCircle'>}
  */
 exports.fn = () => {
   return {

diff --git a/plugins/convertPathData.js b/plugins/convertPathData.js
@@ -82,26 +82,7 @@ let arcTolerance;
  *
  * @author Kir Belevich
  *
- * @type {import('../lib/types').Plugin<{
- *  applyTransforms?: boolean,
- *  applyTransformsStroked?: boolean,
- *  makeArcs?: {
- *    threshold: number,
- *    tolerance: number,
- *  },
- *  straightCurves?: boolean,
- *  lineShorthands?: boolean,
- *  curveSmoothShorthands?: boolean,
- *  floatPrecision?: number | false,
- *  transformPrecision?: number,
- *  removeUseless?: boolean,
- *  collapseRepeated?: boolean,
- *  utilizeAbsolute?: boolean,
- *  leadingZero?: boolean,
- *  negativeExtraSpace?: boolean,
- *  noSpaceAfterFlags?: boolean,
- *  forceAbsolutePath?: boolean,
- * }>}
+ * @type {import('./plugins-types').Plugin<'convertPathData'>}
  */
 exports.fn = (root, params) => {
   const {

diff --git a/plugins/convertShapeToPath.js b/plugins/convertShapeToPath.js
@@ -21,10 +21,7 @@ const regNumber = /[-+]?(?:\d*\.\d+|\d+\.?)(?:[eE][-+]?\d+)?/g;
  *
  * @author Lev Solntsev
  *
- * @type {import('../lib/types').Plugin<{
- *   convertArcs?: boolean,
- *   floatPrecision?: number
- * }>}
+ * @type {import('./plugins-types').Plugin<'convertShapeToPath'>}
  */
 exports.fn = (root, params) => {
   const { convertArcs = false, floatPrecision: precision } = params;

diff --git a/plugins/convertStyleToAttrs.js b/plugins/convertStyleToAttrs.js
@@ -65,9 +65,7 @@ const regStripComments = new RegExp(
  *
  * @author Kir Belevich
  *
- * @type {import('../lib/types').Plugin<{
- *   keepImportant?: boolean
- * }>}
+ * @type {import('./plugins-types').Plugin<'convertStyleToAttrs'>}
  */
 exports.fn = (_root, params) => {
   const { keepImportant = false } = params;

diff --git a/plugins/convertTransform.js b/plugins/convertTransform.js
@@ -24,20 +24,7 @@ exports.description = 'collapses multiple transformations and optimizes it';
  *
  * @author Kir Belevich
  *
- * @type {import('../lib/types').Plugin<{
- *   convertToShorts?: boolean,
- *   degPrecision?: number,
- *   floatPrecision?: number,
- *   transformPrecision?: number,
- *   matrixToTransform?: boolean,
- *   shortTranslate?: boolean,
- *   shortScale?: boolean,
- *   shortRotate?: boolean,
- *   removeUseless?: boolean,
- *   collapseIntoOne?: boolean,
- *   leadingZero?: boolean,
- *   negativeExtraSpace?: boolean,
- * }>}
+ * @type {import('./plugins-types').Plugin<'convertTransform'>}
  */
 exports.fn = (_root, params) => {
   const {

diff --git a/plugins/inlineStyles.js b/plugins/inlineStyles.js
@@ -63,12 +63,7 @@ const toAny = (value) => value;
  *
  * @author strarsis <strarsis@gmail.com>
  *
- * @type {import('../lib/types').Plugin<{
- *   onlyMatchedOnce?: boolean,
- *   removeMatchedSelectors?: boolean,
- *   useMqs?: Array<string>,
- *   usePseudos?: Array<string>
- * }>}
+ * @type {import('./plugins-types').Plugin<'inlineStyles'>}
  */
 exports.fn = (root, params) => {
   const {

diff --git a/plugins/mergePaths.js b/plugins/mergePaths.js
@@ -12,11 +12,7 @@ exports.description = 'merges multiple paths in one if possible';
  *
  * @author Kir Belevich, Lev Solntsev
  *
- * @type {import('../lib/types').Plugin<{
- *   force?: boolean,
- *   floatPrecision?: number,
- *   noSpaceAfterFlags?: boolean
- * }>}
+ * @type {import('./plugins-types').Plugin<'mergePaths'>}
  */
 exports.fn = (root, params) => {
   const {

diff --git a/plugins/mergeStyles.js b/plugins/mergeStyles.js
@@ -15,7 +15,7 @@ exports.description = 'merge multiple style elements into one';
  *
  * @author strarsis <strarsis@gmail.com>
  *
- * @type {import('../lib/types').Plugin<void>}
+ * @type {import('./plugins-types').Plugin<'mergeStyles'>}
  */
 exports.fn = () => {
   /**

diff --git a/plugins/minifyStyles.js b/plugins/minifyStyles.js
@@ -15,14 +15,7 @@ exports.description =
  *
  * @author strarsis <strarsis@gmail.com>
  *
- * @type {import('../lib/types').Plugin<csso.MinifyOptions & Omit<csso.CompressOptions, 'usage'> & {
- *   usage?: boolean | {
- *     force?: boolean,
- *     ids?: boolean,
- *     classes?: boolean,
- *     tags?: boolean
- *   }
- * }>}
+ * @type {import('./plugins-types').Plugin<'minifyStyles'>}
  */
 exports.fn = (_root, { usage, ...params }) => {
   let enableTagsUsage = true;

diff --git a/plugins/moveElemsAttrsToGroup.js b/plugins/moveElemsAttrsToGroup.js
@@ -26,7 +26,7 @@ exports.description = 'Move common attributes of group children to the group';
  *
  * @author Kir Belevich
  *
- * @type {import('../lib/types').Plugin<void>}
+ * @type {import('./plugins-types').Plugin<'moveElemsAttrsToGroup'>}
  */
 exports.fn = (root) => {
   // find if any style element is present

diff --git a/plugins/moveGroupAttrsToElems.js b/plugins/moveGroupAttrsToElems.js
@@ -23,7 +23,7 @@ const pathElemsWithGroupsAndText = [...pathElems, 'g', 'text'];
  *
  * @author Kir Belevich
  *
- * @type {import('../lib/types').Plugin<void>}
+ * @type {import('./plugins-types').Plugin<'moveGroupAttrsToElems'>}
  */
 exports.fn = () => {
   return {