refactor(config)!: rename option changelog.trim into `changelog.tri…

…m_body_whitespace`

Renamed option `changelog.trim` into `changelog.trim_body_whitespace` for clarity.
Updated description and documentation for option `changelog.trim_body_whitespace`.

.github/fixtures/new-fixture-template/cliff.toml

@@ -22,8 +22,8 @@ body_template = """
 footer_template = """
 <!-- generated by git-cliff -->
 """
-# remove the leading and trailing whitespace from the templates
-trim = true
+# Whether to remove leading and trailing whitespaces from all lines of the changelog's body.
+trim_body_whitespace = true
 
 [release]
 

.github/fixtures/test-bump-version-keep-zerover/cliff.toml

@@ -22,8 +22,8 @@ body_template = """
 footer_template = """
 <!-- generated by git-cliff -->
 """
-# remove the leading and trailing whitespace from the templates
-trim = true
+# Whether to remove leading and trailing whitespaces from all lines of the changelog's body.
+trim_body_whitespace = true
 
 [bump]
 features_always_bump_minor = false

.github/fixtures/test-bump-version/cliff.toml

@@ -22,5 +22,5 @@ body_template = """
 footer_template = """
 <!-- generated by git-cliff -->
 """
-# remove the leading and trailing whitespace from the templates
-trim = true
+# Whether to remove leading and trailing whitespaces from all lines of the changelog's body.
+trim_body_whitespace = true

.github/fixtures/test-bumped-version/cliff.toml

@@ -22,5 +22,5 @@ body_template = """
 footer_template = """
 <!-- generated by git-cliff -->
 """
-# remove the leading and trailing whitespace from the templates
-trim = true
+# Whether to remove leading and trailing whitespaces from all lines of the changelog's body.
+trim_body_whitespace = true

.github/fixtures/test-commit-footers/cliff.toml

@@ -25,5 +25,5 @@ body_template = """
 footer_template = """
 <!-- generated by git-cliff -->
 """
-# remove the leading and trailing whitespace from the templates
-trim = true
+# Whether to remove leading and trailing whitespaces from all lines of the changelog's body.
+trim_body_whitespace = true

.github/fixtures/test-commit-preprocessors/cliff.toml

@@ -22,8 +22,8 @@ body_template = """
 footer_template = """
 <!-- generated by git-cliff -->
 """
-# remove the leading and trailing whitespace from the templates
-trim = true
+# Whether to remove leading and trailing whitespaces from all lines of the changelog's body.
+trim_body_whitespace = true
 
 [release]
 

.github/fixtures/test-custom-scope/cliff.toml

@@ -25,8 +25,8 @@ body_template = """
 footer_template = """
 <!-- generated by git-cliff -->
 """
-# remove the leading and trailing whitespace from the templates
-trim = true
+# Whether to remove leading and trailing whitespaces from all lines of the changelog's body.
+trim_body_whitespace = true
 
 [commit]
 # A list of parsers using regex for extracting data from the commit message.

.github/fixtures/test-custom-tag-pattern/cliff.toml

@@ -22,8 +22,8 @@ body_template = """
 footer_template = """
 <!-- generated by git-cliff -->
 """
-# remove the leading and trailing whitespace from the templates
-trim = true
+# Whether to remove leading and trailing whitespaces from all lines of the changelog's body.
+trim_body_whitespace = true
 
 [release]
 

.github/fixtures/test-date-order/cliff.toml

@@ -22,5 +22,5 @@ body_template = """
 footer_template = """
 <!-- generated by git-cliff -->
 """
-# remove the leading and trailing whitespace from the templates
-trim = true
+# Whether to remove leading and trailing whitespaces from all lines of the changelog's body.
+trim_body_whitespace = true

.github/fixtures/test-footer-template/cliff.toml

@@ -30,5 +30,5 @@ footer_template = """
  {% endif %}\
 {% endfor %}\
 """
-# remove the leading and trailing whitespace from the templates
-trim = true
+# Whether to remove leading and trailing whitespaces from all lines of the changelog's body.
+trim_body_whitespace = true

.github/fixtures/test-github-integration/cliff.toml

@@ -30,8 +30,8 @@ body_template = """
  {% raw %}\n{% endraw %}
 {% endif %}
 """
-# remove the leading and trailing whitespace from the template
-trim = true
+# Whether to remove leading and trailing whitespaces from all lines of the changelog's body.
+trim_body_whitespace = true
 # A Tera template to be rendered as the changelog's footer (see https://keats.github.io/tera/docs/#introduction).
 footer_template = """
 <!-- generated by git-cliff -->

