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 intochangesets:mainfrom
Conversation
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ 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. 🚀 New features to boost your workflow:
|
| "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 🤔
| ```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.
…-short-hand-git-tag
Like #1649, I run my
changeset versioncommand viayarn dlxand started getting an issue with my prettier preset not being installed. Theprettierconfig should be documented in theconfig-file-options.mdfile 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.