Added create-migration command line instruction

This update adds a command line interface to create migrations directly with sqlpage, and have it manage the timestamps and uniqueness of migration names.

Author: andrewsinnovations

sqlpage/migrations/README.md

@@ -21,7 +21,13 @@ that is greater than the previous one.
 Use commands like `ALTER TABLE` to update the schema declaratively instead of modifying the existing `CREATE TABLE`
 statements.
 
-If you try to edit an existing migration, SQLPage will not run it again, will detect
+If you try to edit an existing migration, SQLPage will not run it again, it will detect that the migration has already executed. Also, if the migration is different than the one that was executed, SQLPage will throw an error as the database structure must match.
+
+## Creating migrations on the command line
+
+You can create a migration directly with sqlpage by running the command "sqlpage create-migration [migration_name]"
+
+For example if you run 'sqlpage create-migration "Example Migration 1"' on the command line, you will find a new file under "sqlpage/migrations" folder called "[timestamp]_example_migration_1.sql" where timestamp is the current time when you ran the command.
 
 ## Running migrations
 

src/app_config.rs

@@ -22,6 +22,20 @@ pub struct Cli {
     /// The path to the configuration file.
     #[clap(short = 'c', long)]
     pub config_file: Option<PathBuf>,
+
+    /// Subcommands for additional functionality.
+    #[clap(subcommand)]
+    pub command: Option<Commands>,
+}
+
+/// Enum for subcommands.
+#[derive(Parser)]
+pub enum Commands {
+    /// Create a new migration file.
+    CreateMigration {
+        /// Name of the migration.
+        migration_name: String,
+    },
 }
 
 #[cfg(not(feature = "lambda-web"))]
@@ -686,6 +700,7 @@ mod test {
             web_root: Some(PathBuf::from(".")),
             config_dir: None,
             config_file: None,
+            command: None,
         };
 
         let config = AppConfig::from_cli(&cli).unwrap();
@@ -726,6 +741,7 @@ mod test {
             web_root: None,
             config_dir: None,
             config_file: Some(config_file_path.clone()),
+            command: None,
         };
 
         let config = AppConfig::from_cli(&cli).unwrap();
@@ -744,6 +760,7 @@ mod test {
             web_root: Some(cli_web_dir.clone()),
             config_dir: None,
             config_file: Some(config_file_path),
+            command: None,
         };
 
         let config = AppConfig::from_cli(&cli_with_web_root).unwrap();
@@ -773,6 +790,7 @@ mod test {
             web_root: None,
             config_dir: None,
             config_file: None,
+            command: None,
         };
 
         let config = AppConfig::from_cli(&cli).unwrap();

src/main.rs

@@ -1,3 +1,4 @@
+use clap::Parser;
 use sqlpage::{
     app_config,
     webserver::{self, Database},
@@ -18,6 +19,18 @@ async fn start() -> anyhow::Result<()> {
     let db = Database::init(&app_config).await?;
     webserver::database::migrations::apply(&app_config, &db).await?;
     let state = AppState::init_with_db(&app_config, db).await?;
+
+    let cli = app_config::Cli::parse();
+
+    if let Some(command) = cli.command {
+        match command {
+            app_config::Commands::CreateMigration { migration_name } => {
+                create_migration_file(&migration_name)?;
+                return Ok(());
+            }
+        }
+    }
+
     log::debug!("Starting server...");
     webserver::http::run_server(&app_config, state).await?;
     log::info!("Server stopped gracefully. Goodbye!");
@@ -41,3 +54,34 @@ fn init_logging() {
         Err(e) => log::error!("Error loading .env file: {e}"),
     }
 }
+
+fn create_migration_file(migration_name: &str) -> anyhow::Result<()> {
+    use chrono::Utc;
+    use std::fs;
+    use std::path::Path;
+
+    let timestamp = Utc::now().format("%Y%m%d%H%M%S").to_string();
+    let snake_case_name = migration_name
+        .replace(|c: char| !c.is_alphanumeric(), "_")
+        .to_lowercase();
+    let file_name = format!("{}_{}.sql", timestamp, snake_case_name);
+    let migrations_dir = Path::new("sqlpage/migrations");
+
+    if !migrations_dir.exists() {
+        fs::create_dir_all(migrations_dir)?;
+    }
+
+    let mut unique_file_name = file_name.clone();
+    let mut counter = 1;
+
+    while migrations_dir.join(&unique_file_name).exists() {
+        unique_file_name = format!("{}_{}_{}.sql", timestamp, snake_case_name, counter);
+        counter += 1;
+    }
+
+    let file_path = migrations_dir.join(unique_file_name);
+    fs::write(file_path, "-- Write your migration here\n")?;
+
+    println!("Migration created successfully.");
+    Ok(())
+}