Skip to content

bug in prop type detection of vue docgen api 4791 #1679

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

Merged

Conversation

elevatebart
Copy link
Member

closes #1678

@elevatebart elevatebart linked an issue Jul 31, 2024 that may be closed by this pull request
Copy link

changeset-bot bot commented Jul 31, 2024

🦋 Changeset detected

Latest commit: eeb4c24

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
vue-docgen-api Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@elevatebart elevatebart self-assigned this Jul 31, 2024
@elevatebart elevatebart enabled auto-merge (squash) July 31, 2024 19:28
Copy link

what-the-diff bot commented Jul 31, 2024

PR Summary

  • Added a new Instruction File
    The team added a new '.changeset/neat-jobs-think.md' file which provides instructions for the 'vue-docgen-api'. It also includes a bug fix that makes the tool more reliable when working with what is known as interface extensions.

  • Modified Test File for Better Verification
    In the file 'tsUtils.test.ts', a new structure called 'AnotherInterface' was added along with new properties. This was done to improve the accuracy and scope of testing our software.

  • Improved Descriptions in Test Cases
    The descriptions within the test case files for interfaces and type resolution have been updated. This makes it clearer to understand what the test cases are doing, aiding any new or old developer in their understanding.

  • Better Code Condition Check
    The team improved a specific part of the code, 'getTypeDefinitionFromIdentifier', to check conditions more efficiently. This makes sure that the functionality only processes valid information, thus increasing reliability.

@elevatebart elevatebart merged commit 8a2ec6f into dev Jul 31, 2024
11 checks passed
@elevatebart elevatebart deleted the 1678-bug-in-prop-type-detection-of-vue-docgen-api-4791 branch July 31, 2024 19:46
Copy link

cypress bot commented Jul 31, 2024



Test summary

57 0 0 0


Run details

Project vue-styleguidist
Status Passed
Commit eeb4c24
Started Jul 31, 2024 7:32 PM
Ended Jul 31, 2024 7:48 PM
Duration 16:41 💡
OS Linux Debian -
Browser Electron 118

View run in Cypress Cloud ➡️


This comment has been generated by cypress-bot as a result of this project's GitHub integration settings. You can manage this integration in this project's settings in the Cypress Cloud

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.

Bug in prop type detection of vue-docgen-api 4.79.1
1 participant