-
-
Notifications
You must be signed in to change notification settings - Fork 9.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: Added vue docgen options for vite builds #24098
feat: Added vue docgen options for vite builds #24098
Conversation
Thanks for this! We're thinking about migration Vue docgen to Volar, how does this relate to that? Is this related/compatible with that, or is this different? |
cc @chakAs3 |
Yes there is already a PR opened addressing docgen, as @JReinhold said we moving to the official Vue language tools. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @OssamaSijbesma I'm suggestion to open an other PR after merging #22285, please check it out and see if you think the PR still relevant, so we can workout the merge
Does this do the same as this PR: #22153 Or should we continue to have both? |
Please re-open if indeed relevant. |
Closes #22909
What I did
I added the possibility to configure the vue docgen options for advanced usage in Vite. For example for monorepo file aliases for docs.
Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
preset.ts
andvue-docgen.ts
.yarn task --task sandbox --start-from auto --template vue3-vite/default-ts
.Documentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal
,ci:merged
orci:daily
GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli/src/sandbox-templates.ts
Make sure this PR contains one of the labels below:
Available labels
bug
: Internal changes that fixes incorrect behavior.maintenance
: User-facing maintenance tasks.dependencies
: Upgrading (sometimes downgrading) dependencies.build
: Internal-facing build tooling & test updates. Will not show up in release changelog.cleanup
: Minor cleanup style change. Will not show up in release changelog.documentation
: Documentation only changes. Will not show up in release changelog.feature request
: Introducing a new feature.BREAKING CHANGE
: Changes that break compatibility in some way with current major version.other
: Changes that don't fit in the above categories.🦋 Canary release
This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the
@storybookjs/core
team here.core team members can create a canary release here or locally with
gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>