feat: support context json schema dump

git-cliff-core/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "git-cliff-core"
-version = "2.10.1" # managed by release.sh
+version = "2.10.1"                                              # managed by release.sh
 description = "Core library of git-cliff"
 authors = ["git-cliff contributors <[email protected]>"]
 license = "MIT OR Apache-2.0"
@@ -75,6 +75,7 @@ urlencoding = "2.1.3"
 cacache = { version = "=13.0.0", features = ["mmap"], default-features = false }
 time = "0.3.37"
 chrono = { version = "0.4.41", features = ["serde"] }
+schemars = "1.0.4"
 
 [dependencies.git2]
 version = "0.20.2"
@@ -87,8 +88,9 @@ default-features = false
 features = ["toml", "yaml"]
 
 [dependencies.git-conventional]
-version = "0.12.7"
-features = ["serde"]
+# version = "0.12.7"
+git = "https://github.com/greenhat616/git-conventional"
+features = ["serde", "schemars"]
 
 [dependencies.rust-embed]
 version = "8.7.2"

git-cliff-core/src/changelog.rs

@@ -2,6 +2,8 @@ use std::collections::HashMap;
 use std::io::{Read, Write};
 use std::time::{SystemTime, UNIX_EPOCH};
 
+use schemars::JsonSchema;
+
 use crate::commit::Commit;
 use crate::config::{Config, GitConfig};
 use crate::error::{Error, Result};
@@ -612,6 +614,18 @@ impl<'a> Changelog<'a> {
         writeln!(out, "{output}")?;
         Ok(())
     }
