# object-all

**Repository Path**: harryxiaocn/object-all

## Basic Information

- **Project Name**: object-all
- **Description**: 将项目输出为一个markdown格式的文件，便于给大模型分析。
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-11-15
- **Last Updated**: 2024-11-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 文件树生成工具

## 简介

此工具用于生成指定目录下的文件树，并将其输出为 Markdown 格式的文件。生成的文件树包含文件的大小、修改时间和内容（如果是文本文件）。此外，工具还会读取 `.gitignore` 文件以排除不需要的文件和目录。

## 功能

- 自动生成目录结构的 Markdown 文件。
- 显示文件的大小、修改时间和内容（仅限文本文件）。
- 支持 `.gitignore` 文件中的忽略规则。
- 可以指定白名单文件，只显示这些文件的详细信息。

## 依赖项

- Python 3.x
- `os` 模块
- `datetime` 模块
- `fnmatch` 模块

## 安装

确保你已经安装了 Python 3。你可以从 [Python 官方网站](https://www.python.org/) 下载并安装最新版本的 Python。

## 使用方法

### 命令行调用

你可以直接运行脚本，并传入目标目录路径和可选的白名单文件列表。例如：

```bash
python object-all C:\object_dir --white-files a.py b.py
```

### 脚本内部调用

你也可以在脚本内部调用 `file_tree_to_markdown` 函数。示例如下：

```python
file_tree_to_markdown(r'C:\object_dir', white_files=[
  'a.py', 'b.py'
])
```

### 参数说明

- `directory`：目标目录的路径。
- `output_file`（可选，默认为 `file_tree.md`）：输出的 Markdown 文件名。
- `white_files`（可选，默认为 `None`）：白名单文件列表，只有这些文件的详细信息会被显示。

## 示例输出

生成的 Markdown 文件示例如下：


- object_dir
  - **carrier_template.py**
    - Size: 1.60 KB
    - Modified: 2024-11-15 14:41:43
    - Content: 
```python
from device_tree import CarrierDeviceTree

def main_tick(device_tree: CarrierDeviceTree):
  # ...
```
  - **device_tree.py**
    - Size: 2.35 KB
    - Modified: 2024-11-15 14:55:00
    - Content: 
```python
from typing import Dict, Tuple, Any

class DeviceTree:
  # ...
```
  - static
    - css
    - js
    - py
  - templates
---


## 注意事项

1. **文件编码**：默认情况下，脚本假设文件的编码为 UTF-8。如果文件使用其他编码，请在打开文件时指定正确的编码。
2. **性能**：对于非常大的目录，生成文件树可能需要较长时间。建议在测试环境中先运行脚本，确保其性能符合要求。
3. **忽略规则**：`.gitignore` 文件中的规则将被解析并应用于文件树生成过程中。请确保 `.gitignore` 文件的规则正确无误。

## 贡献

欢迎贡献代码和提出改进建议！请通过 GitHub 提交 Pull Request 或 Issue。

## 许可证

此项目采用 MIT 许可证。详情参见 [LICENSE](LICENSE) 文件。