ttys3/git-cz - Change M3X5J5GHHZXBPTFXDCHWQKQPWUVRUH6RJNGVWIA44B57J4T3O75AC

refactor(changelog): Refactor changelog command for better readability and performance Add `config` submodule to `changelog`. Improve performance by reusing handlebars registry in `ContextBuilder` and `ChangelogWriter`.

Created by Hannes De Valkeneer on February 15, 2020

M3X5J5GHHZXBPTFXDCHWQKQPWUVRUH6RJNGVWIA44B57J4T3O75AC

Dependencies

In channels

main

Change contents

Replacement in src/cmd/changelog.rs at line 6 [5.36278]

B:BD[3.21] → [3.21:151]

            ChangelogWriter, CommitContext, CommitGroup, Config, Context, ContextBuilder, Note,
            NoteGroup, Reference,

[3.21]

[3.151]

            ChangelogWriter, CommitContext, CommitGroup, Config, Context, ContextBase,
            ContextBuilder, Note, NoteGroup, Reference,

Insertion in src/cmd/changelog.rs at line 19 [5.36278]
[6.1770]
[5.36576]
```
use url::Url;
```
Insertion in src/cmd/changelog.rs at line 36 [5.36278]
[7.292]
[7.292]
```
    context_builder: ContextBuilder<'a>,
```

Replacement in src/cmd/changelog.rs at line 44 [5.36278]

