Skip to content
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

Conversation

OssamaSijbesma
Copy link

@OssamaSijbesma OssamaSijbesma commented Sep 7, 2023

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:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

  1. Added logging to the preset.ts and vue-docgen.ts.
  2. Run a sandbox for template, e.g. yarn task --task sandbox --start-from auto --template vue3-vite/default-ts.
  3. Change the main.ts options (repeatedly based on those options: https://vue-styleguidist.github.io/docs/Docgen.html#api)
  4. Checked if the variables are passed correctly and output.

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/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>

@JReinhold
Copy link
Contributor

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?

@kasperpeulen
Copy link
Contributor

cc @chakAs3

@chakAs3
Copy link
Contributor

chakAs3 commented Sep 15, 2023

Yes there is already a PR opened addressing docgen, as @JReinhold said we moving to the official Vue language tools.
@kasperpeulen i will be checking the performance issue on the code transform, so we can merge it next week.

Copy link
Contributor

@chakAs3 chakAs3 left a 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

@ndelangen
Copy link
Member

Does this do the same as this PR: #22153

Or should we continue to have both?
WDYT @chakAs3 @OssamaSijbesma @JReinhold ?

@ndelangen
Copy link
Member

Please re-open if indeed relevant.

@ndelangen ndelangen closed this Nov 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: Ability to pass vueDocgenOptions into vue3-vite framework options
6 participants