.github/fixtures/test-ignore-tags/cliff.toml

@@ -22,8 +22,8 @@ body_template = """
 footer_template = """
 <!-- generated by git-cliff -->
 """
-# remove the leading and trailing whitespace from the templates
-trim = true
+# Whether to remove leading and trailing whitespaces from all lines of the changelog's body.
+trim_body_whitespace = true
 
 [release]
 # Regex to select git tags that do not represent proper releases. Takes precedence over `release.tags_pattern`.

.github/fixtures/test-keep-a-changelog-links-current-arg/cliff.toml

@@ -35,8 +35,8 @@ body_template = """
  {% endfor %}
 {% endfor %}\n
 """
-# remove the leading and trailing whitespace from the template
-trim = true
+# Whether to remove leading and trailing whitespaces from all lines of the changelog's body.
+trim_body_whitespace = true
 # A Tera template to be rendered as the changelog's footer (see https://keats.github.io/tera/docs/#introduction).
 footer_template = """
 <!-- generated by git-cliff -->

.github/fixtures/test-keep-a-changelog-links-latest-arg/cliff.toml

@@ -35,8 +35,8 @@ body_template = """
  {% endfor %}
 {% endfor %}\n
 """
-# remove the leading and trailing whitespace from the template
-trim = true
+# Whether to remove leading and trailing whitespaces from all lines of the changelog's body.
+trim_body_whitespace = true
 # A Tera template to be rendered as the changelog's footer (see https://keats.github.io/tera/docs/#introduction).
 footer_template = """
 <!-- generated by git-cliff -->

.github/fixtures/test-keep-a-changelog-links-no-tags/cliff.toml

@@ -35,8 +35,8 @@ body_template = """
  {% endfor %}
 {% endfor %}\n
 """
-# remove the leading and trailing whitespace from the template
-trim = true
+# Whether to remove leading and trailing whitespaces from all lines of the changelog's body.
+trim_body_whitespace = true
 # A Tera template to be rendered as the changelog's footer (see https://keats.github.io/tera/docs/#introduction).
 footer_template = """
 <!-- generated by git-cliff -->

.github/fixtures/test-keep-a-changelog-links-one-tag-bump-arg/cliff.toml

@@ -35,8 +35,8 @@ body_template = """
  {% endfor %}
 {% endfor %}\n
 """
-# remove the leading and trailing whitespace from the template
-trim = true
+# Whether to remove leading and trailing whitespaces from all lines of the changelog's body.
+trim_body_whitespace = true
 # A Tera template to be rendered as the changelog's footer (see https://keats.github.io/tera/docs/#introduction).
 footer_template = """
 <!-- generated by git-cliff -->

.github/fixtures/test-keep-a-changelog-links-one-tag/cliff.toml

@@ -35,8 +35,8 @@ body_template = """
  {% endfor %}
 {% endfor %}\n
 """
-# remove the leading and trailing whitespace from the template
-trim = true
+# Whether to remove leading and trailing whitespaces from all lines of the changelog's body.
+trim_body_whitespace = true
 # A Tera template to be rendered as the changelog's footer (see https://keats.github.io/tera/docs/#introduction).
 footer_template = """
 <!-- generated by git-cliff -->

.github/fixtures/test-keep-a-changelog-links-tag-arg/cliff.toml

@@ -35,8 +35,8 @@ body_template = """
  {% endfor %}
 {% endfor %}\n
 """
-# remove the leading and trailing whitespace from the template
-trim = true
+# Whether to remove leading and trailing whitespaces from all lines of the changelog's body.
+trim_body_whitespace = true
 # A Tera template to be rendered as the changelog's footer (see https://keats.github.io/tera/docs/#introduction).
 footer_template = """
 <!-- generated by git-cliff -->

.github/fixtures/test-keep-a-changelog-links-unreleased-arg/cliff.toml

@@ -35,8 +35,8 @@ body_template = """
  {% endfor %}
 {% endfor %}\n
 """
-# remove the leading and trailing whitespace from the template
-trim = true
+# Whether to remove leading and trailing whitespaces from all lines of the changelog's body.
+trim_body_whitespace = true
 # A Tera template to be rendered as the changelog's footer (see https://keats.github.io/tera/docs/#introduction).
 footer_template = """
 <!-- generated by git-cliff -->

