feat(config): allow configuring output file from config (#829)

orhun · web-flow · commit c2db791a6e28 · 2024-09-21T18:46:45.000+03:00
* feat(config): allow configuring output file from config

* test: add missing output to tests

* chore: move output to default config
diff --git a/config/cliff.toml b/config/cliff.toml
@@ -38,6 +38,8 @@ trim = true
 postprocessors = [
   # { pattern = '<REPO>', replace = "https://github.com/orhun/git-cliff" }, # replace repository URL
 ]
+# output file path
+# output = "test.md"
 
 [git]
 # parse the commits based on https://www.conventionalcommits.org
diff --git a/git-cliff-core/src/changelog.rs b/git-cliff-core/src/changelog.rs
@@ -670,6 +670,7 @@ mod test {
 					replace:         Some(String::from("exciting")),
 					replace_command: None,
 				}]),
+				output:         None,
 			},
 			git:       GitConfig {
 				conventional_commits:     Some(true),
diff --git a/git-cliff-core/src/config.rs b/git-cliff-core/src/config.rs
@@ -79,6 +79,8 @@ pub struct ChangelogConfig {
 	pub trim:           Option<bool>,
 	/// Changelog postprocessors.
 	pub postprocessors: Option<Vec<TextProcessor>>,
+	/// Output file path.
+	pub output:         Option<PathBuf>,
 }
 
 /// Git configuration
diff --git a/git-cliff-core/tests/integration_test.rs b/git-cliff-core/tests/integration_test.rs
@@ -41,6 +41,7 @@ fn generate_changelog() -> Result<()> {
 		footer:         Some(String::from("eoc - end of changelog")),
 		trim:           None,
 		postprocessors: None,
+		output:         None,
 	};
 	let git_config = GitConfig {
 		conventional_commits:     Some(true),
diff --git a/git-cliff/src/lib.rs b/git-cliff/src/lib.rs
@@ -424,6 +424,7 @@ pub fn run(mut args: Opt) -> Result<()> {
 	}
 
 	// Update the configuration based on command line arguments and vice versa.
+	let output = args.output.clone().or(config.changelog.output.clone());
 	match args.strip {
 		Some(Strip::Header) => {
 			config.changelog.header = None;
@@ -445,9 +446,9 @@ pub fn run(mut args: Opt) -> Result<()> {
 			)));
 		}
 	}
-	if args.output.is_some() &&
+	if output.is_some() &&
 		args.prepend.is_some() &&
-		args.output.as_ref() == args.prepend.as_ref()
+		output.as_ref() == args.prepend.as_ref()
 	{
 		return Err(Error::ArgumentError(String::from(
 			"'-o' and '-p' can only be used together if they point to different \
@@ -595,7 +596,7 @@ pub fn run(mut args: Opt) -> Result<()> {
 	};
 
 	// Print the result.
-	let mut out: Box<dyn io::Write> = if let Some(path) = &args.output {
+	let mut out: Box<dyn io::Write> = if let Some(path) = &output {
 		if path == Path::new("-") {
 			Box::new(io::stdout())
 		} else {
@@ -631,7 +632,7 @@ pub fn run(mut args: Opt) -> Result<()> {
 		let mut out = io::BufWriter::new(File::create(path)?);
 		changelog.prepend(changelog_before, &mut out)?;
 	}
-	if args.output.is_some() || args.prepend.is_none() {
+	if output.is_some() || args.prepend.is_none() {
 		changelog.generate(&mut out)?;
 	}
 
diff --git a/website/docs/configuration/changelog.md b/website/docs/configuration/changelog.md
@@ -55,3 +55,7 @@ It is useful for adding indentation to the template for readability, as shown [i
 An array of commit postprocessors for manipulating the changelog before outputting.
 Can e.g. be used for replacing commit author with GitHub usernames.
 Internally postprocessors and preprocessors are the same. See [commit_preprocessors](/docs/configuration/git#commit_preprocessors) for more detail and examples, it uses the same syntax.
+
+### output
+
+Output file path for the changelog. You can also use the `--output` argument to override this value.

Original file line number	Diff line number	Diff line change
`@@ -38,6 +38,8 @@ trim = true`
`38`	`38`	`postprocessors = [`
`39`	`39`	`# { pattern = '<REPO>', replace = "https://github.com/orhun/git-cliff" }, # replace repository URL`
`40`	`40`	`]`
	`41`	`+# output file path`
	`42`	`+# output = "test.md"`
`41`	`43`
`42`	`44`	`[git]`
`43`	`45`	`# parse the commits based on https://www.conventionalcommits.org`
Original file line number	Diff line number	Diff line change
`@@ -79,6 +79,8 @@ pub struct ChangelogConfig {`
`79`	`79`	`pub trim: Option<bool>,`
`80`	`80`	`/// Changelog postprocessors.`
`81`	`81`	`pub postprocessors: Option<Vec<TextProcessor>>,`
	`82`	`+ /// Output file path.`
	`83`	`+ pub output: Option<PathBuf>,`
`82`	`84`	`}`
`83`	`85`
`84`	`86`	`/// Git configuration`
Original file line number	Diff line number	Diff line change
`@@ -424,6 +424,7 @@ pub fn run(mut args: Opt) -> Result<()> {`
`424`	`424`	`}`
`425`	`425`
`426`	`426`	`// Update the configuration based on command line arguments and vice versa.`
	`427`	`+ let output = args.output.clone().or(config.changelog.output.clone());`
`427`	`428`	`match args.strip {`
`428`	`429`	`Some(Strip::Header) => {`
`429`	`430`	`config.changelog.header = None;`
`@@ -445,9 +446,9 @@ pub fn run(mut args: Opt) -> Result<()> {`
`445`	`446`	`)));`
`446`	`447`	`}`
`447`	`448`	`}`
`448`		`- if args.output.is_some() &&`
	`449`	`+ if output.is_some() &&`
`449`	`450`	`args.prepend.is_some() &&`
`450`		`- args.output.as_ref() == args.prepend.as_ref()`
	`451`	`+ output.as_ref() == args.prepend.as_ref()`
`451`	`452`	`{`
`452`	`453`	`return Err(Error::ArgumentError(String::from(`
`453`	`454`	`"'-o' and '-p' can only be used together if they point to different \`
`@@ -595,7 +596,7 @@ pub fn run(mut args: Opt) -> Result<()> {`
`595`	`596`	`};`
`596`	`597`
`597`	`598`	`// Print the result.`
`598`		`- let mut out: Box<dyn io::Write> = if let Some(path) = &args.output {`
	`599`	`+ let mut out: Box<dyn io::Write> = if let Some(path) = &output {`
`599`	`600`	`if path == Path::new("-") {`
`600`	`601`	`Box::new(io::stdout())`
`601`	`602`	`} else {`
`@@ -631,7 +632,7 @@ pub fn run(mut args: Opt) -> Result<()> {`
`631`	`632`	`let mut out = io::BufWriter::new(File::create(path)?);`
`632`	`633`	`changelog.prepend(changelog_before, &mut out)?;`
`633`	`634`	`}`
`634`		`- if args.output.is_some() \|\| args.prepend.is_none() {`
	`635`	`+ if output.is_some() \|\| args.prepend.is_none() {`
`635`	`636`	`changelog.generate(&mut out)?;`
`636`	`637`	`}`
`637`	`638`