Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add option for "cz.toml" config file #1111

Closed
marcosdotme opened this issue May 15, 2024 · 4 comments · Fixed by #1130
Closed

Add option for "cz.toml" config file #1111

marcosdotme opened this issue May 15, 2024 · 4 comments · Fixed by #1130
Assignees
Labels
good first issue issue-status: wait-for-implementation maintainers agree on the bug / feature type: feature A new enhacement proposal

Comments

@marcosdotme
Copy link
Contributor

Description

Actually we can configure the commitizen through:

Dot files:

.cz.toml
.cz.yaml
.cz.json

Non dot files:

pyproject.toml
cz.yaml
cz.json

Theres an reason for not having an "cz.toml" without the dot? I like that my config files be explicit and not hidded. Can I open an PR to add this support? Seems easy to do.

Possible Solution

Include "cz.toml" on commitizen.defaults.config_files:

# commitizen.defaults.py

config_files: list[str] = [
    "pyproject.toml",
    ".cz.toml",
    ".cz.json",
    "cz.json",
    ".cz.yaml",
    "cz.yaml",
+   "cz.toml"
]

Additional context

No response

Additional context

No response

@Lee-W
Copy link
Member

Lee-W commented May 20, 2024

Don't have a strong opinion on it. Either way works for me @woile @noirbizarre thoughts?

@woile
Copy link
Member

woile commented May 20, 2024

Sounds good 👍🏻

@Lee-W Lee-W added the issue-status: wait-for-implementation maintainers agree on the bug / feature label May 20, 2024
@marcosdotme
Copy link
Contributor Author

@Lee-W Assign this to me so I can open an PR

@Lee-W
Copy link
Member

Lee-W commented May 20, 2024

Sure 🙂

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue issue-status: wait-for-implementation maintainers agree on the bug / feature type: feature A new enhacement proposal
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants