feat(tools): implement move command

.cargo/config.toml

@@ -1,2 +1,3 @@
 [env]
 TESTING_CONTENT_ROOT = { value = "tests/data/content/files", relative = true }
+TESTING_CONTENT_TRANSLATED_ROOT = { value = "tests/data/translated_content/files", relative = true }

.gitignore

@@ -1,2 +1,3 @@
 /target
 .config.toml
+.DS_Store

crates/rari-cli/main.rs

@@ -19,6 +19,7 @@ use rari_doc::search_index::build_search_index;
 use rari_doc::utils::TEMPL_RECORDER_SENDER;
 use rari_tools::history::gather_history;
 use rari_tools::popularities::update_popularities;
+use rari_tools::r#move::r#move;
 use rari_types::globals::{build_out_root, content_root, content_translated_root, SETTINGS};
 use rari_types::settings::Settings;
 use self_update::cargo_crate_version;
@@ -40,6 +41,8 @@ struct Cli {
     no_cache: bool,
     #[arg(long)]
     skip_updates: bool,
+    #[arg(short = 'y', long, help = "Assume yes to all prompts")]
+    assume_yes: bool,
     #[command(subcommand)]
     command: Commands,
 }
@@ -52,6 +55,21 @@ enum Commands {
     GitHistory,
     Popularities,
     Update(UpdateArgs),
+    #[command(subcommand)]
+    Content(ContentSubcommand),
+}
+
+#[derive(Subcommand)]
+enum ContentSubcommand {
+    /// Moves content from one slug to another
+    Move(MoveArgs),
+}
+
+#[derive(Args)]
+struct MoveArgs {
+    old_slug: String,
+    new_slug: String,
+    locale: Option<String>,
 }
 
 #[derive(Args)]
@@ -258,7 +276,7 @@ fn main() -> Result<(), Error> {
             serve::serve()?
         }
         Commands::GitHistory => {
-            println!("Gathering histroy 📜");
+            println!("Gathering history 📜");
             let start = std::time::Instant::now();
             gather_history();
             println!("Took: {:?}", start.elapsed());
@@ -269,6 +287,16 @@ fn main() -> Result<(), Error> {
             update_popularities(20000);
             println!("Took: {:?}", start.elapsed());
         }
+        Commands::Content(content_subcommand) => match content_subcommand {
+            ContentSubcommand::Move(args) => {
+                r#move(
+                    &args.old_slug,
+                    &args.new_slug,
+                    args.locale.as_deref(),
+                    cli.assume_yes,
+                )?;
+            }
+        },
         Commands::Update(args) => update(args.version)?,
     }
     Ok(())

crates/rari-doc/src/error.rs

