Allow setting of custom sidebase URL prefix

addshore commented 3 weeks ago

Fixes #38

Summary by CodeRabbit

Nuevas Funciones
- Se ha mejorado la flexibilidad de generación de elementos y grupos en la barra lateral con un prefijo de enlace personalizable.
- Los elementos de la barra lateral ahora pueden utilizar un prefijo de enlace dinámico, mejorando la adaptabilidad a diferentes estructuras de enrutamiento.

vercel[bot] commented 3 weeks ago

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

Name	Status	Preview	Comments	Updated (UTC)
vitepress-theme-openapi	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Sep 16, 2024 10:22am

coderabbitai[bot] commented 3 weeks ago

Walkthrough

Los cambios realizados en la función useSidebar permiten una mayor flexibilidad en la generación de elementos y grupos del sidebar al introducir un prefijo de enlace personalizable. Se ha modificado la forma en que se generan los enlaces para cada operación, permitiendo que el prefijo se ajuste según el contexto. Esto se logra mediante la adición de un parámetro linkPrefix en las funciones generateSidebarItem, generateSidebarGroup y generateSidebarGroups, manteniendo la compatibilidad con el comportamiento predeterminado existente.

Changes

Archivos	Resumen de cambios
`src/composables/useSidebar.ts`	Se modificaron las funciones `generateSidebarItem`, `generateSidebarGroup` y `generateSidebarGroups` para aceptar un parámetro adicional `linkPrefix`, que permite la personalización de los enlaces generados. Se estableció un valor predeterminado para este prefijo y se mantuvo la lógica existente.

Assessment against linked issues

Objetivo	Abordado	Explicación
Personalizar el enlace del elemento del menú del sidebar (38)	✅
Permitir enlaces a diferentes especificaciones bajo diferentes prefijos de URL (38)	✅

Recent review details

**Configuration used: CodeRabbit UI** **Review profile: ASSERTIVE**

Commits

Files that changed from the base of the PR and between d408e4e06b622b23a8a2d8d7f981883474eb9f7d and 849c5aa4ed9b10fbe9c58cdb1bf14ff4054dd82a.

Files selected for processing (1)

* src/composables/useSidebar.ts (4 hunks)

Additional comments not posted (3)

src/composables/useSidebar.ts (3)
Line range hint `8-24`: **¡Buen trabajo! Los cambios en la función `generateSidebarItem` mejoran la flexibilidad.** La adición del parámetro `linkPrefix` con un valor predeterminado permite generar enlaces de elementos de la barra lateral personalizados sin afectar el comportamiento existente. Esto facilita la adaptación de la barra lateral a diferentes estructuras de URL manteniendo la compatibilidad hacia atrás. --- Line range hint `26-51`: **¡Excelente! La función `generateSidebarGroup` ahora acepta un prefijo de enlace personalizado.** Al pasar el parámetro `linkPrefix` a la función `generateSidebarItem`, se asegura que todos los elementos de la barra lateral generados dentro de un grupo utilicen el mismo prefijo de enlace. Esto mejora la coherencia y flexibilidad en la generación de enlaces para los grupos de la barra lateral. --- Line range hint `53-69`: **¡Fantástico! La función `generateSidebarGroups` propaga el prefijo de enlace a todos los grupos.** Al pasar el parámetro `linkPrefix` a las llamadas de `generateSidebarGroup`, se garantiza que todos los grupos de la barra lateral y sus elementos internos utilicen el mismo prefijo de enlace. Esto mejora la coherencia y adaptabilidad de la estructura general de la barra lateral a diferentes esquemas de URL.

--- 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 generate interesting stats about this repository and render them as a table.` -- `@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](https://discord.com/invite/GsXnASn26c) 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 3 weeks ago

Open in Stackblitz

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

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

commit: 849c5aa

enzonotario commented 3 weeks ago

Hi @addshore , thanks for working on this, however I think we have to be prepared for eventually more customizations, like to generate sidebar items for specific tags, with specific linkPrefix, and so on...

So, I've made another PR #44 that implements it via object args. It allows to globally configure a linkPrefix, or to override it in generateSidebarGroups.

Can you please check it and evaluate if is a better alternative? In that case, we will close this PR in favor of #44 .

enzonotario / vitepress-openapi