search

enzonotario / vitepress-openapi

Generate VitePress API Docs from OpenAPI specifications
https://vitepress-openapi.vercel.app
MIT License
54 stars 9 forks source link

provide/inject for better performance #90

Closed enzonotario closed 1 month ago

enzonotario commented 1 month ago

Description

Use provide/inject to re-use already parsed Specs, for better performance

Related issues/external references

65

Types of changes

vercel[bot] commented 1 month ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
vitepress-openapi ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 16, 2024 10:13pm
coderabbitai[bot] commented 1 month ago

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough

The changes in this pull request enhance the integration and configuration of the OpenAPI instance within a VitePress project. The enhanceApp method in the theme files has been refactored to streamline the initialization of the OpenAPI instance. Documentation updates reflect these changes, including new sections on configuring the OpenAPI specification and utilizing custom slots in components. Additionally, the method of obtaining the OpenAPI instance has been standardized across various components, and new helper functions have been introduced to improve organization.

Changes

File Change Summary
dev/.vitepress/theme/index.ts Refactored enhanceApp method to initialize OpenAPI with { spec } and provide it to the app context. Removed i18n configuration.
docs/.vitepress/theme/index.ts Updated enhanceApp method to simplify OpenAPI setup by passing spec directly to useOpenapi and providing it to the app context. Removed i18n configuration.
docs/guide/getting-started.md Updated documentation to include new section on configuring OpenAPI specification, with emphasis on using app.provide for context availability.
docs/layouts/custom-slots.md Added section on custom slots for OAOperation component, referencing an external example file.
docs/layouts/parts/custom-slots-example.md New file demonstrating the use of custom slots in Vue components with OAOperation.
src/components/Common/OAInfo.vue Updated OpenAPI instantiation to use getOpenApiInstance with injected OpenAPI context.
src/components/Common/OAServers.vue Updated OpenAPI instantiation to use getOpenApiInstance with injected OpenAPI context.
src/components/Path/OAPath.vue Updated OpenAPI instantiation to use getOpenApiInstance with injected OpenAPI context.
src/components/Path/OAPathsByTags.vue Enhanced to optionally receive an array of tags.
src/composables/useOpenapi.ts Introduced setupOpenApi function to encapsulate OpenAPI initialization logic.
src/lib/getOpenApiInstance.ts New file that defines getOpenApiInstance function for retrieving OpenAPI instances based on custom and injected parameters.
src/lib/OpenApi.ts Modified to ensure it returns an empty object instead of undefined when no paths are present.
package.json Updated peer dependencies for vue and vitepress, reflecting version changes.
vite.config.ts Modified to treat both vue and vitepress as external dependencies during the build process.
src/locales/en.json Added new localization key for "Default".
src/locales/es.json Added new localization key for "Default".

Possibly related PRs

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
pkg-pr-new[bot] commented 1 month ago

Open in Stackblitz

pnpm add https://pkg.pr.new/vitepress-openapi@90
pnpm add https://pkg.pr.new/vitepress-openapi@90

commit: a32ba0b