chore: readme::generate_* now returns String instead of writing to output

Author: Joxit

helm-docs/src/readme/mod.rs

@@ -17,10 +17,10 @@ pub fn generate_readme<W: Write>(writer: &mut W, directory: &PathBuf) -> Result<
   writeln!(writer, "# {} Chart", chart.pretty_name)?;
   writeln!(writer, "")?;
   writeln!(writer, "## Prerequisites")?;
-  generate_prerequisites(writer)?;
+  writeln!(writer, "{}", generate_prerequisites()?)?;
   writeln!(writer, "## Usage")?;
-  generate_usage(writer, chart)?;
+  writeln!(writer, "{}", generate_usage(chart)?)?;
   writeln!(writer, "## Configuration")?;
-  generate_table(writer, values)?;
+  write!(writer, "{}", generate_table(values)?)?;
   Ok(())
 }

helm-docs/src/readme/prerequisites.rs

@@ -1,12 +1,11 @@
-use anyhow::{Context, Result};
-use std::io::Write;
+use anyhow::Result;
 
 const PREREQUISITES: &str = r#"
   * **Helm 3.2+** (Helm 2 is not supported)
   * **Kubernetes 1.19+** - This is the earliest version of Kubernetes tested.
     It is possible that this chart works with earlier versions but it is untested.
 "#;
 
-pub fn generate_prerequisites<W: Write>(writer: &mut W) -> Result<()> {
-  writeln!(writer, "{}", PREREQUISITES).with_context(|| format!("Failed to write file"))
+pub fn generate_prerequisites() -> Result<String> {
+  Ok(PREREQUISITES.to_string())
 }

helm-docs/src/readme/table.rs

@@ -21,7 +21,8 @@ fn generate_default_value(line: &str) -> String {
   line.split_once(":").unwrap().1.trim().to_string()
 }
 
-pub fn generate_table<W: Write>(writer: &mut W, path: PathBuf) -> Result<()> {
+pub fn generate_table(path: PathBuf) -> Result<String> {
+  let mut writer: Vec<u8> = vec![];
   let mut state = 0;
   let mut comment = String::new();
   let mut key = String::new();
@@ -67,5 +68,7 @@ pub fn generate_table<W: Write>(writer: &mut W, path: PathBuf) -> Result<()> {
       state = 2;
     }
   }
-  Ok(())
+  std::str::from_utf8(&writer)
+    .with_context(|| format!("Failed to create table."))
+    .map(|s| s.to_string())
 }

helm-docs/src/readme/usage.rs

@@ -1,6 +1,5 @@
 use crate::chart::Chart;
-use anyhow::{Context, Result};
-use std::io::Write;
+use anyhow::Result;
 
 const USAGE: &str = r#"
 1. Add my Helm repository (named `joxit`)
@@ -17,13 +16,11 @@ helm upgrade --install {chart-name} joxit/{chart-name}
 ```
 "#;
 
-pub fn generate_usage<W: Write>(writer: &mut W, chart: Chart) -> Result<()> {
-  writeln!(
-    writer,
-    "{}",
+pub fn generate_usage(chart: Chart) -> Result<String> {
+  Ok(
     USAGE
       .replace("{chart-name}", &chart.name)
       .replace("{chart-pretty-name}", &chart.pretty_name)
+      .to_string(),
   )
-  .with_context(|| format!("Failed to write file"))
 }