B:BD[7.331] → [7.331:392]

    fn new(config: &'a Config, git: &'a GitHelper) -> Self {

[7.331]

[5.37093]

    fn new(config: &'a Config, git: &'a GitHelper) -> Result<Self, Error> {

Replacement in src/cmd/changelog.rs at line 56 [5.36278]
∅:D[8.341] → [7.393:408]
B:BD[5.37397] → [7.393:408]
```
        Self {
```
[8.341]
[7.408]
```
        let context_builder = ContextBuilder::new(config)?;
        Ok(Self {
```
Replacement in src/cmd/changelog.rs at line 62 [5.36278]
∅:D[8.369] → [7.470:480]
B:BD[7.470] → [7.470:480]
```
        }
```
[8.369]
[7.480]
```
            context_builder,
        })
```

Replacement in src/cmd/changelog.rs at line 181 [5.36278]

B:BD[6.2015] → [4.2537:2607]

∅:D[4.2607] → [5.39175:39237]

∅:D[7.908] → [5.39175:39237]

B:BD[5.39175] → [5.39175:39237]

B:BD[5.39237] → [9.1418:1491]

B:BD[9.1491] → [6.2016:2058]

∅:D[6.2058] → [9.1506:1689]

B:BD[9.1506] → [9.1506:1689]

∅:D[9.1689] → [5.39430:39445]

B:BD[5.39430] → [5.39430:39445]

B:BD[5.39445] → [2.757:803]

∅:D[2.803] → [5.39541:39542]

B:BD[5.39541] → [5.39541:39542]

B:BD[5.39542] → [7.909:938]

        let mut builder = ContextBuilder::new(self.config, self.git)?
            .version(version)
            .is_patch(is_patch)
            .previous_tag(to_rev.0)
            .current_tag(from_rev.0)
            .commit_groups(commit_groups)
            .note_groups(
                notes
                    .into_iter()
                    .map(|(title, notes)| NoteGroup { title, notes })
                    .collect(),
            );
        builder = builder.date(version_date);
        Ok(builder.build()?)

[6.2015]

[5.39639]

        let note_groups: Vec<NoteGroup> = notes
            .into_iter()
            .map(|(title, notes)| NoteGroup { title, notes })
            .collect();
        let Config {
            host,
            owner,
            repository,
            ..
        } = self.config;
        let context_base = ContextBase {
            version,
            date: Some(version_date),
            is_patch,
            commit_groups,
            note_groups,
            previous_tag: to_rev.0,
            current_tag: from_rev.0,
            host: host.to_owned(),
            owner: owner.to_owned(),
            repository: repository.to_owned(),
        };
        self.context_builder.build(context_base)

Replacement in src/cmd/changelog.rs at line 223 [5.36278]

B:BD[5.39648] → [5.39648:39680]

B:BD[5.39680] → [9.1690:1722]

fn make_cl_config() -> Config {
    std::fs::read(".versionrc")

[5.39648]

[9.1722]

fn make_cl_config(git: &GitHelper) -> Config {
    let mut config: Config = std::fs::read(".versionrc")

Replacement in src/cmd/changelog.rs at line 227 [5.36278]

B:BD[9.1818] → [9.1818:1847]

        .unwrap_or_default()

[9.1818]

[5.39702]

        .unwrap_or_default();
    if let Config {
        host: None,
        owner: None,
        repository: None,
        ..
    } = config
    {
        if let Ok((host, owner, repository)) = host_info(git) {
            config.host = host;
            config.owner = owner;
            config.repository = repository;
        }
    }
    config
}
type HostOwnerRepo = (Option<String>, Option<String>, Option<String>);
/// Get host, owner and repository based on the git remote origin url.
pub(crate) fn host_info(git: &GitHelper) -> Result<HostOwnerRepo, Error> {
    if let Some(mut url) = git.url()? {
        if !url.contains("://") {
            // check if it contains a port
            if let Some(colon) = url.find(':') {
                match url.as_bytes()[colon + 1] {
                    b'0'..=b'9' => url = format!("scheme://{}", url),
                    _ => url = format!("scheme://{}/{}", &url[..colon], &url[colon + 1..]),
                }
            }
        }
        let url = Url::parse(url.as_str())?;
        let host = url.host().map(|h| format!("https://{}", h));
        let mut owner = None;
        let mut repository = None;
        if let Some(mut segments) = url.path_segments() {
            owner = segments.next().map(|s| s.to_string());
            repository = segments
                .next()
                .map(|s: &str| s.trim_end_matches(".git").to_string());
        }
        Ok((host, owner, repository))
    } else {
        Ok((None, None, None))
    }

Replacement in src/cmd/changelog.rs at line 293 [5.36278]
B:BD[5.39881] → [5.39881:39920]
```
        let config = make_cl_config();
```
[5.39881]
[5.39920]
```
        let config = make_cl_config(&helper);
```

Replacement in src/cmd/changelog.rs at line 296 [5.36278]

B:BD[5.39996] → [5.39996:40057]

        let mut writer = ChangelogWriter { writer: stdout };

[5.39996]

[5.40057]

        let mut writer = ChangelogWriter::new(stdout)?;

Replacement in src/cmd/changelog.rs at line 299 [5.36278]

B:BD[5.40112] → [7.939:1010]

        let transformer = ChangeLogTransformer::new(&config, &helper);

[5.40112]

[7.1010]

        let transformer = ChangeLogTransformer::new(&config, &helper)?;

File addition: config.rs (-rw-r--r--)

[5.18465]

use serde::{Deserialize, Serialize};
#[derive(Debug, PartialEq, Serialize, Deserialize)]
pub(crate) struct Type {
    pub(crate) r#type: String,
    #[serde(default)]
    pub(crate) section: String,
    #[serde(default)]
    pub(crate) hidden: bool,
}
/// see: [Conventional Changelog Configuration](https://github.com/conventional-changelog/conventional-changelog-config-spec/blob/master/versions/2.1.0/README.md)
/// Additional config: `host`, `owner`, `repository`.
/// Those values are derived from `git remote origin get-url` if not set.
#[derive(Debug, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub(crate) struct Config {
    /// A string to be used as the main header section of the CHANGELOG.
    #[serde(default = "default_header")]
    pub(crate) header: String,
    /// An array of `type` objects representing the explicitly supported commit message types, and whether they should show up in generated `CHANGELOG`s.
    #[serde(default = "default_types")]
    pub(crate) types: Vec<Type>,
    /// Boolean indicating whether or not the action being run (generating CHANGELOG, recommendedBump, etc.) is being performed for a pre-major release (<1.0.0).\n This config setting will generally be set by tooling and not a user.
    #[serde(default)]
    pre_major: bool,
    /// A URL representing a specific commit at a hash.
    #[serde(default = "default_commit_url_format")]
    pub(crate) commit_url_format: String,
    /// A URL representing the comparison between two git SHAs.
    #[serde(default = "default_compare_url_format")]
    pub(crate) compare_url_format: String,
    /// A URL representing the issue format (allowing a different URL format to be swapped in for Gitlab, Bitbucket, etc).
    #[serde(default = "default_issue_url_format")]
    pub(crate) issue_url_format: String,
    /// A URL representing the a user's profile URL on GitHub, Gitlab, etc. This URL is used for substituting @bcoe with https://github.com/bcoe in commit messages.
    #[serde(default = "default_user_url_format")]
    pub(crate) user_url_format: String,
    /// A string to be used to format the auto-generated release commit message.
    #[serde(default = "default_release_commit_message_format")]
    pub(crate) release_commit_message_format: String,
    /// An array of prefixes used to detect references to issues
    #[serde(default = "default_issue_prefixes")]
    pub(crate) issue_prefixes: Vec<String>,
    pub(crate) host: Option<String>,
    pub(crate) owner: Option<String>,
    pub(crate) repository: Option<String>,
}
impl Default for Config {
    fn default() -> Self {
        Self {
            header: default_header(),
            types: default_types(),
            pre_major: false,
            commit_url_format: default_commit_url_format(),
            compare_url_format: default_compare_url_format(),
            issue_url_format: default_issue_url_format(),
            user_url_format: default_user_url_format(),
            release_commit_message_format: default_release_commit_message_format(),
            issue_prefixes: default_issue_prefixes(),
            host: None,
            owner: None,
            repository: None,
        }
    }
}
fn default_header() -> String {
    "# Changelog\n\n".into()
}
fn default_types() -> Vec<Type> {
    vec![
        Type {
            r#type: "feat".into(),
            section: "Features".into(),
            hidden: false,
        },
        Type {
            r#type: "fix".into(),
            section: "Fixes".into(),
            hidden: false,
        },
    ]
}
fn default_commit_url_format() -> String {
    "{{host}}/{{owner}}/{{repository}}/commit/{{hash}}".into()
}
fn default_compare_url_format() -> String {
    "{{host}}/{{owner}}/{{repository}}/compare/{{previousTag}}...{{currentTag}}".into()
}
fn default_issue_url_format() -> String {
    "{{host}}/{{owner}}/{{repository}}/issues/{{id}}".into()
}
fn default_user_url_format() -> String {
    "{{host}}/{{user}}".into()
}
fn default_release_commit_message_format() -> String {
    "chore(release): {{currentTag}}".into()
}
fn default_issue_prefixes() -> Vec<String> {
    vec!["#".into()]
}
#[cfg(test)]
mod tests {
    use super::*;
    use serde_yaml;
    #[test]
    fn test() {
        let json = r#"{
              "types": [
                {"type": "chore", "section":"Others", "hidden": false},
                {"type": "revert", "section":"Reverts", "hidden": false},
                {"type": "feat", "section": "Features", "hidden": false},
                {"type": "fix", "section": "Bug Fixes", "hidden": false},
                {"type": "improvement", "section": "Feature Improvements", "hidden": false},
                {"type": "docs", "section":"Docs", "hidden": false},
                {"type": "style", "section":"Styling", "hidden": false},
                {"type": "refactor", "section":"Code Refactoring", "hidden": false},
                {"type": "perf", "section":"Performance Improvements", "hidden": false},
                {"type": "test", "section":"Tests", "hidden": false},
                {"type": "build", "section":"Build System", "hidden": false},
                {"type": "ci", "section":"CI", "hidden":false}
              ]
            }"#;
        let value: Config = serde_yaml::from_str(json).unwrap();
        assert_eq!(
            value,
            Config {
                header: "# Changelog\n\n".to_string(),
                types: vec![
                    Type {
                        r#type: "chore".into(),
                        section: "Others".into(),
                        hidden: false
                    },
                    Type {
                        r#type: "revert".into(),
                        section: "Reverts".into(),
                        hidden: false
                    },
                    Type {
                        r#type: "feat".into(),
                        section: "Features".into(),
                        hidden: false
                    },
                    Type {
                        r#type: "fix".into(),
                        section: "Bug Fixes".into(),
                        hidden: false
                    },
                    Type {
                        r#type: "improvement".into(),
                        section: "Feature Improvements".into(),
                        hidden: false
                    },
                    Type {
                        r#type: "docs".into(),
                        section: "Docs".into(),
                        hidden: false
                    },
                    Type {
                        r#type: "style".into(),
                        section: "Styling".into(),
                        hidden: false
                    },
                    Type {
                        r#type: "refactor".into(),
                        section: "Code Refactoring".into(),
                        hidden: false
                    },
                    Type {
                        r#type: "perf".into(),
                        section: "Performance Improvements".into(),
                        hidden: false
                    },
                    Type {
                        r#type: "test".into(),
                        section: "Tests".into(),
                        hidden: false
                    },
                    Type {
                        r#type: "build".into(),
                        section: "Build System".into(),
                        hidden: false
                    },
                    Type {
                        r#type: "ci".into(),
                        section: "CI".into(),
                        hidden: false
                    }
                ],
                pre_major: false,
                commit_url_format: "{{host}}/{{owner}}/{{repository}}/commit/{{hash}}".to_string(),
                compare_url_format:
                    "{{host}}/{{owner}}/{{repository}}/compare/{{previousTag}}...{{currentTag}}"
                        .to_string(),
                issue_url_format: "{{host}}/{{owner}}/{{repository}}/issues/{{id}}".to_string(),
                user_url_format: "{{host}}/{{user}}".to_string(),
                release_commit_message_format: "chore(release): {{currentTag}}".to_string(),
                issue_prefixes: vec!["#".into()],
                host: None,
                owner: None,
                repository: None,
            }
        )
    }
}

Replacement in src/conventional/changelog.rs at line 1 [5.18829]
B:BD[5.18829] → [4.2608:2644]
```
use crate::{git::GitHelper, Error};
```
[5.18829]
[5.18848]
```
mod config;
use crate::Error;
```
Insertion in src/conventional/changelog.rs at line 4 [5.18829]
[5.18871]
[10.2038]
```
pub(crate) use config::Config;
```
Replacement in src/conventional/changelog.rs at line 6 [5.18829]
∅:D[10.2079] → [5.18899:18936]
∅:D[6.2754] → [5.18899:18936]
B:BD[5.18899] → [5.18899:18936]
```
use serde::{Deserialize, Serialize};
```
[10.2079]
[5.18936]
```
use serde::Serialize;
```

Deletion in src/conventional/changelog.rs at line 8 [5.18829]

B:BD[5.18949] → [4.2645:2659]

∅:D[4.2659] → [5.18949:21003]

B:BD[5.18949] → [5.18949:21003]

B:BD[5.21003] → [8.1662:1706]

∅:D[8.1706] → [5.21036:21727]

B:BD[5.21036] → [5.21036:21727]

B:BD[5.21727] → [6.2755:2830]

∅:D[6.2830] → [5.21798:21851]

B:BD[5.21798] → [5.21798:21851]

B:BD[5.21851] → [6.2831:2902]

∅:D[6.2902] → [5.21926:22677]

B:BD[5.21926] → [5.21926:22677]

B:BD[5.22677] → [9.3812:3834]

∅:D[9.3834] → [5.22677:22709]

B:BD[5.22677] → [5.22677:22709]

B:BD[5.22709] → [9.3835:3857]

∅:D[9.3857] → [5.22709:22740]

B:BD[5.22709] → [5.22709:22740]

use url::Url;
/// [Conventional Changelog Configuration](https://github.com/conventional-changelog/conventional-changelog-config-spec/blob/master/versions/2.1.0/README.md)
/// Describes the configuration options supported by conventional-config for upstream tooling.
#[derive(Debug, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub(crate) struct Config {
    /// A string to be used as the main header section of the CHANGELOG.
    #[serde(default = "default_header")]
    pub(crate) header: String,
    /// An array of `type` objects representing the explicitly supported commit message types, and whether they should show up in generated `CHANGELOG`s.
    #[serde(default = "default_types")]
    pub(crate) types: Vec<Type>,
    /// Boolean indicating whether or not the action being run (generating CHANGELOG, recommendedBump, etc.) is being performed for a pre-major release (<1.0.0).\n This config setting will generally be set by tooling and not a user.
    #[serde(default)]
    pre_major: bool,
    /// A URL representing a specific commit at a hash.
    #[serde(default = "default_commit_url_format")]
    commit_url_format: String,
    /// A URL representing the comparison between two git SHAs.
    #[serde(default = "default_compare_url_format")]
    compare_url_format: String,
    /// A URL representing the issue format (allowing a different URL format to be swapped in for Gitlab, Bitbucket, etc).
    #[serde(default = "default_issue_url_format")]
    issue_url_format: String,
    /// A URL representing the a user's profile URL on GitHub, Gitlab, etc. This URL is used for substituting @bcoe with https://github.com/bcoe in commit messages.
    #[serde(default = "default_user_url_format")]
    user_url_format: String,
    /// A string to be used to format the auto-generated release commit message.
    #[serde(default = "default_release_commit_message_format")]
    release_commit_message_format: String,
    /// An array of prefixes used to detect references to issues
    #[serde(default = "default_issue_prefixes")]
    pub(crate) issue_prefixes: Vec<String>,
}
impl Default for Config {
    fn default() -> Self {
        Self {
            header: default_header(),
            types: default_types(),
            pre_major: false,
            commit_url_format: default_commit_url_format(),
            compare_url_format: default_compare_url_format(),
            issue_url_format: default_issue_url_format(),
            user_url_format: default_user_url_format(),
            release_commit_message_format: default_release_commit_message_format(),
            issue_prefixes: default_issue_prefixes(),
        }
    }
}
fn default_header() -> String {
    "# Changelog\n\n".into()
}
fn default_types() -> Vec<Type> {
    vec![
        Type {
            r#type: "feat".into(),
            section: "Features".into(),
            hidden: false,
        },
        Type {
            r#type: "fix".into(),
            section: "Fixes".into(),
            hidden: false,
        },
    ]
}
fn default_commit_url_format() -> String {
    "{{host}}/{{owner}}/{{repository}}/commit/{{hash}}".into()
}
fn default_compare_url_format() -> String {
    "{{host}}/{{owner}}/{{repository}}/compare/{{previousTag}}...{{currentTag}}".into()
}
fn default_issue_url_format() -> String {
    "{{host}}/{{owner}}/{{repository}}/issues/{{id}}".into()
}
fn default_user_url_format() -> String {
    "{{host}}/{{user}}".into()
}
fn default_release_commit_message_format() -> String {
    "chore(release): {{currentTag}}".into()
}
fn default_issue_prefixes() -> Vec<String> {
    vec!["#".into()]
}
#[derive(Debug, PartialEq, Serialize, Deserialize)]
pub(crate) struct Type {
    pub(crate) r#type: String,
    #[serde(default)]
    pub(crate) section: String,
    #[serde(default)]
    pub(crate) hidden: bool,
}

Deletion in src/conventional/changelog.rs at line 84 [5.18829]
∅:D[4.2811] → [5.24049:24090]
B:BD[5.24049] → [5.24049:24090]
```
    pub(crate) context: ContextBase<'a>,
```

Replacement in src/conventional/changelog.rs at line 87 [5.18829]

B:BD[5.24123] → [4.2812:2906]

    pub fn new(config: &'a Config, git: &'a GitHelper) -> Result<ContextBuilder<'a>, Error> {

[5.24123]

[5.24197]

    pub fn new(config: &'a Config) -> Result<ContextBuilder<'a>, Error> {

Replacement in src/conventional/changelog.rs at line 100 [5.18829]

B:BD[9.5010] → [4.2907:2971]

∅:D[9.5010] → [5.24362:24380]

∅:D[4.2971] → [5.24362:24380]

B:BD[5.24362] → [5.24362:24380]

B:BD[5.24400] → [5.24400:24643]

B:BD[5.24643] → [9.5011:5127]

B:BD[9.5127] → [4.2972:3045]

∅:D[9.5127] → [5.24643:24676]

∅:D[4.3045] → [5.24643:24676]

B:BD[5.24643] → [5.24643:24676]

B:BD[5.24676] → [4.3046:4212]

∅:D[4.4212] → [5.24676:25158]

B:BD[5.24676] → [5.24676:25158]

B:BD[5.25158] → [9.5128:5405]

∅:D[9.5405] → [5.25158:25171]

B:BD[5.25158] → [5.25158:25171]

        let (host, owner, repository) = Self::host_info(git)?;
        Ok(Self {
            handlebars,
            context: ContextBase {
                version: Default::default(),
                date: Default::default(),
                is_patch: Default::default(),
                commit_groups: Default::default(),
                note_groups: Default::default(),
                previous_tag: "",
                current_tag: "",
                host,
                owner,
                repository,
            },
        })
    }
    fn host_info(
        git: &'a GitHelper,
    ) -> Result<(Option<String>, Option<String>, Option<String>), Error> {
        if let Some(mut url) = git.url()? {
            if !url.contains("://") {
                // check if it contains a port
                if let Some(colon) = url.find(":") {
                    match url.as_bytes()[colon + 1] {
                        b'0'..=b'9' => url = format!("scheme://{}", url),
                        _ => url = format!("scheme://{}/{}", &url[..colon], &url[colon + 1..]),
                    }
                }
            }
            let url = Url::parse(url.as_str())?;
            let host = url.host().map(|h| format!("https://{}", h));
            let mut owner = None;
            let mut repository = None;
            if let Some(mut segments) = url.path_segments() {
                owner = segments.next().map(|s| s.to_string());
                repository = segments
                    .next()
                    .map(|s: &str| s.trim_end_matches(".git").to_string());
            }
            Ok((host, owner, repository))
        } else {
            Ok((None, None, None))
        }
    }
    pub fn version(mut self, version: &'a str) -> Self {
        self.context.version = version;
        self
    }
    pub fn date(mut self, date: NaiveDate) -> Self {
        self.context.date = Some(date);
        self
    }
    pub fn is_patch(mut self, is_patch: bool) -> Self {
        self.context.is_patch = is_patch;
        self
    }
    pub fn commit_groups(mut self, commit_groups: Vec<CommitGroup<'a>>) -> Self {
        self.context.commit_groups = commit_groups;
        self
    }
    pub fn note_groups(mut self, note_groups: Vec<NoteGroup>) -> Self {
        self.context.note_groups = note_groups;
        self
    }
    pub fn previous_tag(mut self, previous_tag: &'a str) -> Self {
        self.context.previous_tag = previous_tag;
        self

[9.5010]

[5.25171]

        Ok(Self { handlebars })

Replacement in src/conventional/changelog.rs at line 103 [5.18829]

B:BD[5.25178] → [9.5406:5539]

∅:D[9.5539] → [5.25178:25233]

B:BD[5.25178] → [5.25178:25233]

    pub fn current_tag(mut self, current_tag: &'a str) -> Self {
        self.context.current_tag = current_tag;
        self
    }
    pub fn build(self) -> Result<Context<'a>, Error> {

[5.25178]

[5.25233]

    pub fn build(&self, context_base: ContextBase<'a>) -> Result<Context<'a>, Error> {

Replacement in src/conventional/changelog.rs at line 106 [5.18829]

B:BD[5.25295] → [5.25295:25354]

B:BD[5.25354] → [9.5540:5724]

            .render("compare_url_format", &self.context)?;
        let commit_url_format = self.handlebars.render("commit_url_format", &self.context)?;
        let issue_url_format = self.handlebars.render("issue_url_format", &self.context)?;

[5.25295]

[9.5724]

            .render("compare_url_format", &context_base)?;
        let commit_url_format = self.handlebars.render("commit_url_format", &context_base)?;
        let issue_url_format = self.handlebars.render("issue_url_format", &context_base)?;

Replacement in src/conventional/changelog.rs at line 111 [5.18829]

B:BD[9.5797] → [9.5797:6050]

            .render("release_commit_message_format", &self.context)?;
        let user_url_format = self.handlebars.render("user_url_format", &self.context)?;
        let link_compare = self.context.current_tag != "" && self.context.previous_tag != "";

[9.5797]

[5.25354]

            .render("release_commit_message_format", &context_base)?;
        let user_url_format = self.handlebars.render("user_url_format", &context_base)?;
        let link_compare = context_base.current_tag != "" && context_base.previous_tag != "";

Replacement in src/conventional/changelog.rs at line 115 [5.18829]
B:BD[5.25375] → [5.25375:25410]
```
            context: self.context,
```
[5.25375]
[5.25410]
```
            context: context_base,
```
Replacement in src/conventional/changelog.rs at line 127 [5.18829]
B:BD[5.25512] → [5.25512:25538]
```
    pub(crate) writer: W,
```
[5.25512]
[5.25538]
```
    writer: W,
    handlebars: Handlebars<'static>,
```

Replacement in src/conventional/changelog.rs at line 132 [5.18829]

B:BD[5.25581] → [5.25581:25809]

    pub(crate) fn write_header(&mut self, header: &str) -> Result<(), Error> {
        write!(self.writer, "{}", header)?;
        Ok(())
    }
    pub fn write_template(&mut self, context: &Context<'_>) -> Result<(), Error> {

[5.25581]

[5.25809]

    pub(crate) fn new(writer: W) -> Result<Self, Error> {

Replacement in src/conventional/changelog.rs at line 142 [5.18829]

B:BD[5.26136] → [5.26136:26256]

        let writer = &mut self.writer;
        handlebars.render_to_write("template", context, writer)?;
        Ok(())

[5.26136]

[5.26256]

        Ok(Self { writer, handlebars })

Deletion in src/conventional/changelog.rs at line 144 [5.18829]
B:BD[5.26262] → [5.26262:26264]
```
}
```

Replacement in src/conventional/changelog.rs at line 145 [5.18829]

B:BD[5.26265] → [5.26265:26309]

B:BD[5.26309] → [9.6255:6275]

#[cfg(test)]
mod tests {
    use super::*;
    use serde_yaml;

[5.26265]

[5.26329]

    pub(crate) fn write_header(&mut self, header: &str) -> Result<(), Error> {
        write!(self.writer, "{}", header)?;
        Ok(())
    }

Replacement in src/conventional/changelog.rs at line 150 [5.18829]

B:BD[5.26330] → [5.26330:27354]

B:BD[5.27354] → [9.6276:6341]

∅:D[9.6341] → [5.27419:30496]

B:BD[5.27419] → [5.27419:30496]

    #[test]
    fn test() {
        let json = r#"{
              "types": [
                {"type": "chore", "section":"Others", "hidden": false},
                {"type": "revert", "section":"Reverts", "hidden": false},
                {"type": "feat", "section": "Features", "hidden": false},
                {"type": "fix", "section": "Bug Fixes", "hidden": false},
                {"type": "improvement", "section": "Feature Improvements", "hidden": false},
                {"type": "docs", "section":"Docs", "hidden": false},
                {"type": "style", "section":"Styling", "hidden": false},
                {"type": "refactor", "section":"Code Refactoring", "hidden": false},
                {"type": "perf", "section":"Performance Improvements", "hidden": false},
                {"type": "test", "section":"Tests", "hidden": false},
                {"type": "build", "section":"Build System", "hidden": false},
                {"type": "ci", "section":"CI", "hidden":false}
              ]
            }"#;
        let value: Config = serde_yaml::from_str(json).unwrap();
        assert_eq!(
            value,
            Config {
                header: "# Changelog\n\n".to_string(),
                types: vec![
                    Type {
                        r#type: "chore".into(),
                        section: "Others".into(),
                        hidden: false
                    },
                    Type {
                        r#type: "revert".into(),
                        section: "Reverts".into(),
                        hidden: false
                    },
                    Type {
                        r#type: "feat".into(),
                        section: "Features".into(),
                        hidden: false
                    },
                    Type {
                        r#type: "fix".into(),
                        section: "Bug Fixes".into(),
                        hidden: false
                    },
                    Type {
                        r#type: "improvement".into(),
                        section: "Feature Improvements".into(),
                        hidden: false
                    },
                    Type {
                        r#type: "docs".into(),
                        section: "Docs".into(),
                        hidden: false
                    },
                    Type {
                        r#type: "style".into(),
                        section: "Styling".into(),
                        hidden: false
                    },
                    Type {
                        r#type: "refactor".into(),
                        section: "Code Refactoring".into(),
                        hidden: false
                    },
                    Type {
                        r#type: "perf".into(),
                        section: "Performance Improvements".into(),
                        hidden: false
                    },
                    Type {
                        r#type: "test".into(),
                        section: "Tests".into(),
                        hidden: false
                    },
                    Type {
                        r#type: "build".into(),
                        section: "Build System".into(),
                        hidden: false
                    },
                    Type {
                        r#type: "ci".into(),
                        section: "CI".into(),
                        hidden: false
                    }
                ],
                pre_major: false,
                commit_url_format: "{{host}}/{{owner}}/{{repository}}/commit/{{hash}}".to_string(),
                compare_url_format:
                    "{{host}}/{{owner}}/{{repository}}/compare/{{previousTag}}...{{currentTag}}"
                        .to_string(),
                issue_url_format: "{{host}}/{{owner}}/{{repository}}/issues/{{id}}".to_string(),
                user_url_format: "{{host}}/{{user}}".to_string(),
                release_commit_message_format: "chore(release): {{currentTag}}".to_string(),
                issue_prefixes: vec!["#".into()]
            }
        )

[5.26330]

[5.30496]

    pub(crate) fn write_template(&mut self, context: &Context<'_>) -> Result<(), Error> {
        let writer = &mut self.writer;
        self.handlebars
            .render_to_write("template", context, writer)?;
        Ok(())

refactor(changelog): Refactor changelog command for better readability and performance Add `config` submodule to `changelog`. Improve performance by reusing handlebars registry in `ContextBuilder` and `ChangelogWriter`.

Dependencies

In channels

Change contents

Replacement in src/cmd/changelog.rs at line 6 [5.36278]

Insertion in src/cmd/changelog.rs at line 19 [5.36278]

Insertion in src/cmd/changelog.rs at line 36 [5.36278]

Replacement in src/cmd/changelog.rs at line 44 [5.36278]

Replacement in src/cmd/changelog.rs at line 56 [5.36278]

Replacement in src/cmd/changelog.rs at line 62 [5.36278]

Replacement in src/cmd/changelog.rs at line 181 [5.36278]

Replacement in src/cmd/changelog.rs at line 223 [5.36278]

Replacement in src/cmd/changelog.rs at line 227 [5.36278]

Replacement in src/cmd/changelog.rs at line 293 [5.36278]

Replacement in src/cmd/changelog.rs at line 296 [5.36278]

Replacement in src/cmd/changelog.rs at line 299 [5.36278]

File addition: config.rs (-rw-r--r--)

Replacement in src/conventional/changelog.rs at line 1 [5.18829]

Insertion in src/conventional/changelog.rs at line 4 [5.18829]

Replacement in src/conventional/changelog.rs at line 6 [5.18829]