.github/fixtures/test-keep-a-changelog-links/cliff.toml

@@ -39,8 +39,8 @@ body_template = """
 footer_template = """
 <!-- generated by git-cliff -->
 """
-# remove the leading and trailing whitespace from the templates
-trim = true
+# Whether to remove leading and trailing whitespaces from all lines of the changelog's body.
+trim_body_whitespace = true
 # Whether to exclude changes that do not belong to any group from the changelog.
 exclude_ungrouped_changes = true
 

.github/fixtures/test-latest-with-one-tag/cliff.toml

@@ -22,5 +22,5 @@ body_template = """
 footer_template = """
 <!-- generated by git-cliff -->
 """
-# remove the leading and trailing whitespace from the templates
-trim = true
+# Whether to remove leading and trailing whitespaces from all lines of the changelog's body.
+trim_body_whitespace = true

.github/fixtures/test-limit-commits/cliff.toml

@@ -22,8 +22,8 @@ body_template = """
 footer_template = """
 <!-- generated by git-cliff -->
 """
-# remove the leading and trailing whitespace from the templates
-trim = true
+# Whether to remove leading and trailing whitespaces from all lines of the changelog's body.
+trim_body_whitespace = true
 
 [commit]
 # Whether to limit the total number of commits to be included in the changelog.

.github/fixtures/test-no-exec/cliff.toml

@@ -22,8 +22,8 @@ body_template = """
 footer_template = """
 <!-- generated by git-cliff -->
 """
