Sync config-file-options documentation with schema.json and source code - #1683
Sync config-file-options documentation with schema.json and source code#1683bluwy merged 2 commits into
Conversation
Sorry, something went wrong.
⚠️ No Changeset foundLatest commit: d9b3081 Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset. This PR includes no changesetsWhen changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types Click here to learn what changesets are, and how to add one. Click here if you're a maintainer who wants to add a changeset to this PR |
Sorry, something went wrong.
Codecov Report✅ All modified and coverable lines are covered by tests. @@ Coverage Diff @@
## main #1683 +/- ##
=======================================
Coverage 81.05% 81.05%
=======================================
Files 54 54
Lines 2264 2264
Branches 679 684 +5
=======================================
Hits 1835 1835
Misses 424 424
Partials 5 5 ☔ View full report in Codecov by Sentry.
|
Sorry, something went wrong.
| "linked": [], | ||
| "access": "restricted", | ||
| "baseBranch": "main", | ||
| "baseBranch": "master", |
There was a problem hiding this comment.
I guess this should be updated to main in the source code at some point, but this would be a major change 🤔
Sorry, something went wrong.
| ```json | ||
| { | ||
| "changelog": "@changesets/cli/changelog", | ||
| "commit": false, | ||
| "fixed": [], | ||
| "linked": [], |
There was a problem hiding this comment.
The JSON shows the default config from changeset init, hence baseBranch default is "main" here. But personally I'm fine with converting this to show the defaults in general.
Sorry, something went wrong.
…-short-hand-git-tag
Like #1649, I run my changeset version command via yarn dlx and started getting an issue with my prettier preset not being installed. The prettier config should be documented in the config-file-options.md file so users don't need to dive into multiple issues and PRs.
I took the liberty to also document the other remaining missing configs and updating the "default config" example at the top of the file.