@bhsd/common 2.2.1 → 4.0.0

package/README.md

@@ -1,4 +1,4 @@
 # @bhsd/common
 
 [![npm version](https://badge.fury.io/js/@bhsd%2Fcommon.svg)](https://www.npmjs.com/package/@bhsd/common)
-[![License](https://img.shields.io/badge/License-MIT-brightgreen.svg)](LICENSE)
+[![CodeQL](https://github.com/bhsd-harry/common/actions/workflows/codeql.yml/badge.svg)](https://github.com/bhsd-harry/common/actions/workflows/codeql.yml)

package/dist/color.d.ts

@@ -0,0 +1,11 @@
+export { colorsNamed } from 'culori/fn';
+/**
+ * 将颜色字符串转换为 RGBA 数组
+ * @param color 颜色字符串
+ */
+export declare const rgba: (color: string) => [number, number, number, number] | [];
+/**
+ * 将颜色字符串转换为 HSLA 数组
+ * @param color 颜色字符串
+ */
+export declare const hsla: (color: string) => [number, number, number, number] | [];

package/dist/color.js

@@ -0,0 +1,28 @@
+import { useMode, modeRgb, modeHsl } from 'culori/fn';
+export { colorsNamed } from 'culori/fn';
+const parseRGB = /* #__PURE__ */ useMode(modeRgb), parseHSL = /* #__PURE__ */ useMode(modeHsl);
+const normalizeRGB = (component) => Math.min(255, Math.max(0, Math.round(component * 255))), normalizeAlpha = (alpha) => Math.round(alpha * 1e3) / 1e3;
+/**
+ * 将颜色字符串转换为 RGBA 数组
+ * @param color 颜色字符串
+ */
+export const rgba = (color) => {
+    const result = parseRGB(color.trim().toLowerCase());
+    if (!result) {
+        return [];
+    }
+    const { r, g, b, alpha = 1 } = result;
+    return [...[r, g, b].map(normalizeRGB), normalizeAlpha(alpha)];
+};
+/**
+ * 将颜色字符串转换为 HSLA 数组
+ * @param color 颜色字符串
+ */
+export const hsla = (color) => {
+    const result = parseHSL(color.trim().toLowerCase());
+    if (!result) {
+        return [];
+    }
+    const { h = 0, s, l, alpha = 1 } = result;
+    return [...[h, s * 100, l * 100].map(Math.round), normalizeAlpha(alpha)];
+};

package/dist/index.d.ts

@@ -20,8 +20,9 @@ export declare const rawurldecode: (str: string) => string;
 /**
  * 将0~255之间的整数转换为十六进制
  * @param d 0~255之间的整数
+ * @param len 十六进制数的最小长度，默认为2
  */
-export declare const intToHex: (d: number) => string;
+export declare const intToHex: (d: number, len?: number) => string;
 /**
  * 将0~1之间的数字转换为十六进制
  * @param d 0~1之间的数字
@@ -30,9 +31,9 @@ export declare const numToHex: (d: number) => string;
 /**
  * 包含颜色时断开字符串
  * @param str 字符串
- * @param hsl 是否包含 HSL
+ * @param names 颜色名称列表，如果提供则也会匹配这些名称，否则只匹配十六进制代码和函数
  */
-export declare const splitColors: (str: string, hsl?: boolean) => [string, number, number, boolean][];
+export declare const splitColors: (str: string, names?: string[] | false) => [string, number, number, boolean][];
 /**
  * 清理内联样式中的`{`和`}`
  * @param style 内联样式

package/dist/index.js

@@ -4,31 +4,36 @@ export const wmf = 'wiktionary|wiki(?:pedia|books|news|quote|source|versity|voya
  * PHP的`rawurldecode`函数的JavaScript实现
  * @param str 要解码的字符串
  */
-export const rawurldecode = (str) => decodeURIComponent(str.replace(/%(?![\da-f]{2})/giu, '%25'));
+export const rawurldecode = (str) => 
+// eslint-disable-next-line unicorn/prefer-string-replace-all
+decodeURIComponent(str.replace(/%(?![\da-f]{2})/giu, '%25'));
 /**
  * 将0~255之间的整数转换为十六进制
  * @param d 0~255之间的整数
+ * @param len 十六进制数的最小长度，默认为2
  */
-export const intToHex = (d) => Math.round(d).toString(16).padStart(2, '0');
+export const intToHex = (d, len = 2) => Math.round(d).toString(16).padStart(len, '0');
 /**
  * 将0~1之间的数字转换为十六进制
  * @param d 0~1之间的数字
  */
 export const numToHex = (d) => intToHex(d * 255);
 const regex = /* #__PURE__ */ (() => {
-    const hexColor = String.raw `#(?:[\da-f]{3,4}|(?:[\da-f]{2}){3,4})(?![\p{L}\p{N}_])`, rgbValue = String.raw `(?:\d*\.)?\d+%?`, hue = String.raw `(?:\d*\.)?\d+(?:deg|grad|rad|turn)?`, rgbColor = String.raw `rgba?\(\s*(?:${String.raw `${new Array(3).fill(rgbValue).join(String.raw `\s+`)}(?:\s*\/\s*${rgbValue})?`}|${String.raw `${new Array(3).fill(rgbValue).join(String.raw `\s*,\s*`)}(?:\s*,\s*${rgbValue})?`})\s*\)`, hslColor = String.raw `hsla?\(\s*(?:${String.raw `${hue}\s+${rgbValue}\s+${rgbValue}(?:\s*\/\s*${rgbValue})?`}|${String.raw `${hue}${String.raw `\s*,\s*(?:\d*\.)?\d+%`.repeat(2)}(?:\s*,\s*${rgbValue})?`})\s*\)`;
+    const wordChar = String.raw `\p{L}\p{N}_`, wordBoundary = `(?![${wordChar}])`, hex = String.raw `[\da-f]`, hexColor = `#(?:${hex}{3,4}|(?:${hex}{2}){3,4})${wordBoundary}`, num = String.raw `[+-]?(?:\d*\.)?\d+`, per = `${num}%`, rgbValue = `${per}?`, rgbArr = Array.from({ length: 3 }, () => rgbValue), space = String.raw `\s+`, comma = String.raw `\s*,\s*`, slash = String.raw `\s*\/\s*`, rgbColor = String.raw `rgba?\(\s*(?:${`${rgbArr.join(space)}(?:${slash}${rgbValue})?`}|${`${rgbArr.join(comma)}(?:${comma}${rgbValue})?`})\s*\)`, hslColor = String.raw `hsla?\(\s*${num}(?:deg|g?rad|turn)?(?:${`${(space + rgbValue).repeat(2)}(?:${slash}${rgbValue})?`}|${`${(comma + per).repeat(2)}(?:${comma}${rgbValue})?`})\s*\)`, source = `(^|[^${wordChar}])(${hexColor}|${rgbColor}|${hslColor}`;
     return {
-        full: new RegExp(String.raw `(^|[^\p{L}\p{N}_])(${hexColor}|${rgbColor}|${hslColor})`, 'giu'),
-        rgb: new RegExp(String.raw `(^|[^\p{L}\p{N}_])(${hexColor}|${rgbColor})`, 'giu'),
+        full: new RegExp(`${source})`, 'giu'),
+        names: `${source}|(?:transparent|$1)${wordBoundary})`,
     };
 })();
 /**
  * 包含颜色时断开字符串
  * @param str 字符串
- * @param hsl 是否包含 HSL
+ * @param names 颜色名称列表，如果提供则也会匹配这些名称，否则只匹配十六进制代码和函数
  */
-export const splitColors = (str, hsl = true) => {
-    const pieces = [], re = regex[hsl ? 'full' : 'rgb'];
+export const splitColors = (str, names) => {
+    const pieces = [], re = Array.isArray(names) && names.length > 0
+        ? new RegExp(regex.names.replace('$1', names.join('|')), 'giu')
+        : regex.full;
     re.lastIndex = 0;
     let mt = re.exec(str), lastIndex = 0;
     while (mt) {
@@ -49,7 +54,7 @@ export const splitColors = (str, hsl = true) => {
  * 清理内联样式中的`{`和`}`
  * @param style 内联样式
  */
-export const sanitizeInlineStyle = (style) => style.replace(/[{}]/gu, p => p === '{' ? '｛' : '｝')
+export const sanitizeInlineStyle = (style) => style.replaceAll(/[{}]/gu, p => p === '{' ? '｛' : '｝')
     .replace(/^[\s;]+/u, p => p.replaceAll(';', ' '));
 export function getRegex(f) {
     const map = new Map(), weakMap = new WeakMap();
@@ -161,6 +166,7 @@ export const lintJSON = (str) => {
         return [];
     }
     const errors = lintJSONBase(str, json_parse);
+    // eslint-disable-next-line unicorn/prefer-at
     return errors[errors.length - 1]?.severity === 'error' ? errors : [...errors, ...lintJSONNative(str)];
 };
 /**

package/dist/json_parse.d.ts

@@ -0,0 +1,18 @@
+export interface JsonSyntaxError {
+    warnings: ExtendedJsonSyntaxError[];
+    severity?: "error" | "warning";
+    message?: string;
+    from?: number | null;
+    to?: number;
+    /** @deprecated */
+    position?: number;
+}
+export interface ExtendedJsonSyntaxError extends Omit<JsonSyntaxError, "warnings"> {
+    severity: "error" | "warning";
+    message: string;
+    line?: number | null;
+    column?: number | null;
+    endLine?: number;
+    endColumn?: number;
+}
+export declare const json_parse: (source: string) => void, jsonc_parse: (source: string) => void;

package/dist/json_parse.js

@@ -392,4 +392,4 @@ const factory = (jsonc) => {
         }
     };
 };
-export const json_parse = /* @__PURE__ */ factory(), jsonc_parse = /* @__PURE__ */ factory(true);
+export const json_parse = /* #__PURE__ */ factory(), jsonc_parse = /* #__PURE__ */ factory(true);

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@bhsd/common",
-	"version": "2.2.1",
+	"version": "4.0.0",
 	"homepage": "https://github.com/bhsd-harry/common#readme",
 	"bugs": {
 		"url": "https://github.com/bhsd-harry/common/issues"
@@ -8,11 +8,14 @@
 	"license": "MIT",
 	"author": "Bhsd",
 	"files": [
-		"/dist/*.js",
-		"/dist/index.d.ts"
+		"/dist/"
 	],
 	"main": "./dist/index.js",
 	"types": "./dist/index.d.ts",
+	"exports": {
+		".": "./dist/index.js",
+		"./color": "./dist/color.js"
+	},
 	"type": "module",
 	"sideEffects": false,
 	"scripts": {
@@ -21,25 +24,23 @@
 		"build": "tsc",
 		"lint:ts": "tsc --noEmit && eslint --cache .",
 		"lint": "npm run lint:ts",
-		"test": "mocha"
+		"test": "testUtil test/*.test.js"
+	},
+	"peerDependencies": {
+		"culori": "^4.0.0"
+	},
+	"peerDependenciesMeta": {
+		"culori": {
+			"optional": true
+		}
 	},
 	"devDependencies": {
-		"@bhsd/code-standard": "^2.4.1",
-		"@eslint-community/eslint-plugin-eslint-comments": "^4.7.1",
-		"@stylistic/eslint-plugin": "^5.10.0",
-		"@types/mocha": "^10.0.10",
-		"@typescript-eslint/eslint-plugin": "^8.59.1",
-		"@typescript-eslint/parser": "^8.59.1",
-		"esbuild": "^0.28.0",
-		"eslint": "^10.3.0",
-		"eslint-plugin-es-x": "^9.6.0",
-		"eslint-plugin-jsdoc": "^62.9.0",
-		"eslint-plugin-jsonc": "^3.1.2",
-		"eslint-plugin-promise": "^7.3.0",
-		"eslint-plugin-regexp": "^3.1.0",
-		"eslint-plugin-unicorn": "^64.0.0",
-		"eslint-plugin-yml": "^3.3.2",
-		"mocha": "^11.7.5",
+		"@bhsd/code-standard": "^3.1.0",
+		"@bhsd/lezer-json": "^2.1.0",
+		"@bhsd/test-util": "^3.1.0",
+		"@types/culori": "^4.0.1",
+		"culori": "^4.0.2",
+		"eslint": "^10.7.0",
 		"typescript": "^6.0.3"
 	},
 	"engines": {