Add description property to wireit script configs#1392
Open
RodrigoHamuy wants to merge 1 commit intogoogle:mainfrom
Open
Add description property to wireit script configs#1392RodrigoHamuy wants to merge 1 commit intogoogle:mainfrom
RodrigoHamuy wants to merge 1 commit intogoogle:mainfrom
Conversation
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
Adds an optional `description` string field to wireit script configurations, allowing developers to document what each script does. - schema.json: adds `description` property with markdownDescription for IDE autocomplete/hover support - src/config.ts: adds `description: string | undefined` to BaseScriptConfig - src/analyzer.ts: adds #processDescription() method and wires it into script config parsing - src/test/json-schema.test.ts: adds test cases for valid/invalid values - src/test/util/package-json.ts: adds description to test PackageJson type Closes google#1015
9536095 to
ab711f1
Compare
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.
Fixes #1015.
Summary
Adds an optional
description: stringfield to wireit script configurations, allowing developers to document what each script does.markdownDescriptionfor IDE autocomplete/hover supportBaseScriptConfiginterface updatedUsage