Add `charmcraft fmt` command
Metadata
Current evaluation
A maintainer-endorsed feature request to add `charmcraft format` for semantics-preserving charm file formatting remains open pending agreement on scope and standards.
Suggested action: keep open
Reason: A maintainer endorsed the premise, proposed the full name `format` with a `--diff` option, and opened a forum discussion to define the standard. The request remains valid, but implementation is not yet turnkey because the maintainer explicitly said to first stabilize the supported files and formatting rules; the current codebase has no matching command.
Evaluated by: mr-cal-bot
Impact:
42
Quick Win:
6
Complexity:
72
Confidence:
91
Actionability:
52
Issue body
It could be handy if charmcraft had an `fmt` command to apply a set of opinionated formatting choices.
For example:
- Sort metadata.yaml sections in a particular order, e.g. name - assumes - summary - description - ...
- One line gap between each main section and no gaps anywhere else
- actions.yaml and config.yaml entries sorted alphabetically
- charmcraft.yaml: bases before parts; parts sorted by order of business.
- etc.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha |
Impact:
42
Quick Win:
6
Complexity:
72
Confidence:
91
Actionability:
52
|
keep open | A maintainer-endorsed feature request to add `charmcraft format` for semantics-preserving charm file formatting remains open pending agreement on scope and standards. | |
| qwen/qwen3.6-35b-a3b |
Impact:
35
Quick Win:
7
Complexity:
55
Confidence:
70
Actionability:
45
|
keep open | Feature request to add a charmcraft format command for opinionated formatting of charm files like metadata.yaml, charmcraft.yaml, etc. | |
| qwen/qwen3.8-27b |
Impact:
30
Quick Win:
18
Staleness:
65
Complexity:
40
Confidence:
70
Support Request:
5
|
keep open | Feature request for a charmcraft format command to apply opinionated YAML formatting to metadata.yaml, actions.yaml, config.yaml, and charmcraft.yaml. Triaged by maintainer who created a forum post for consensus; no implementation yet after over a year of inactivity. | |
| qwen/qwen3.6-35b-a3b |
Staleness:
90
Complexity:
55
Confidence:
75
Support Request:
10
|
close stale | Request for a charmcraft format command to apply consistent, opinionated formatting to charm YAML files. Maintainers discussed scope and created a forum post for consensus, but the issue has been inactive for over a year. | |
| qwen3.6-35b-a3b-mtp-q6 |
Staleness:
90
Complexity:
45
Confidence:
80
Support Request:
10
|
needs triage | Proposal to add a format command to charmcraft for enforcing consistent formatting on charm metadata and config files. Currently awaiting consensus from a Discourse discussion initiated in late 2022. | |
| qwen3.6-35b-a3b-mtp-q6 |
Staleness:
75
Complexity:
45
Confidence:
80
Support Request:
0
|
keep open | Feature request to add a charmcraft format command for opinionated formatting of charm files. Maintainers are interested and have opened a forum discussion to define formatting rules before implementation. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #794 Clarify `charmcraft status --help` text for `--format` | charmcraft | closed | Clarified `charmcraft status --format` help to state that it accepts `json`; merged via #933 (commit `2f673059`). | |
| #940 Add yaml formatting feature in charmcraft status | charmcraft | closed | Proposal to add YAML output to `charmcraft status --format` was declined; maintainer facundobatista noted the flag exists for machine consumption. Author rahulsinghcanonical agreed and closed it himself with no code change. |