Crate flatten_rust

Crate flatten_rust 

Source
Expand description

§Flatten Rust (Library)

Этот крейт предоставляет основную функциональность для утилиты flatten-rust, инструмента для “сглаживания” кодовых баз в единый markdown-файл. Он включает в себя логику для обхода директорий, фильтрации файлов на основе шаблонов исключений, параллельной обработки и форматирования вывода.

§Основные компоненты:

  • Args: Структура для парсинга аргументов командной строки с использованием clap.
  • run: Асинхронная функция, являющаяся основной точкой входа в библиотеку.
  • FlattenConfig: Структура для управления конфигурацией процесса “сглаживания”.
  • config: Модуль для управления шаблонами исключений (например, из .gitignore).
  • exclusions: Модуль для управления логикой исключения файлов и папок.

§Примеры

Хотя этот крейт в основном предназначен для использования через CLI, его компоненты могут быть использованы и программно.

use flatten_rust::Args;
use anyhow::Result;
use clap::Parser;

#[tokio::main]
async fn main() -> Result<()> {
    // Пример парсинга аргументов и запуска
    let args = Args::parse_from(["flatten-rust", "-f", ".", "-d"]);
    flatten_rust::run(&args).await?;
    Ok(())
}

Modules§

config
Модуль для управления шаблонами исключений.
exclusions
Модуль для управления логикой исключений.

Structs§

Args
Высокопроизводительный инструмент для “сглаживания” кодовой базы с умными исключениями
FlattenConfig
Конфигурация процесса “сглаживания”.

Functions§

run
Основная функция-точка входа для запуска процесса “сглаживания”.