@@ -101,6 +101,16 @@ pub enum DocError {
     RariIoError(#[from] rari_utils::error::RariIoError),
     #[error("Slug required for SidebarEntry")]
     SlugRequiredForSidebarEntry,
+    #[error("Invalid Redirection: {0}")]
+    InvalidRedirectionEntry(String),
+    #[error("Error reading redirects file: {0}")]
+    ReadRedirectsError(String),
+    #[error("Error writing redirects file: {0}")]
+    WriteRedirectsError(String),
+    #[error("Invalid 'from' URL for redirect: {0}")]
+    InvalidRedirectFromURL(String),
+    #[error("Invalid 'to' URL for redirect: {0}")]
+    InvalidRedirectToURL(String),
 }
 
 impl<T> From<PoisonError<T>> for DocError {

crates/rari-doc/src/pages/page.rs

@@ -236,3 +236,7 @@ impl<T: PageLike> PageLike for Arc<T> {
 pub trait PageReader {
     fn read(path: impl Into<PathBuf>, locale: Option<Locale>) -> Result<Page, DocError>;
 }
+
+pub trait PageWriter {
+    fn write(&self) -> Result<(), DocError>;
+}

crates/rari-doc/src/pages/types/doc.rs

@@ -1,4 +1,6 @@
 use std::collections::HashMap;
+use std::fs;
+use std::io::Write;
 use std::path::{Path, PathBuf};
 use std::sync::Arc;
 
@@ -14,9 +16,11 @@ use validator::Validate;
 
 use crate::cached_readers::{doc_page_from_static_files, CACHED_DOC_PAGE_FILES};
 use crate::error::DocError;
-use crate::pages::page::{Page, PageCategory, PageLike, PageReader};
+use crate::pages::page::{Page, PageCategory, PageLike, PageReader, PageWriter};
 use crate::resolve::{build_url, url_to_path_buf};
-use crate::utils::{locale_and_typ_from_path, root_for_locale, split_fm, t_or_vec};
+use crate::utils::{
+    locale_and_typ_from_path, root_for_locale, serialize_t_or_vec, split_fm, t_or_vec,
+};
 
 /*
   "attribute-order": [
@@ -35,22 +39,45 @@ use crate::utils::{locale_and_typ_from_path, root_for_locale, split_fm, t_or_vec
 pub struct FrontMatter {
     #[validate(length(max = 120))]
     pub title: String,
-    #[serde(rename = "short-title")]
+    #[serde(rename = "short-title", skip_serializing_if = "Option::is_none")]
     #[validate(length(max = 60))]
     pub short_title: Option<String>,
-    #[serde(default)]
+    #[serde(default, skip_serializing_if = "Vec::is_empty")]
     pub tags: Vec<String>,
     pub slug: String,
     #[serde(rename = "page-type")]
     pub page_type: PageType,
-    #[serde(deserialize_with = "t_or_vec", default)]
+    #[serde(
+        deserialize_with = "t_or_vec",
+        serialize_with = "serialize_t_or_vec",
+        default,
+        skip_serializing_if = "Vec::is_empty"
+    )]
     pub status: Vec<FeatureStatus>,
-    #[serde(rename = "browser-compat", deserialize_with = "t_or_vec", default)]
+    #[serde(
+        rename = "browser-compat",
+        deserialize_with = "t_or_vec",
+        serialize_with = "serialize_t_or_vec",
+        default,
+        skip_serializing_if = "Vec::is_empty"
+    )]
     pub browser_compat: Vec<String>,
-    #[serde(rename = "spec-urls", deserialize_with = "t_or_vec", default)]
+    #[serde(
+        rename = "spec-urls",
+        deserialize_with = "t_or_vec",
+        serialize_with = "serialize_t_or_vec",
+        default,
+        skip_serializing_if = "Vec::is_empty"
+    )]
     pub spec_urls: Vec<String>,
+    #[serde(skip_serializing_if = "Option::is_none")]
     pub original_slug: Option<String>,
-    #[serde(deserialize_with = "t_or_vec", default)]
+    #[serde(
+        deserialize_with = "t_or_vec",
+        serialize_with = "serialize_t_or_vec",
+        default,
+        skip_serializing_if = "Vec::is_empty"
+    )]
     pub sidebar: Vec<String>,
     #[serde(flatten)]
     pub other: HashMap<String, Value>,
@@ -157,6 +184,12 @@ impl PageReader for Doc {
     }
 }
 
+impl PageWriter for Doc {
+    fn write(&self) -> Result<(), DocError> {
+        write_doc(&self)
+    }
+}
+
 impl PageLike for Doc {
     fn url(&self) -> &str {
         &self.meta.url
@@ -274,6 +307,49 @@ fn read_doc(path: impl Into<PathBuf>) -> Result<Doc, DocError> {
     })
 }
 
+fn write_doc(doc: &Doc) -> Result<(), DocError> {
+    let path = doc.path().to_path_buf();
+    let locale = doc.meta.locale;
+
+    let mut file_path = root_for_locale(locale)?.to_path_buf();
+    file_path.push(path);
+
+    let (fm, content_start) = split_fm(&doc.raw);
+    let fm = fm.ok_or(DocError::NoFrontmatter)?;
+    // Read original frontmatter to pass additional fields along,
+    // overwrite fields from meta
+    let mut frontmatter: FrontMatter = serde_yaml::from_str(fm)?;
+    frontmatter = FrontMatter {
+        title: doc.meta.title.clone(),
+        short_title: doc.meta.short_title.clone(),
+        tags: doc.meta.tags.clone(),
+        slug: doc.meta.slug.clone(),
+        page_type: doc.meta.page_type,
+        status: doc.meta.status.clone(),
+        browser_compat: doc.meta.browser_compat.clone(),
+        spec_urls: doc.meta.spec_urls.clone(),
+        original_slug: doc.meta.original_slug.clone(),
+        sidebar: doc.meta.sidebar.clone(),
+        ..frontmatter
+    };
+
+    let frontmatter_encoded = serde_yaml::to_string(&frontmatter)?;
+    let mut out = String::new();
+    out.push_str("---\n");
+    out.push_str(&frontmatter_encoded);
+    out.push_str("---\n");
+
+    out.push_str(&doc.raw[content_start..]);
+
+    if let Some(parent) = file_path.parent() {
+        std::fs::create_dir_all(parent)?;
+    }
+    let mut file = fs::File::create(&file_path)?;
+    file.write_all(out.as_bytes())?;
+
+    Ok(())
+}
+
 pub fn render_md_to_html(input: &str, locale: Locale) -> Result<String, DocError> {
     let html = m2h(input, locale)?;
     Ok(html)