# Easy-Utils

**Repository Path**: tengzor/easy-utils

## Basic Information

- **Project Name**: Easy-Utils
- **Description**: 一个实用、简单、纯粹的JS工具库
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2025-03-23
- **Last Updated**: 2025-12-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 🛠️ Easy Utils

[![License](https://img.shields.io/badge/license-ISC-blue.svg)](LICENSE)

`Easy Utils` 是一个轻量级的工具库，专为 **Vue 3** 项目设计，提供了一系列实用的工具函数和功能模块，帮助开发者快速构建高效的应用程序。

## ✨ 功能特性

- **日期处理**：基于 [Day.js](https://day.js.org/) 提供强大的日期格式化和操作功能。
- **代码高亮**：集成 [Highlight.js](https://highlightjs.org/)，支持代码块的语法高亮。
- **工具函数**：使用 [Lodash-es](https://lodash.com/) 提供丰富的函数式工具集。
- **Vue 3 支持**：与 Vue 3 完美兼容，适用于现代前端开发。
- **模块化设计**：通过 Rollup 打包，支持 Tree Shaking，确保按需加载。

## 📦 安装

你可以通过以下方式安装 `easy-utils`：

```bash
pnpm add easy-utils
```

或者使用 npm：

```bash
npm install easy-utils
```

## 🚀 使用方法

### 引入工具库

在你的项目中引入并使用 `easy-utils`：

```javascript
import { formatDate, highlightCode } from "easy-utils";

// 示例：格式化日期
const formattedDate = formatDate("2023-10-01", "YYYY-MM-DD");
console.log(formattedDate); // 输出: 2023-10-01

// 示例：代码高亮
const code = "const a = 1;";
const highlightedCode = highlightCode(code, "javascript");
console.log(highlightedCode);
```

## 📚 API 文档

### `formatDate(date: string, format: string): string`

- **描述**：格式化日期字符串。
- **参数**：
  - `date`：需要格式化的日期字符串。
  - `format`：目标日期格式。
- **返回值**：格式化后的日期字符串。

### `highlightCode(code: string, language: string): string`

- **描述**：对代码块进行语法高亮。
- **参数**：
  - `code`：需要高亮的代码字符串。
  - `language`：代码的语言类型（如 `javascript`、`html`）。
- **返回值**：高亮后的 HTML 字符串。

## 🛠️ 构建与发布

### 构建项目

运行以下命令以构建项目：

```bash
pnpm build
```

### 发布到 npm

确保你已登录 npm，然后运行：

```bash
npm publish
```

## 👥 贡献指南

欢迎贡献代码！请遵循以下步骤：

1. Fork 本仓库。
2. 创建新分支 (`git checkout -b feature/your-feature`)。
3. 提交更改 (`git commit -m 'Add some feature'`)。
4. 推送分支 (`git push origin feature/your-feature`)。
5. 提交 Pull Request。

---

## 📄 许可证

本项目采用 [ISC 许可证](LICENSE) 开源。