Repository: enzonotario/vitepress-openapi
Pull request #159 (2025-01-23 17:02:14)

chore(docs): resolve.alias

vercel[bot]: [vc]: #5qTo6UBhNdRFsaxW1EOgiKRRHTtP6k1DBLmWahT05Wk=:eyJpc01vbm9yZXBvIjp0cnVlLCJ0eXBlIjoiZ2l0aHViIiwicHJvamVjdHMiOlt7Im5hbWUiOiJ2aXRlcHJlc3Mtb3BlbmFwaSIsImxpdmVGZWVkYmFjayI6eyJyZXNvbHZlZCI6MCwidW5yZXNvbHZlZCI6MCwidG90YWwiOjAsImxpbmsiOiIifSwiaW5zcGVjdG9yVXJsIjoiaHR0cHM6Ly92ZXJjZWwuY29tL2Vuem8tbm90YXJpb3MtcHJvamVjdHMvdml0ZXByZXNzLW9wZW5hcGkvQWZ3aHRZNzlSclBWWm1NcVNqUnN6QUJCVUJITCIsInByZXZpZXdVcmwiOiIiLCJuZXh0Q29tbWl0U3RhdHVzIjoiRkFJTEVEIn1dfQ==
**The latest updates on your projects**. Learn more about [Vercel for Git ↗︎](https://vercel.link/github-learn-more)

| Name | Status | Preview | Comments | Updated (UTC) |
| :--- | :----- | :------ | :------- | :------ |
| **vitepress-openapi** | ❌ Failed ([Inspect](https://vercel.com/enzo-notarios-projects/vitepress-openapi/AfwhtY79RrPVZmMqSjRszABBUBHL)) |  |  | Jan 23, 2025 5:02pm |


coderabbitai[bot]: <!-- This is an auto-generated comment: summarize by coderabbit.ai -->
<!-- This is an auto-generated comment: review in progress by coderabbit.ai -->

> [!NOTE]
> Currently processing new changes in this PR. This may take a few minutes, please wait...
> 
> <details>
> <summary>📥 Commits</summary>
> 
> Reviewing files that changed from the base of the PR and between 89836dcca0f43058fae8fd2324fa33619c10f208 and 3670f3ece5d30d748ee75c0a32605386caa17a24.
> 
> </details>
> 
> <details>
> <summary>📒 Files selected for processing (5)</summary>
> 
> * `docs/.vitepress/config.mts` (2 hunks)
> * `src/components/Path/OAPathsSummary.vue` (2 hunks)
> * `src/composables/useSidebar.ts` (1 hunks)
> * `test/composables/useSidebar.itemsByTags.test.ts` (1 hunks)
> * `test/composables/useSidebar.test.ts` (0 hunks)
> 
> </details>
> 
> ```ascii
>  _____________________________________________________
> < The fifth dentist recommends we all floss our code. >
>  -----------------------------------------------------
>   \
>    \   (\__/)
>        (•ㅅ•)
>        / 　 づ
> ```

<!-- end of auto-generated comment: review in progress by coderabbit.ai -->

<!-- usage_tips_start -->

> [!TIP]
> <details>
> <summary>CodeRabbit can enforce grammar and style rules using `languagetool`.</summary>
> 
> Configure `languagetool` in your project's settings in CodeRabbit enable/disable rules and categories. Refer to the [LanguageTool Community](https://community.languagetool.org/rule/list) to learn more.
> 
> </details>

<!-- usage_tips_end -->
<!-- tips_start -->

---

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?

<details>
<summary>❤️ Share</summary>

- [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)

</details>

<details>
<summary>🪧 Tips</summary>

### 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 <commit_id>, 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 generate docstrings` to [generate docstrings](https://docs.coderabbit.ai/finishing-touches/docstrings) for this PR. ([Beta](https://docs.coderabbit.ai/early-access#beta))
- `@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://docs.coderabbit.ai) 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.

</details>

<!-- tips_end -->
pkg-pr-new[bot]: 
[Open in Stackblitz](https://pkg.pr.new/template/2f4932b8-a4c9-4828-acb7-6fbcd7fef5da)


```
npm i https://pkg.pr.new/vitepress-openapi@159
```


_commit: <a href="https://github.com/enzonotario/vitepress-openapi/runs/36074835827"><code>3670f3e</code></a>_


Patch:
diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts
index 1db7170..3965e5e 100644
--- a/docs/.vitepress/config.mts
+++ b/docs/.vitepress/config.mts
@@ -1,7 +1,8 @@
+import { fileURLToPath } from 'node:url'
 import { useSidebar } from 'vitepress-openapi'
 import { defineConfigWithTheme } from 'vitepress'
-import spec from '../public/openapi.json' assert { type: 'json' }
 import { examplesPages } from '../pages'
+import spec from '../public/openapi.json' assert {type: 'json'}
 
 const sidebar = useSidebar({
   spec,
@@ -234,4 +235,17 @@ export default defineConfigWithTheme({
       gtag('config', '${gaId}');`,
     ],
   ],
+  vite: {
+    resolve: {
+      alias: {
+        ...(process.env.NODE_ENV === 'production'
+          ? {}
+          : {
+              'vitepress-openapi/client': fileURLToPath(new URL('../../src/client', import.meta.url)),
+              'vitepress-openapi/dist/style.css': fileURLToPath(new URL('../../src/style.css', import.meta.url)),
+              'vitepress-openapi': fileURLToPath(new URL('../../src/index', import.meta.url)),
+            }),
+      },
+    },
+  },
 })
