feat: add header for multi component md

[elevatebart]

and also accept require tag from jsdoc

[changeset-bot]

🦋 Changeset detected

Latest commit: b68c9bd

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

This PR includes changesets to release 2 packages

Name	Type
vue-docgen-cli	Minor
vue-docgen-api	Minor

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

[what-the-diff]

PR Summary

• Addition of Header Template and Its Import Statements
  A new template called 'header' was developed and included in the codebase. Import statements were added in various files like 'compileTemplates.ts', 'extractConfig.ts', and 'component.ts' to ensure its functionality and accessibility.

• Updated Configurations with Header Function
  The 'config.ts' file now includes a 'header' function which can process components documentation. This improves the way our code is organized, increasing maintainability.

• New Test Configurations and Improved Testing
  The test configurations have been enhanced to account for the new 'header' feature. This included additions in two specific files, 'multiMd.spec.ts' and 'singleMd.spec.ts', which guarantees that the changes are tested for functionality. Also, a new 'tsconfig.test.json' file was added to further solidify our test environment.

• Introduction of resolveRequiresFromTag Function
  A new function named 'resolveRequiresFromTag' has been introduced and implemented in the 'utils.ts' and 'utils.spec.ts' files. This function aids in resolving the needs from a particular tag, improving code functionality and consistency.

• Updating of Component File
  The 'component.ts' file was updated to reflect the incorporation of the 'header' template, enhancing the structure and functionality of the components in our application.

The above changes are expected to enhance our code's organization, maintainability, and testability while improving overall application functionality.

[cypress]

Passing run #617 ↗︎

0

57

0

0

0

Details:

add another changeset
Project: vue-styleguidist	Commit: b68c9bd11d
Status: Passed	Duration: 15:30 💡
Started: Mar 21, 2024 9:41 PM	Ended: Mar 21, 2024 9:57 PM

Review all test suite changes for PR #1651 ↗︎