allow customizing the template for migration files generated with the sqlx CLI

[svix-jbrown]

I have found these related issues/pull requests

Didn't find any

Description

Right now, the templates put into new migrations from the sqlx CLI are hardcoded in the MigrationType impl block. We would like to override them in our environment to have more context, but then we're at the point of dropping the sqlx CLI and just making the migrations with some other tool, which is unfortunate.

Prefered solution

sqlx.toml should have a section to override the templates for up, down, and simple migrations

Is this a breaking change? Why or why not?

No, if the section isn't in the TOML file it could just use the hardcoded templates

[abonander]

You're referring to the template for the file content correct?

sqlx/sqlx-core/src/migrate/migration_type.rs

Lines 69 to 75 in 1d15be8

	pub fn file_content(&self) -> &'static str {
	match self {
	MigrationType::Simple => "-- Add migration script here\n",
	MigrationType::ReversibleUp => "-- Add up migration script here\n",
	MigrationType::ReversibleDown => "-- Add down migration script here\n",
	}
	}

I think the simplest would be to allow a .template.sql or .template.up.sql/.template.down.sql in migrations/.

I could see maybe a way to override this with a key in sqlx.toml if you want to share a template across multiple sub-projects.

Maybe a --template argument to sqlx migrate add as well.

[svix-jbrown]

Yep, that's the one!

I would also be 100% cool with customizing via a file in the migrations dir.