fix: config schema descriptions#397
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR improves the CLI config schema usability (IDE autocomplete/hover) by adding missing option descriptions, documents how to enable schema downloads in IDEs, and fixes the CLI package’s schema-generation script by adding a missing prettier devDependency.
Changes:
- Add
prettierto@callstack/brownfield-clidevDependencies to supportgenerate:schema. - Add/propagate descriptions for config options in TypeScript types and the generated
schema.json. - Document IDE setup for trusting/downloading the remote JSON schema URL; add a changeset for a patch release.
Reviewed changes
Copilot reviewed 5 out of 6 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| yarn.lock | Adds the lockfile entry for prettier after introducing it as a devDependency. |
| packages/cli/package.json | Adds prettier devDependency used by generate:schema. |
| packages/cli/src/types.ts | Adds JSDoc descriptions intended to feed schema generation / docs. |
| packages/cli/schema.json | Adds descriptions to key top-level config fields and Brownie options. |
| docs/docs/docs/api-reference/configuration.mdx | Documents IDE settings needed to download the schema from oss.callstack.com. |
| .changeset/young-snails-lose.md | Declares a patch release for @callstack/brownfield-cli. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
hurali97
approved these changes
Jun 24, 2026
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.
Summary
PR:
prettierbinary missing in some scripts due to missing devDep in cli packageTest plan