Repository navigation
[code_builder] Minor style fixes - #2501
Merged
Merged
Conversation
Package publishingIf you have publishing permissions, you can use the links below to publish the changes after merging this PR.
Documentation at https://github.com/dart-lang/ecosystem/wiki/Publishing-automation. |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request refactors the README.md to improve the basic usage examples, updates CHANGELOG.md formatting, and fixes several typos in the expression tests. The reviewer feedback recommends adding missing imports to the README code snippets and formatting the DartFormatter instantiations to ensure the examples are complete and highly readable.
Comment on lines
+16
to
+19
| final animal = Class((builder) => builder | ||
| ..name = 'Animal' | ||
| ..extend = refer('Organism') | ||
| ..methods.add(Method.returnsVoid((b) => b | ||
| ..name = 'eat' | ||
| ..body = const Code("print('Yum!');")))); | ||
| final emitter = DartEmitter(); | ||
| print( | ||
| DartFormatter(languageVersion: DartFormatter.latestLanguageVersion) | ||
| .format('${animal.accept(emitter)}'), | ||
| ); | ||
| } | ||
| ); |
Contributor
There was a problem hiding this comment.
The code snippet is missing the import statement for package:code_builder/code_builder.dart. Adding the import makes the basic usage example self-contained and easier for new users to copy and run.
Suggested change
| final animal = Class((builder) => builder | |
| ..name = 'Animal' | |
| ..extend = refer('Organism') | |
| ..methods.add(Method.returnsVoid((b) => b | |
| ..name = 'eat' | |
| ..body = const Code("print('Yum!');")))); | |
| final emitter = DartEmitter(); | |
| print( | |
| DartFormatter(languageVersion: DartFormatter.latestLanguageVersion) | |
| .format('${animal.accept(emitter)}'), | |
| ); | |
| } | |
| ); | |
| import 'package:code_builder/code_builder.dart'; | |
| final animal = Class((builder) => builder | |
| ..name = 'Animal' | |
| ..extend = refer('Organism') | |
| ); |
References
- Optimize for readability - code is read more often than it is written. (link)
Comment on lines
+32
to
+48
| import 'package:dart_style/dart_style.dart'; | ||
|
|
||
| // ... // | ||
|
|
||
| final emitter = DartEmitter(); | ||
|
|
||
| // Generate code for 'animal' into a new StringBuffer | ||
| final StringSink result = animal.accept(emitter); | ||
|
|
||
| // or, add it to an existing one | ||
| final buffer = StringBuffer(); | ||
| animal.accept(emitter, buffer); | ||
|
|
||
| // format the output using package:dart_style | ||
| final String formatted = DartFormatter( | ||
| languageVersion: DartFormatter.latestLanguageVersion) | ||
| .format(result.toString()); |
Contributor
There was a problem hiding this comment.
Add the missing import for package:code_builder/code_builder.dart to make the snippet complete. Additionally, format the DartFormatter instantiation with a trailing comma and standard method call chaining to improve readability.
Suggested change
| import 'package:dart_style/dart_style.dart'; | |
| // ... // | |
| final emitter = DartEmitter(); | |
| // Generate code for 'animal' into a new StringBuffer | |
| final StringSink result = animal.accept(emitter); | |
| // or, add it to an existing one | |
| final buffer = StringBuffer(); | |
| animal.accept(emitter, buffer); | |
| // format the output using package:dart_style | |
| final String formatted = DartFormatter( | |
| languageVersion: DartFormatter.latestLanguageVersion) | |
| .format(result.toString()); | |
| import 'package:code_builder/code_builder.dart'; | |
| import 'package:dart_style/dart_style.dart'; | |
| // ... // | |
| final emitter = DartEmitter(); | |
| // Generate code for 'animal' into a new StringBuffer | |
| final StringSink result = animal.accept(emitter); | |
| // or, add it to an existing one | |
| final buffer = StringBuffer(); | |
| animal.accept(emitter, buffer); | |
| // format the output using package:dart_style | |
| final String formatted = DartFormatter( | |
| languageVersion: DartFormatter.latestLanguageVersion, | |
| ).format(result.toString()); |
References
- Optimize for readability - code is read more often than it is written. (link)
Comment on lines
+87
to
+89
| final formatted = DartFormatter( | ||
| languageVersion: DartFormatter.latestLanguageVersion) | ||
| .format(library.accept(emitter).toString()); |
Contributor
There was a problem hiding this comment.
Format the DartFormatter instantiation with a trailing comma and standard method call chaining to improve readability and maintain consistent style.
Suggested change
| final formatted = DartFormatter( | |
| languageVersion: DartFormatter.latestLanguageVersion) | |
| .format(library.accept(emitter).toString()); | |
| final formatted = DartFormatter( | |
| languageVersion: DartFormatter.latestLanguageVersion, | |
| ).format(library.accept(emitter).toString()); |
References
- Optimize for readability - code is read more often than it is written. (link)
PR HealthLicense Headers ✔️
All source files should start with a license header. This check can be disabled by tagging the PR with Unused Dependencies ✔️
For details on how to fix these, see dependency_validator. This check can be disabled by tagging the PR with Coverage ✔️
This check for test coverage is informational (issues shown here will not fail the PR). This check can be disabled by tagging the PR with API leaks ✔️The following packages contain symbols visible in the public API, but not exported by the library. Export these symbols or remove them from your publicly visible API.
This check can be disabled by tagging the PR with Breaking changes ✔️
This check can be disabled by tagging the PR with |
copybara-service Bot
pushed a commit
to dart-lang/sdk
that referenced
this pull request
Aug 11, 2026
Revisions updated by `dart tools/rev_sdk_deps.dart`. dartdoc (https://github.com/dart-lang/dartdoc/compare/1fd02f7..8be851e): 8be851e2 Mon Aug 10 13:51:08 2026 +0200 Sarah Zakarias Bump to 9.0.9 (dart-lang/dartdoc#4278) http (https://github.com/dart-lang/http/compare/9cb80c7..a9176ac): a9176ac Mon Aug 10 13:27:26 2026 +0200 dart-ecosystem-bot[bot] Tidy: package:http2 (dart-lang/http#1967) 9bd9ccb Sat Aug 8 06:31:37 2026 +0300 Ellet chore(ok_http): migrate to jni 1.0.0 (dart-lang/http#1943) 107e4c7 Sat Aug 8 04:54:46 2026 +0300 Yauhen Sampir [cronet_http] Add DNS configuration options to CronetEngine.build (dart-lang/http#1945) 55c39c9 Sat Aug 8 07:57:20 2026 +0800 Seven Du Fix RFC 850 two-digit year parsing (dart-lang/http#1951) c71cb6d Sat Aug 8 01:47:35 2026 +0200 Moritz Add ecosystem groundskeeper workflow (dart-lang/http#1959) test (https://github.com/dart-lang/test/compare/dd426d4..55b186d): 55b186dd Mon Aug 10 22:18:01 2026 +0200 Sigurd Meldgaard Fix race conditions in Chrome coverage collection (dart-lang/test#2715) 51463b0e Mon Aug 10 21:59:15 2026 +0300 Yusuf İhsan Görgel Keep the browser executable env override through a settings merge (dart-lang/test#2722) b87a2492 Fri Aug 7 12:07:52 2026 -0700 Jacob MacDonald Enable asserts (dart-lang/test#2719) tools (https://github.com/dart-lang/tools/compare/f3ec9ed..d644cda): d644cdab Mon Aug 10 11:24:43 2026 +0200 Sigurd Meldgaard [pub_semver] Parse only pure-digit prerelease/build identifiers as integers (dart-lang/tools#2489) df06fed9 Fri Aug 7 15:37:45 2026 -0700 Nate Bosch Update to Dart 3.10.0 and reformat (dart-lang/tools#2502) aec21dae Fri Aug 7 14:23:11 2026 -0700 Nate Bosch [code_builder] Minor style fixes (dart-lang/tools#2501) 1bbcc309 Fri Aug 7 13:56:38 2026 -0700 Nate Bosch Revert "[code_builder] Add control-flow support (`#2135`)" (dart-lang/tools#2499) 77607740 Fri Aug 7 01:59:58 2026 +0530 Aman Maurya Fix MultiChannel inner channel type constraint documentation (dart-lang/tools#2491) 889787a8 Thu Aug 6 12:56:22 2026 -0700 Nate Bosch Roll to the latest package:csv (dart-lang/tools#2497) [email protected] Change-Id: I4cb9a8839c9ae21c57eca7750c81fdbd1a58a09c Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/534341 Auto-Submit: Nate Bosch <[email protected]> Reviewed-by: Kevin Moore <[email protected]> Commit-Queue: Kevin Moore <[email protected]>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Reapplies some of the unrelated style cleanups that had originally
landed in #2135 and were reverted in #2499