UIP-1639 Update formatting guidelines WRT dartfmt and trailing commas
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 48/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- dart
- Domain
- documentation
Research direction
Locate the repository's formatting guidelines and review the existing advice about dartfmt, dart_style, and trailing commas. Update the guidance to recommend trailing commas for variadic builder children and accept dartfmt output when they are used; done means both requested recommendations are clearly documented.
Written by the indexing model from the issue text.
Description
Our formatting guidelines currently recommend against using dartfmt/dart_style on over_react code.
We recently discovered that dartfmt is capable of producing significantly more readable over_react code, due to changes in dart_style that treat Flutter code better when nested components use trailing commas.
For more info, see https://github.com/dart-lang/dart_style/issues/549. Thanks to @skybrian for getting the conversation started, and to @matanlurey for suggesting we revisit the issue!
We should upgrade the formatting guidelines to:
- recommend trailing commas whenever supplying variadic children to a builder, even if it's just one
- indicate that dartfmt output, while not perfect, is acceptable when trailing commas are used
FYI: @greglittlefield-wf @aaronlademann-wf @jacehensley-wf @clairesarsam-wf @joelleibow-wf
- Dominant language
- Dart
- Stars
- 432
- Forks
- 57
- Avg merge
- 12m
- Merged PRs (30d)
- 2
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from Workiva/over_react
-
Difficulty 4/5 3-5 days Newbie friendliness 45/100
Workiva/over_react#981 · 4 comments · 1 reaction ·
-
Difficulty 4/5 3-5 days Newbie friendliness 30/100
Workiva/over_react#947 · 8 comments · 1 reaction ·
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
Workiva/over_react#942 · 8 comments ·
-
Difficulty 4/5 3-5 days Newbie friendliness 30/100
Workiva/over_react#939 · 1 comment ·
-
Difficulty 3/5 1-2 days Newbie friendliness 20/100
Workiva/over_react#644 · 3 comments ·
All issues in Workiva/over_react
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
linagora/twake-on-matrix#3435 ·
Maintainers usually reply within 3 days
-
bug to check
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Maintainers usually reply within 1 day
-
右下角的图标问题Open
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
[Domain Activation] Show a user-friendly error when sending is blocked pending domain activationOpen
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
linagora/tmail-flutter#4953 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100