feature: Optionally omit generated description comments in output
#720
Conversation
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
kevmoo
requested changes
Sep 21, 2024
There was a problem hiding this comment.
You'll want to add a changelog entry for this, please. Since it's adding a feature, it'll be a minor version per https://semver.org/
jakemac53
reviewed
Sep 23, 2024
jakemac53
reviewed
Sep 23, 2024
Co-authored-by: Jacob MacDonald <[email protected]>
…elds. Corrected writeDescriptions=false test to catch specific values, both with and without a header present. Added an additional test to sanity check when writeDescriptions=true.
jakemac53
reviewed
Sep 24, 2024
…eature into it and removing the bumped version 2.0.1-wip.
jakemac53
approved these changes
Sep 24, 2024
kevmoo
approved these changes
Sep 24, 2024
TheMaverickProgrammer
deleted the
feature/no_preamble_no_comment@mav
branch
mosuem
pushed a commit
to dart-lang/build
that referenced
this pull request
Dec 10, 2024
…art-lang/source_gen#720) Related: dart-lang/source_gen#706. This PR adds an optional `bool? writesDescriptions` field to the `_Builder` base class constructor. By default, it is `true`, but if explicitly set to `false`, the generated description comments will not be included in the generated output. See related link for my use-case. This will be useful so that _any_ file can be generated with this tool for Dart.
mosuem
pushed a commit
to dart-lang/build
that referenced
this pull request
Dec 10, 2024
…art-lang/source_gen#720) Related: dart-lang/source_gen#706. This PR adds an optional `bool? writesDescriptions` field to the `_Builder` base class constructor. By default, it is `true`, but if explicitly set to `false`, the generated description comments will not be included in the generated output. See related link for my use-case. This will be useful so that _any_ file can be generated with this tool for Dart.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Related: #706.
This PR adds an optional
bool? writesDescriptionsfield to the_Builderbase class constructor.By default, it is
true, but if explicitly set tofalse, the generated description comments will not be includedin the generated output.
See related link for my use-case. This will be useful so that any file can be generated with this tool for Dart.
Checklist