diff --git a/src/components/Path/OAPathsSummary.vue b/src/components/Path/OAPathsSummary.vue
index 6b8852b..759ee94 100644
--- a/src/components/Path/OAPathsSummary.vue
+++ b/src/components/Path/OAPathsSummary.vue
@@ -9,7 +9,7 @@ const { paths } = defineProps({
 })
 
 const emit = defineEmits([
-  'path-click',
+  'pathClick',
 ])
 </script>
 
@@ -30,7 +30,7 @@ const emit = defineEmits([
         v-for="method in Object.keys(paths[path])"
         :key="`${path}-${method}`"
         class="grid grid-cols-[4rem,1fr] items-center gap-2 !text-foreground !no-underline cursor-pointer"
-        @click="emit('path-click', `#${paths[path][method].operationId}`)"
+        @click="emit('pathClick', `#${paths[path][method].operationId}`)"
       >
         <span :class="[`text-method-${method}`]" class="text-sm text-right">
           {{ method.toUpperCase() }}
diff --git a/src/composables/useSidebar.ts b/src/composables/useSidebar.ts
index 3d6947f..cfec9ad 100644
--- a/src/composables/useSidebar.ts
+++ b/src/composables/useSidebar.ts
@@ -64,6 +64,7 @@ export function useSidebar({
         spec,
         transformedSpec: prepareOpenAPI({
           spec,
+          defaultTag,
         }),
       })
     }


Test patch:
diff --git a/test/composables/useSidebar.itemsByTags.test.ts b/test/composables/useSidebar.itemsByTags.test.ts
new file mode 100644
index 0000000..d3d5918
--- /dev/null
+++ b/test/composables/useSidebar.itemsByTags.test.ts
@@ -0,0 +1,52 @@
+import { describe, expect, it } from 'vitest'
+import { useSidebar } from '../../src/composables/useSidebar'
+import { spec } from '../testsConstants'
+
+describe('itemsByTags', () => {
+  const sidebar = useSidebar({ spec })
+
+  it('returns the correct items for given tags', () => {
+    const result = sidebar.itemsByTags({ tags: ['users', 'pets'] })
+    expect(result).toEqual([
+      { text: 'users', link: '/tags/users' },
+      { text: 'pets', link: '/tags/pets' },
+    ])
+  })
+
+  it('returns the correct items with a custom linkPrefix', () => {
+    const result = sidebar.itemsByTags({ tags: ['users', 'pets'], linkPrefix: '/custom/' })
+    expect(result).toEqual([
+      { text: 'users', link: '/custom/users' },
+      { text: 'pets', link: '/custom/pets' },
+    ])
+  })
+
+  it('returns the correct items when no tags are provided', () => {
+    const result = sidebar.itemsByTags()
+    expect(result).toEqual([
+      { text: 'users', link: '/tags/users' },
+      { text: 'pets', link: '/tags/pets' },
+    ])
+  })
+})
+
+describe('itemsByTags with defaultTag', () => {
+  const sidebar = useSidebar({
+    spec: {
+      openapi: '3.0.0',
+      paths: {
+        '/example': {
+          get: {},
+        },
+      },
+    },
+    defaultTag: 'Custom',
+  })
+
+  it('returns the correct items for the default tag', () => {
+    const result = sidebar.itemsByTags()
+    expect(result).toEqual([
+      { text: 'Custom', link: '/tags/Custom' },
+    ])
+  })
+})
diff --git a/test/composables/useSidebar.test.ts b/test/composables/useSidebar.test.ts
index ae29c38..028cd2d 100644
--- a/test/composables/useSidebar.test.ts
+++ b/test/composables/useSidebar.test.ts
@@ -153,30 +153,3 @@ describe('useSidebar with linkPrefix', () => {
   })
 })
 
-describe('itemsByTags', () => {
-  const sidebar = useSidebar({ spec })
-
-  it('returns the correct items for given tags', () => {
-    const result = sidebar.itemsByTags({ tags: ['users', 'pets'] })
-    expect(result).toEqual([
-      { text: 'users', link: '/tags/users' },
-      { text: 'pets', link: '/tags/pets' },
-    ])
-  })
-
-  it('returns the correct items with a custom linkPrefix', () => {
-    const result = sidebar.itemsByTags({ tags: ['users', 'pets'], linkPrefix: '/custom/' })
-    expect(result).toEqual([
-      { text: 'users', link: '/custom/users' },
-      { text: 'pets', link: '/custom/pets' },
-    ])
-  })
-
-  it('returns the correct items when no tags are provided', () => {
-    const result = sidebar.itemsByTags()
-    expect(result).toEqual([
-      { text: 'users', link: '/tags/users' },
-      { text: 'pets', link: '/tags/pets' },
-    ])
-  })
-})