-# remove the leading and trailing whitespace from the templates
-trim = true
+# Whether to remove leading and trailing whitespaces from all lines of the changelog's body.
+trim_body_whitespace = true
 # A list of postprocessors using regex to modify the changelog.
 postprocessors = [
  { pattern = '.*', replace_command = 'this_command_does_not_exist' },

.github/fixtures/test-regex-replace-parser/cliff.toml

@@ -22,8 +22,8 @@ body_template = """
 footer_template = """
 <!-- generated by git-cliff -->
 """
-# remove the leading and trailing whitespace from the templates
-trim = true
+# Whether to remove leading and trailing whitespaces from all lines of the changelog's body.
+trim_body_whitespace = true
 
 [commit]
 # A list of parsers using regex for extracting data from the commit message.

.github/fixtures/test-skip-breaking-changes/cliff.toml

@@ -25,8 +25,8 @@ body_template = """
 footer_template = """
 <!-- generated by git-cliff -->
 """
-# remove the leading and trailing whitespace from the templates
-trim = true
+# Whether to remove leading and trailing whitespaces from all lines of the changelog's body.
+trim_body_whitespace = true
 
 [commit]
 # A list of parsers using regex for extracting data from the commit message.

.github/fixtures/test-skip-commits/cliff.toml

@@ -22,8 +22,8 @@ body_template = """
 footer_template = """
 <!-- generated by git-cliff -->
 """
-# remove the leading and trailing whitespace from the templates
-trim = true
+# Whether to remove leading and trailing whitespaces from all lines of the changelog's body.
+trim_body_whitespace = true
 
 [commit]
 # A list of parsers using regex for extracting data from the commit message.

.github/fixtures/test-split-commits/cliff.toml

@@ -22,8 +22,8 @@ body_template = """
 footer_template = """
 <!-- generated by git-cliff -->
 """
-# remove the leading and trailing whitespace from the templates
-trim = true
+# Whether to remove leading and trailing whitespaces from all lines of the changelog's body.
+trim_body_whitespace = true
 
 [commit]
 # Whether to split commits on newlines, treating each line as an individual commit.

.github/fixtures/test-topo-order-arg/cliff.toml

@@ -22,5 +22,5 @@ body_template = """
 footer_template = """
 <!-- generated by git-cliff -->
 """
-# remove the leading and trailing whitespace from the templates
-trim = true
+# Whether to remove leading and trailing whitespaces from all lines of the changelog's body.
+trim_body_whitespace = true

.github/fixtures/test-topo-order/cliff.toml

@@ -22,8 +22,8 @@ body_template = """
 footer_template = """
 <!-- generated by git-cliff -->
 """
-# remove the leading and trailing whitespace from the templates
-trim = true
+# Whether to remove leading and trailing whitespaces from all lines of the changelog's body.
+trim_body_whitespace = true
 
 [release]
 # Whether to order releases chronologically or topologically.

cliff.toml

@@ -53,8 +53,8 @@ body_template = """
 footer_template = """
 <!-- generated by git-cliff -->
 """
-# remove the leading and trailing whitespace from the templates
-trim = true
+# Whether to remove leading and trailing whitespaces from all lines of the changelog's body.
+trim_body_whitespace = true
 # A list of postprocessors using regex to modify the changelog.
 postprocessors = [
  { pattern = '<REPO>', replace = "https://github.com/orhun/git-cliff" }, # replace repository URL

config/cliff.toml

@@ -31,8 +31,8 @@ body_template = """
 footer_template = """
 <!-- generated by git-cliff -->
 """
-# remove the leading and trailing s
-trim = true
+# Whether to remove leading and trailing whitespaces from all lines of the changelog's body.
+trim_body_whitespace = true
 # A list of postprocessors using regex to modify the changelog.
 postprocessors = [
  # { pattern = '<REPO>', replace = "https://github.com/orhun/git-cliff" }, # replace repository URL

examples/cocogitto.toml

@@ -41,8 +41,8 @@ body_template = """
 footer_template = """
 <!-- generated by git-cliff -->
 """
-# remove the leading and trailing whitespace from the templates
-trim = true
+# Whether to remove leading and trailing whitespaces from all lines of the changelog's body.
+trim_body_whitespace = true
 # A list of postprocessors using regex to modify the changelog.
 postprocessors = [
  { pattern = '\$REPO', replace = "https://github.com/cocogitto/cocogitto" }, # replace repository URL

examples/detailed.toml

@@ -34,8 +34,8 @@ body_template = """
 footer_template = """
 <!-- generated by git-cliff -->
 """
-# remove the leading and trailing whitespace from the templates
-trim = true
+# Whether to remove leading and trailing whitespaces from all lines of the changelog's body.
+trim_body_whitespace = true
 # Whether to exclude changes that do not belong to any group from the changelog.
 exclude_ungrouped_changes = false
 

examples/github-keepachangelog.toml

@@ -64,8 +64,8 @@ footer_template = """
 {% endfor %}
 <!-- generated by git-cliff -->
 """
-# remove the leading and trailing whitespace from the templates
-trim = true
+# Whether to remove leading and trailing whitespaces from all lines of the changelog's body.
+trim_body_whitespace = true
 # Whether to exclude changes that do not belong to any group from the changelog.
 exclude_ungrouped_changes = true
 

examples/github.toml

@@ -48,8 +48,8 @@ body_template = """
  https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}
 {%- endmacro -%}
 """
-# remove the leading and trailing whitespace from the template
-trim = true
+# Whether to remove leading and trailing whitespaces from all lines of the changelog's body.
+trim_body_whitespace = true
 # A Tera template to be rendered as the changelog's footer (see https://keats.github.io/tera/docs/#introduction).
 footer_template = """
 <!-- generated by git-cliff -->

examples/keepachangelog.toml

@@ -40,8 +40,8 @@ footer_template = """
 {% endfor %}
 <!-- generated by git-cliff -->
 """
-# remove the leading and trailing whitespace from the templates
-trim = true
+# Whether to remove leading and trailing whitespaces from all lines of the changelog's body.
+trim_body_whitespace = true
 # Whether to exclude changes that do not belong to any group from the changelog.
 exclude_ungrouped_changes = true
 

examples/scoped.toml

@@ -28,8 +28,8 @@ body_template = """
 footer_template = """
 <!-- generated by git-cliff -->
 """
-# remove the leading and trailing whitespace from the templates
-trim = true
+# Whether to remove leading and trailing whitespaces from all lines of the changelog's body.
+trim_body_whitespace = true
 # Whether to exclude changes that do not belong to any group from the changelog.
 exclude_ungrouped_changes = false
 

examples/scopesorted.toml

@@ -41,8 +41,8 @@ body_template = """
 footer_template = """
 <!-- generated by git-cliff -->
 """
-# remove the leading and trailing whitespace from the templates
-trim = true
+# Whether to remove leading and trailing whitespaces from all lines of the changelog's body.
+trim_body_whitespace = true
 # Whether to exclude changes that do not belong to any group from the changelog.
 exclude_ungrouped_changes = false