fix: Fixes an invalid link for security schemes when using the Astro base option

[taiseimiyaji]

Closes #54

Thank you for maintaining and contributing to this amazing repository. It has been incredibly helpful for our project, and I truly appreciate the effort that goes into its development.

Please note that English is not my first language, so I apologize if any part of this pull request or issue report seems unnatural or unclear. I hope the provided details are sufficient, and I’m happy to clarify or adjust anything if needed.

Describe the pull request

This pull request fixes an issue where the base configuration in Astro was not applied to the security component. Specifically, links generated by the security component did not include the base prefix, leading to incorrect or broken links.

The changes ensure that the base configuration is consistently applied to all generated links.

Why

These changes are necessary to ensure that:

1. The base configuration in Astro is respected across all components, including security.
2. Links generated by the security component work correctly, even when the base configuration is specified.
3. The application behaves as expected in environments where the base path is configured (e.g., hosted in subdirectories).
   Without this fix, links generated by the security component fail in environments where a base configuration is required.

How

The changes were implemented as follows:

1. Introduced logic to handle import.meta.env.BASE_URL, trimming any trailing slash to avoid double slashes when concatenating paths.
2. Updated the href attribute in the security component to prepend BASE_URL to the existing link path.
3. Ensured the changes are backward-compatible by handling cases where BASE_URL is undefined or empty.
   The key code modification:

const baseURL = (import.meta.env.BASE_URL || '').replace(/\/$/, ''); // Trim trailing slash or fallback to empty
Updated the link generation logic:

<a href={`${baseURL}${getBaseLink(schema.config)}#${slug(scheme)}`}>{scheme}</a>

This ensures that links are always prefixed correctly, regardless of the presence or value of BASE_URL.

issue: #54

[vercel]

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

Name	Status	Preview	Comments	Updated (UTC)
starlight-openapi	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Nov 27, 2024 10:05am

[HiDeoo]

Thanks for your contribution 🙌

It has been incredibly helpful for our project, and I truly appreciate the effort that goes into its development.

Thanks a lot, happy to hear that!

Please note that English is not my first language, so I apologize if any part of this pull request or issue report seems unnatural or unclear. I hope the provided details are sufficient, and I’m happy to clarify or adjust anything if needed.

No need to apologize, your English is great and the details you provided are very clear. Thanks for the PR.

I took the liberty to move out the logic in a reusable function so we can in the future use it in other places as well as this is a common pattern in Astro integrations/Starlight plugins and we can release your fix as soon as possible.

Amazing work 🎉