René's URL Explorer Experiment

Title: feat: add cz dump-config command to output effective configuration by bearomorphism · Pull Request #1986 · commitizen-tools/commitizen · GitHub

Open Graph Title: feat: add cz dump-config command to output effective configuration by bearomorphism · Pull Request #1986 · commitizen-tools/commitizen

X Title: feat: add cz dump-config command to output effective configuration by bearomorphism · Pull Request #1986 · commitizen-tools/commitizen

Description: Description Adds a new cz dump-config command that prints the effective Commitizen configuration (defaults merged with any project overrides) in TOML, YAML, or JSON format. Users can paste the output directly into a configuration file as a starting template and tweak from there — which is exactly the use-case raised in #1331. Why Users working with monorepos or custom commit conventions (like the reporter in #1331) struggle because overriding a single setting (e.g. customize.questions) replaces the entire default. There was no way to see the full effective config without reading source code. cz dump-config solves this by exposing the merged settings. What changed Area Change commitizen/commands/dump_config.py New DumpConfig command class commitizen/commands/__init__.py Export DumpConfig commitizen/cli.py Register dump-config subparser with --format argument tests/commands/test_dump_config_command.py New tests for all three formats tests/commands/test_common_command.py Add dump-config to help-snapshot parametrize list tests/commands/test_common_command/ Help snapshot files for py 3.10–3.14 docs/commands/dump_config.md Command documentation mkdocs.yml Add dump-config to nav How it works DumpConfig.__call__() reads config.settings (a Settings TypedDict containing defaults merged with user config). For TOML (default): None values are filtered out (TOML cannot represent null), then the dict is wrapped in a [tool.commitizen] section and serialised with tomlkit.dumps(). For YAML: the dict (with None values preserved as null) is wrapped in tool.commitizen and serialised with yaml.safe_dump(). For JSON: same wrapping, serialised with json.dumps(indent=2). All three formats mirror the input structure so the output can be pasted directly into pyproject.toml, .cz.yaml, or .cz.json. Backward compatibility Purely additive — new subcommand only. No existing commands, APIs, or config keys changed. Checklist I have read the contributing guidelines Was generative AI tooling used to co-author this PR? Yes (please specify the tool below) Generated-by: GitHub Copilot CLI following the guidelines Code Changes Add test cases to all the changes you introduce Run uv run poe all locally to ensure this change passes linter check and tests Manually test the changes: Verify the feature/bug fix works as expected in real-world scenarios Test edge cases and error conditions Ensure backward compatibility is maintained Document any manual testing steps performed Update the documentation for the changes Documentation Changes Added docs/commands/dump_config.md Updated mkdocs.yml nav Expected Behavior Command Expected output cz dump-config TOML block under [tool.commitizen] with effective settings (no null values) cz dump-config --format yaml YAML block under tool.commitizen with effective settings cz dump-config --format json JSON object {"tool": {"commitizen": {...}}} Steps to Test This Pull Request # 1. Install the branch git checkout feat/1331-dump-config-command # 2. Dump default config as TOML cz dump-config # Expected: [tool.commitizen] block with name = "cz_conventional_commits" etc. # 3. Dump as YAML cz dump-config --format yaml # Expected: tool:\n commitizen:\n name: cz_conventional_commits ... # 4. Dump as JSON cz dump-config --format json # Expected: {"tool": {"commitizen": {"name": "cz_conventional_commits", ...}}} # 5. Verify no null values in TOML output cz dump-config | grep -i null # Expected: no output (null values are filtered) # 6. Round-trip test: dump → paste → compare cz dump-config > /tmp/dumped.toml # Verify the file is valid TOML: python -c "import tomlkit; tomlkit.loads(open('/tmp/dumped.toml').read())" Additional Context Closes #1331. The maintainer suggested this could be layered on top of cz init (#1331 comment), but a standalone cz dump-config is cleaner and more composable (pipe to a file, diff against a known config, etc.).

Open Graph Description: Description Adds a new cz dump-config command that prints the effective Commitizen configuration (defaults merged with any project overrides) in TOML, YAML, or JSON format. Users can paste the outp...

X Description: Description Adds a new cz dump-config command that prints the effective Commitizen configuration (defaults merged with any project overrides) in TOML, YAML, or JSON format. Users can paste the outp...

Opengraph URL: https://github.com/commitizen-tools/commitizen/pull/1986

X: @github

direct link

Domain: github.com

Links:

Viewport: width=device-width