orhun/git-cliff

Format markdown

Open

#678 opened on Jun 5, 2024

View on GitHub
 (0 comments) (1 reaction) (0 assignees)Rust (308 forks)auto 404
feature/requestgood first issue

Repository metrics

Stars
 (12,040 stars)
PR merge metrics
 (PR metrics pending)

Description

Is there an existing issue or pull request for this?

  • I have searched the existing issues and pull requests

Feature description

Writing a Tera template with perfect formatting is hard. Tweaking things with {%- instead of {% and trim = true is sometimes annoying.

Desired solution

git-cliff should support outputting the formatted markdown file. e.g.

[changelog]
# formats the changelog (only supports markdown)
format = true

We can use a crate like prettify-markdown or something similar (and more up-to-date maybe).

We can detect markdown files by simply looking at the extension (.md).

Alternatives considered

Users can always configure postprocessors to do markdown formatting:

[changelog]
postprocessors = [
  { pattern = '.*', replace_command = "mdformat -" },
]

But I think it is better to support this feature out-of-the-box.

Additional context

No response

Contributor guide

Research direction
Add a `format` boolean option to the `[changelog]` configuration section, then use a Rust markdown formatter crate (e.g., prettify markdown) to format the output when enabled.
Tech stack
rust
Domain
clitoolingdeveloper experience
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
RustGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70