Skip to content

feat(providers): add dart_provider #1564

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat(providers): add dart_provider #1564

wants to merge 1 commit into from

Conversation

TheAlbertDev
Copy link

closes: #1563

Description

as title

Checklist

Code Changes

  • Add test cases to all the changes you introduce
  • Run poetry 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

  • Run poetry doc locally to ensure the documentation pages renders correctly
  • Check and fix any broken links (internal or external) in the documentation

When running poetry doc, any broken internal documentation links will be reported in the console output like this:

INFO    -  Doc file 'config.md' contains a link 'commands/bump.md#-post_bump_hooks', but the doc 'commands/bump.md' does not contain an anchor '#-post_bump_hooks'.

Expected Behavior

Version field in dart's pubspec.yaml file should also update when running cz bump

Steps to Test This Pull Request

dart create your_package_name
cd your_package_name
cz init
git add .
cz c
cz bump

Additional Context

@codecov Codecov
Copy link

codecov bot commented Aug 1, 2025 •
edited
Loading

Codecov Report

❌ Patch coverage is 97.43590% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 97.95%. Comparing base (120d514) to head (e1e7164).
⚠️ Report is 753 commits behind head on master.

Files with missing lines Patch % Lines
commitizen/commands/init.py 80.00% 1 Missing ⚠️
Additional details and impacted files 
@@            Coverage Diff             @@
##           master    #1564      +/-   ##
==========================================
+ Coverage   97.33%   97.95%   +0.61%     
==========================================
  Files          42       59      +17     
  Lines        2104     2742     +638     
==========================================
+ Hits         2048     2686     +638     
  Misses         56       56
Flag Coverage Δ
unittests 97.95% <97.43%> (+0.61%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

woile
woile reviewed Aug 2, 2025
View reviewed changes
pyproject.toml
@@ -24,6 +24,7 @@ dependencies = [
"charset-normalizer (>=2.1.0,<4)",
# Use the Python 3.11 and 3.12 compatible API: https://github.com/python/importlib_metadata#compatibility
"importlib-metadata >=8.0.0,<8.7.0 ; python_version < '3.10'",
"ruamel-yaml (>=0.18.14,<0.19.0)",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why this?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The pubspec.yaml file in Dart contains fields both with and without quotes. ruamel.yaml extends PyYAML by offering more configuration options, such as setting style preferences for quotes — in this case, preserving the original ones.

@TheAlbertDev TheAlbertDev requested a review from woile August 4, 2025 11:25
@TheAlbertDev TheAlbertDev force-pushed the feature/dart-version-provider branch from e1e7164 to 4dd2ac2 Compare August 10, 2025 14:05
@Lee-W
Copy link
Member

Lee-W commented Aug 17, 2025

@woile I think we're planning to make it separate from the core of commitizen? then I'll skip reviewing for now till we have that. or we can also merge it and separate it at a later point. let me know whether you want me to take a look first. Thanks 🙂

@TheAlbertDev TheAlbertDev force-pushed the feature/dart-version-provider branch from 4dd2ac2 to 0f012ab Compare August 17, 2025 06:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Lee-W Lee-W Awaiting requested review from Lee-W Lee-W is a code owner

@noirbizarre noirbizarre Awaiting requested review from noirbizarre noirbizarre is a code owner

@woile woile Awaiting requested review from woile woile is a code owner

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
pr-status: wait-for-review type: feature A new enhacement proposal
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Dart provider
3 participants
@TheAlbertDev @Lee-W @woile