项目转文本

概述

一个小工具，将您的项目转成包含 项目结构树和文件内容 的.md文件，方便直接粘贴给生成式AI

安装

1. 克隆仓库：git clone https://github.com/yourusername/project-processor-for-ai.git cd project-processor-for-ai
2. 无需额外安装 - 只需确保已安装 Python 3.6+。

使用方法

1. 运行脚本：python main.py
2. 根据提示输入项目目录的绝对路径：Enter the absolute path of the project: /path/to/your/project
3. 脚本将在同一父目录下创建一个名为 yourproject_processed的新文件夹，包含：00000_yourproject：带有编号索引的项目副本，所有文件均为 .txt格式project_overview.md：用于AI交互的Markdown摘要文档

示例

假设您的项目结构如下：

myproject
├── README.md
├── contracts
│   └── Example.sol
├── hardhat.config.ts
└── package.json

运行脚本后：

• 编号文件夹：00000_myproject，包含如 10000_README.txt、21000_Example.txt等文件
• project_overview.md将包含项目树和Markdown代码块中的文件内容

然后，您可以将 project_overview.md中的部分内容或单个 .txt文件复制到AI提示中进行分析。

配置

• SKIP_DIRS：添加要忽略的目录（例如构建产物）
• SKIP_FILES：添加要跳过的文件（例如锁文件、不需要的配置文件）
• LANG_MAP：扩展Markdown中代码块语法高亮的语言映射

根据需要修改脚本中的这些配置。

限制

• 仅处理文本文件；二进制文件会被复制但可能在Markdown中不可读
• 索引使用5位数字格式；对于非常深/嵌套的项目，调整 powers以使用更多数字
• 假设使用UTF-8编码；非UTF文件可能会被跳过

贡献指南

欢迎贡献！请fork本仓库并提交pull request，包含改进、错误修复或新功能。

1. Fork 本仓库
2. 创建新分支 (git checkout -b feature-branch)
3. 提交更改 (git commit -am '添加新功能')
4. 推送到分支 (git push origin feature-branch)
5. 创建Pull Request

许可证

本项目采用MIT许可证 - 详见 LICENSE文件

---

如果您遇到问题或有建议，请在GitHub上提交issue！