vibe-coding-cn/libs/README.md

# 📦 通用库与外部集成 (Libs)

`libs/` 目录存放项目的通用库代码和外部集成模块，用于项目内部模块化和工具复用。

## 目录结构

```
libs/
├── README.md                # 本文件
├── common/                  # 通用功能模块
│   ├── __init__.py
│   ├── models/              # 数据模型定义
│   │   └── __init__.py
│   └── utils/               # 工具函数
│       └── backups/         # 备份工具
├── database/                # 数据库相关模块（预留）
│   └── .gitkeep
└── external/                # 外部集成与第三方工具
    ├── prompts-library/     # 提示词库管理工具
    ├── my-nvim/             # Neovim 配置
    └── XHS-image-to-PDF-conversion/  # 小红书图片转 PDF
```

## 各子目录详解

### `common/` - 通用功能模块

存放项目内部共享的通用代码：

- `models/` - 数据模型定义，如 Pydantic 模型、数据类等
- `utils/` - 工具函数，如文件处理、格式转换等
- `utils/backups/` - 备份相关工具函数

### `database/` - 数据库模块（预留）

预留的数据库适配层，用于未来扩展数据持久化功能。

### `external/` - 外部集成

#### `prompts-library/` - 提示词库管理工具

Excel ↔ Markdown 提示词互转工具：

```bash
cd libs/external/prompts-library
pip install -r requirements.txt
python main.py
```

功能：
- Excel 转 Markdown：批量将表格提示词转为 .md 文件
- Markdown 转 Excel：将 .md 文件汇总到表格中
- 支持分类、标签、版本管理

#### `my-nvim/` - Neovim 配置

个人 Neovim 配置，基于 LazyVim，包含：
- LSP 配置
- 代码补全
- 文件导航
- Git 集成

#### `XHS-image-to-PDF-conversion/` - 小红书图片转 PDF

将小红书图片合并为 PDF 的工具：

```bash
cd libs/external/XHS-image-to-PDF-conversion
pip install -r requirements.txt
python pdf.py
```

## 使用原则

1. **分层边界**: `common/` 只放通用代码，业务逻辑放其他地方
2. **单一职责**: 每个模块只做一件事
3. **依赖记录**: 新增外部依赖时更新对应的 `requirements.txt`
4. **文档同步**: 新增模块时更新本 README

## 新增模块指南

```bash
# 新增通用模块
mkdir -p libs/common/新模块名
touch libs/common/新模块名/__init__.py

# 新增外部集成
mkdir -p libs/external/工具名
echo "# 工具说明" > libs/external/工具名/README.md
```