@mznjs/utils

@mznjs/utils 是一个功能丰富的工具库，提供了多种实用工具函数，包括 JSON/JSON5 处理、VSCode 配置文件读取、BEM 命名规范工具和日志工具等。

安装

# 使用 pnpm
pnpm add @mznjs/utils

# 使用 npm
npm install @mznjs/utils

# 使用 yarn
yarn add @mznjs/utils

模块结构

JSON 工具

提供标准 JSON 格式处理工具，包括 JSON 格式化、注释移除等功能。

import { removeJsoncComments, formatJson, getJsonError } from '@mznjs/utils/json';

// 移除 JSON 注释
const cleanJson = removeJsoncComments(jsonWithComments);

// 格式化 JSON
const formattedJson = formatJson(jsonString, { space: 2 });

// 获取 JSON 解析错误
const error = getJsonError(invalidJson);

详细文档请参考 JSON 工具文档。

JSON5 工具

提供 JSON5 格式的解析、序列化、格式化和验证工具。

import { parseJson5, stringifyJson5, formatJson5 } from '@mznjs/utils/json5';

// 解析 JSON5 字符串
const obj = parseJson5(json5String);

// 序列化为 JSON5 格式
const json5Str = stringifyJson5(obj, { space: 2 });

// 格式化 JSON5
const formattedJson5 = formatJson5(json5String, { space: 2 });

详细文档请参考 JSON5 工具文档。

VSCode 配置文件读取工具

用于读取和解析 VSCode 配置文件，支持多目录读取和合并。

import { readVsCodeFiles, getAllVsCodeConfigs } from '@mznjs/utils/json';

// 读取 VSCode 配置文件
const configs = await readVsCodeFiles('path/to/directory');

// 获取所有 VSCode 配置
const allConfigs = await getAllVsCodeConfigs(['dir1', 'dir2']);

详细文档请参考 VSCode 配置文件读取工具文档。

BEM 工具

提供 BEM (Block-Element-Modifier) 命名规范工具，用于生成符合 BEM 规范的 CSS 类名和变量。

import { useBEM } from '@mznjs/utils/bem';

// 创建 BEM 实例
const bem = useBEM('button');

// 生成类名
bem.b(); // 'button'
bem.be('icon'); // 'button__icon'
bem.bm('primary'); // 'button--primary'
bem.bem('icon', 'small'); // 'button__icon--small'

详细文档请参考 BEM 工具文档。

日志工具

提供基于 consola 的日志记录工具，支持多级别日志输出、标签和环境配置。

import { logger } from '@mznjs/utils/logger';

// 不同级别的日志输出
logger.debug('调试信息');
logger.info('一般信息');
logger.success('操作成功');
logger.warn('警告信息');
logger.error('错误信息');

// 创建带标签的日志实例
const apiLogger = logger.create('api');
apiLogger.info('API 请求开始');

详细文档请参考 日志工具文档。