chore: fix cheerio types

iconify · Aug 11, 2024 · 3d8d54b · 3d8d54b
1 parent 89052a0
commit 3d8d54b
Show file tree

Hide file tree

Showing 7 changed files with 81 additions and 606 deletions.
diff --git a/@iconify/tools/package.json b/@iconify/tools/package.json
@@ -3,7 +3,7 @@
 	"type": "module",
 	"description": "Collection of functions for cleaning up and parsing SVG for Iconify project",
 	"author": "Vjacheslav Trushkin",
-	"version": "4.0.4",
+	"version": "4.0.5",
 	"license": "MIT",
 	"bugs": "https://github.com/iconify/tools/issues",
 	"homepage": "https://github.com/iconify/tools",
@@ -29,7 +29,8 @@
 		"@iconify/utils": "^2.1.29",
 		"@types/tar": "^6.1.13",
 		"axios": "^1.7.3",
-		"cheerio": "1.0.0-rc.12",
+		"cheerio": "1.0.0",
+		"domhandler": "^5.0.3",
 		"extract-zip": "^2.0.1",
 		"local-pkg": "^0.5.0",
 		"pathe": "^1.1.2",

diff --git a/@iconify/tools/src/misc/cheerio.ts b/@iconify/tools/src/misc/cheerio.ts
@@ -1,7 +1,8 @@
-import * as cheerio from 'cheerio';
+import type { Element } from 'domhandler';
+import type { Cheerio } from 'cheerio';
 
 /**
  * Shortcuts for Cheerio elements
  */
-export type CheerioElement = cheerio.Element;
-export type WrappedCheerioElement = cheerio.Cheerio<cheerio.Element>;
+export type CheerioElement = Element;
+export type WrappedCheerioElement = Cheerio<CheerioElement>;
diff --git a/@iconify/tools/src/optimise/figma.ts b/@iconify/tools/src/optimise/figma.ts
@@ -1,5 +1,5 @@
 import { colorToString, stringToColor } from '@iconify/utils';
-import { CheerioElement } from '../misc/cheerio';
+import type { CheerioElement } from '../misc/cheerio';
 import { SVG } from '../svg';
 import { cleanupInlineStyle } from '../svg/cleanup/inline-style';
 import { defsTag, maskTags, symbolTag } from '../svg/data/tags';

diff --git a/@iconify/tools/src/svg/analyse/types.ts b/@iconify/tools/src/svg/analyse/types.ts
@@ -1,4 +1,4 @@
-import { CheerioElement } from '../../misc/cheerio';
+import type { CheerioElement } from '../../misc/cheerio';
 
 /**
  * Options

diff --git a/@iconify/tools/src/svg/cleanup/root-svg.ts b/@iconify/tools/src/svg/cleanup/root-svg.ts
@@ -1,4 +1,4 @@
-import { CheerioElement } from '../../misc/cheerio';
+import type { CheerioElement } from '../../misc/cheerio';
 import type { SVG } from '../../svg';
 import {
 	badAttributes,
@@ -112,6 +112,7 @@ export function cleanupSVGRoot(svg: SVG) {
 
 		$root.children().each((_index, child) => {
 			const $child = cheerio(child);
+			// eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
 			if (child.type !== 'tag') {
 				$child.appendTo($wrapper);
 				return;

diff --git a/@iconify/tools/src/svg/index.ts b/@iconify/tools/src/svg/index.ts
@@ -169,6 +169,7 @@ export class SVG {
 
 		// Load content
 		this.$svg = cheerio.load(content.trim(), {
+			// @ts-expect-error Legacy attribute, kept because Cheerio types are a unstable
 			lowerCaseAttributeNames: false,
 			xmlMode: true,
 		});