Skip to content

fix: config schema descriptions#397

Merged
artus9033 merged 5 commits into
mainfrom
fix/config-schema
Jun 24, 2026
Merged

fix: config schema descriptions#397
artus9033 merged 5 commits into
mainfrom
fix/config-schema

Conversation

@artus9033

Copy link
Copy Markdown
Collaborator

Summary

PR:

Test plan

@artus9033 artus9033 requested a review from hurali97 June 24, 2026 12:10
@artus9033 artus9033 self-assigned this Jun 24, 2026
Copilot AI review requested due to automatic review settings June 24, 2026 12:10
@artus9033 artus9033 changed the title Fix/config schema fix: config schema descriptions Jun 24, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 prettier to @callstack/brownfield-cli devDependencies to support generate: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.

Comment thread packages/cli/schema.json
Comment thread packages/cli/schema.json
Comment thread packages/cli/schema.json
@artus9033 artus9033 merged commit 4088c01 into main Jun 24, 2026
15 of 16 checks passed
@artus9033 artus9033 deleted the fix/config-schema branch June 24, 2026 16:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants