summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorA Farzat <a@farzat.xyz>2026-06-12 03:26:50 +0300
committerA Farzat <a@farzat.xyz>2026-06-12 03:26:50 +0300
commit98b3ebcc9ab38e54bcbd6a7b1bd4f4f61aa3bd2e (patch)
tree30b1b3baf3267b301c58185166978b4f017fba06
parent03bace764370010e0e5d4a1ae696779febc063a6 (diff)
downloadrepo2markdown-98b3ebcc9ab38e54bcbd6a7b1bd4f4f61aa3bd2e.tar.gz
repo2markdown-98b3ebcc9ab38e54bcbd6a7b1bd4f4f61aa3bd2e.zip
Rename to better reflect what functions/modules doHEADmaster
-rw-r--r--src/fenced_md_generator.rs (renamed from src/md_fence_wrapper.rs)13
-rw-r--r--src/lib.rs4
-rw-r--r--src/main.rs4
-rw-r--r--src/md_generator.rs (renamed from src/run.rs)6
4 files changed, 15 insertions, 12 deletions
diff --git a/src/md_fence_wrapper.rs b/src/fenced_md_generator.rs
index 2928efa..078a8cb 100644
--- a/src/md_fence_wrapper.rs
+++ b/src/fenced_md_generator.rs
@@ -3,9 +3,12 @@ use std::{
path::Path,
};
-use crate::{logger::Logger, run::run, util::fence::generate_outer_backticks};
+use crate::{
+ logger::Logger, md_generator::generate_markdown_from_paths,
+ util::fence::generate_outer_backticks,
+};
-pub fn wrap_in_md_fence<R: Read, W: Write>(
+pub fn generate_fenced_markdown<R: Read, W: Write>(
input: R,
mut output: W,
root: &Path,
@@ -14,7 +17,7 @@ pub fn wrap_in_md_fence<R: Read, W: Write>(
logger: Logger,
) -> Result<(), Box<dyn std::error::Error>> {
let mut md_output = Vec::new();
- run(
+ generate_markdown_from_paths(
input,
&mut md_output,
root,
@@ -37,7 +40,7 @@ mod tests {
use crate::logger::Logger;
- use super::wrap_in_md_fence;
+ use super::generate_fenced_markdown;
fn wrap_with_default_logger<R: Read, W: Write>(
input: R,
@@ -47,7 +50,7 @@ mod tests {
project_title: Option<&str>,
) -> Result<(), Box<dyn std::error::Error>> {
let logger = Logger::default();
- wrap_in_md_fence(input, output, root, origin_base, project_title, logger)
+ generate_fenced_markdown(input, output, root, origin_base, project_title, logger)
}
#[test]
diff --git a/src/lib.rs b/src/lib.rs
index 296f4f4..400b5b5 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -1,6 +1,6 @@
+pub mod fenced_md_generator;
pub mod logger;
-pub mod md_fence_wrapper;
+pub mod md_generator;
pub mod normalizer;
pub mod renderer;
-pub mod run;
mod util;
diff --git a/src/main.rs b/src/main.rs
index b558ae4..5472198 100644
--- a/src/main.rs
+++ b/src/main.rs
@@ -6,7 +6,7 @@ use std::{
use repo2markdown::{
logger::{Logger, Verbosity},
- run::run,
+ md_generator::generate_markdown_from_paths,
};
fn main() -> Result<(), Box<dyn std::error::Error>> {
@@ -42,7 +42,7 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
let stdout = io::stdout();
let logger = Logger::new(Verbosity::Verbose);
- run(
+ generate_markdown_from_paths(
stdin.lock(),
stdout.lock(),
root,
diff --git a/src/run.rs b/src/md_generator.rs
index c276d7c..44802af 100644
--- a/src/run.rs
+++ b/src/md_generator.rs
@@ -12,7 +12,7 @@ use crate::{
const DEFAULT_PROJECT_NAME: &str = "Project Outline";
-pub fn run<R: Read, W: Write>(
+pub fn generate_markdown_from_paths<R: Read, W: Write>(
mut input: R,
output: W,
root: &Path,
@@ -70,7 +70,7 @@ mod tests {
use crate::logger::Logger;
use tempfile::tempdir;
- use super::{DEFAULT_PROJECT_NAME, derive_project_title, run};
+ use super::{DEFAULT_PROJECT_NAME, derive_project_title, generate_markdown_from_paths};
fn paths_to_null_sep_bytes(file_paths: &[&Path]) -> Vec<u8> {
let mut output = Vec::new();
@@ -89,7 +89,7 @@ mod tests {
project_title: Option<&str>,
) -> Result<(), Box<dyn std::error::Error>> {
let logger = Logger::default();
- run(input, output, root, origin_base, project_title, logger)
+ generate_markdown_from_paths(input, output, root, origin_base, project_title, logger)
}
#[test]