+
+    /// Returns the context json schema for the releases.
+    pub fn context_schema() -> Result<String> {
+        use schemars::schema_for;
+        #[derive(JsonSchema)]
+        #[repr(transparent)]
+        /// Context for the changelog.
+        struct Context<'a>(Vec<Release<'a>>);
+        let schema = schema_for!(Context);
+        let schema_json = serde_json::to_string_pretty(&schema)?;
+        Ok(schema_json)
+    }
 }
 
 fn get_body_template(config: &Config, trim: bool) -> Result<Template> {

git-cliff-core/src/command.rs

@@ -54,8 +54,6 @@ pub fn run(command: &str, input: Option<String>, envs: Vec<(&str, &str)>) -> Res
 
 #[cfg(test)]
 mod test {
-    use super::*;
-
     #[test]
     #[cfg(target_family = "unix")]
     fn run_os_command() -> Result<()> {

git-cliff-core/src/commit.rs

@@ -2,6 +2,7 @@ use git_conventional::{Commit as ConventionalCommit, Footer as ConventionalFoote
 #[cfg(feature = "repo")]
 use git2::{Commit as GitCommit, Signature as CommitSignature};
 use lazy_regex::{Lazy, Regex, lazy_regex};
+use schemars::JsonSchema;
 use serde::ser::{SerializeStruct, Serializer};
 use serde::{Deserialize, Deserializer, Serialize};
 use serde_json::value::Value;
@@ -14,7 +15,7 @@ use crate::error::{Error as AppError, Result};
 static SHA1_REGEX: Lazy<Regex> = lazy_regex!(r#"^\b([a-f0-9]{40})\b (.*)$"#);
 
 /// Object representing a link
-#[derive(Debug, Clone, Eq, PartialEq, Deserialize, Serialize)]
+#[derive(Debug, Clone, Eq, PartialEq, Deserialize, Serialize, JsonSchema)]
 #[serde(rename_all(serialize = "camelCase"))]
 pub struct Link {
     /// Text of the link.
@@ -24,7 +25,7 @@ pub struct Link {
 }
 
 /// A conventional commit footer.
-#[derive(Debug, Clone, Eq, PartialEq, Deserialize, Serialize)]
+#[derive(Debug, Clone, Eq, PartialEq, Deserialize, Serialize, JsonSchema)]
 struct Footer<'a> {
     /// Token of the footer.
     ///
@@ -53,7 +54,7 @@ impl<'a> From<&'a ConventionalFooter<'a>> for Footer<'a> {
 }
 
 /// Commit signature that indicates authorship.
-#[derive(Debug, Default, Clone, Eq, PartialEq, Deserialize, Serialize)]
+#[derive(Debug, Default, Clone, Eq, PartialEq, Deserialize, Serialize, JsonSchema)]
 pub struct Signature {
     /// Name on the signature.
     pub name: Option<String>,
@@ -75,7 +76,7 @@ impl<'a> From<CommitSignature<'a>> for Signature {
 }
 
 /// Commit range (from..to)
-#[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize)]
+#[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize, JsonSchema)]
 pub struct Range {
     /// Full commit SHA the range starts at
     from: String,
@@ -94,7 +95,7 @@ impl Range {
 }
 
 /// Common commit object that is parsed from a repository.
-#[derive(Debug, Default, Clone, PartialEq, Deserialize)]
+#[derive(Debug, Default, Clone, PartialEq, Deserialize, JsonSchema)]
 #[serde(rename_all(serialize = "camelCase"))]
 pub struct Commit<'a> {
     /// Commit ID.

git-cliff-core/src/contributor.rs

@@ -1,9 +1,10 @@
 use std::hash::{Hash, Hasher};
 
+use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
 
 /// Representation of a remote contributor.
-#[derive(Debug, Default, Clone, Eq, PartialEq, Deserialize, Serialize)]
+#[derive(Debug, Default, Clone, Eq, PartialEq, Deserialize, Serialize, JsonSchema)]
 pub struct RemoteContributor {
     /// Username.
     pub username: Option<String>,

git-cliff-core/src/release.rs

@@ -1,6 +1,7 @@
 use std::collections::HashMap;
 
 use next_version::{NextVersion, VersionUpdater};
+use schemars::JsonSchema;
 use semver::Version;
 use serde::{Deserialize, Serialize};
 use serde_json::value::Value;
@@ -16,7 +17,7 @@ use crate::{
 };
 
 /// Representation of a release.
-#[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize)]
+#[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize, JsonSchema)]
 #[serde(rename_all(serialize = "camelCase"))]
 pub struct Release<'a> {
     /// Release version, git tag.

git-cliff-core/src/remote/mod.rs

@@ -24,6 +24,7 @@ use http_cache_reqwest::{CACacheManager, Cache, CacheMode, HttpCache, HttpCacheO
 use reqwest::Client;
 use reqwest::header::{HeaderMap, HeaderValue};
 use reqwest_middleware::{ClientBuilder, ClientWithMiddleware};
+use schemars::JsonSchema;
 use secrecy::ExposeSecret;
 use serde::de::DeserializeOwned;
 use serde::{Deserialize, Serialize};
@@ -100,7 +101,7 @@ dyn_clone::clone_trait_object!(RemotePullRequest);
 pub type RemoteMetadata = (Vec<Box<dyn RemoteCommit>>, Vec<Box<dyn RemotePullRequest>>);
 
 /// Metadata of a remote release.
-#[derive(Debug, Default, Clone, Eq, PartialEq, Deserialize, Serialize)]
+#[derive(Debug, Default, Clone, Eq, PartialEq, Deserialize, Serialize, JsonSchema)]
 pub struct RemoteReleaseMetadata {
     /// Contributors.
     pub contributors: Vec<RemoteContributor>,

git-cliff-core/src/statistics.rs

@@ -1,13 +1,14 @@
 use std::collections::HashMap;
 
 use chrono::{TimeZone, Utc};
+use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
 
 use crate::release::Release;
 
 /// Aggregated information about how many times a specific link appeared in
 /// commit messages.
-#[derive(Debug, Clone, Eq, PartialEq, Deserialize, Serialize)]
+#[derive(Debug, Clone, Eq, PartialEq, Deserialize, Serialize, JsonSchema)]
 #[serde(rename_all = "camelCase")]
 pub struct LinkCount {
     /// Text of the link.
@@ -19,7 +20,7 @@ pub struct LinkCount {
 }
 
 /// Aggregated statistics about commits in the release.
-#[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize)]
+#[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize, JsonSchema)]
 pub struct Statistics {
     /// The total number of commits included in the release.
     pub commit_count: usize,

git-cliff/src/args.rs

@@ -232,6 +232,14 @@ pub struct Opt {
     /// Disables the external command execution.
     #[arg(long, help_heading = Some("FLAGS"))]
     pub no_exec: bool,
+    #[arg(long,
+        global = true,
+        value_name = "PATH",
+        value_parser = Opt::parse_dir,
+        help = "Dump the context schema to a file"
+    )]
+    /// Dumps the context schema to a file.
+    pub dump_context_schema: Option<PathBuf>,
     /// Prints changelog context as JSON.
     #[arg(short = 'x', long, help_heading = Some("FLAGS"))]
     pub context: bool,

git-cliff/src/lib.rs

@@ -797,3 +797,9 @@ pub fn run_with_changelog_modifier(
 
     Ok(())
 }
+
+pub fn dump_context_schema(path: &Path) -> Result<()> {
+    let schema_json = Changelog::context_schema()?;
+    fs::write(path, schema_json)?;
+    Ok(())
+}

git-cliff/src/main.rs

@@ -32,6 +32,11 @@ fn main() -> Result<()> {
         _profiler_guard = Some(());
     }
 
+    if let Some(path) = args.dump_context_schema {
+        git_cliff::dump_context_schema(&path)?;
+        return Ok(());
+    }
+
     // Run git-cliff
     let exit_code = match git_cliff::run(args) {
         Ok(()) => 0,