Repository: enzonotario/vitepress-openapi
Pull request #114 (2024-11-03 03:12:22)

feat(useTheme): add `defaultTagDescription` config
<!-- Provide a general summary of your changes in the title above. -->

# Description

Allows to specify `description` for Default Tag.

## Related issues/external references

#109

## Types of changes

- New feature

vercel[bot]: [vc]: #yNi6BKLL9NYZ0d4hppWRwhl+OXohiWkmEa0kR+KBmGc=:eyJpc01vbm9yZXBvIjp0cnVlLCJ0eXBlIjoiZ2l0aHViIiwicHJvamVjdHMiOlt7Im5hbWUiOiJ2aXRlcHJlc3Mtb3BlbmFwaSIsImxpdmVGZWVkYmFjayI6eyJyZXNvbHZlZCI6MCwidW5yZXNvbHZlZCI6MCwidG90YWwiOjAsImxpbmsiOiJ2aXRlcHJlc3Mtb3BlbmFwaS1naXQtZmVhdHVyZS1kZWZhdWx0dGFnLWVuem8tbm90YXJpb3MtcHJvamVjdHMudmVyY2VsLmFwcCJ9LCJpbnNwZWN0b3JVcmwiOiJodHRwczovL3ZlcmNlbC5jb20vZW56by1ub3Rhcmlvcy1wcm9qZWN0cy92aXRlcHJlc3Mtb3BlbmFwaS82c3J0Vk1UUWlhelNHcm51YjZ1cm9xaVQzWHREIiwicHJldmlld1VybCI6InZpdGVwcmVzcy1vcGVuYXBpLWdpdC1mZWF0dXJlLWRlZmF1bHR0YWctZW56by1ub3Rhcmlvcy1wcm9qZWN0cy52ZXJjZWwuYXBwIiwibmV4dENvbW1pdFN0YXR1cyI6IkRFUExPWUVEIn1dfQ==
**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** | ✅ Ready ([Inspect](https://vercel.com/enzo-notarios-projects/vitepress-openapi/6srtVMTQiazSGrnub6uroqiT3XtD)) | [Visit Preview](https://vercel.live/open-feedback/vitepress-openapi-git-feature-defaulttag-enzo-notarios-projects.vercel.app?via=pr-comment-visit-preview-link&passThrough=1) | 💬 [**Add feedback**](https://vercel.live/open-feedback/vitepress-openapi-git-feature-defaulttag-enzo-notarios-projects.vercel.app?via=pr-comment-feedback-link) | Nov 3, 2024 3:12am |


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 30f550a7af3e12f6158f65d39d608834c0a1e499 and 3dc44b5c44e47fa28e9415a58c198631dd531dcf.
> 
> </details>
> 
> <details>
> <summary>📒 Files selected for processing (6)</summary>
> 
> * `docs/.vitepress/config.mts` (1 hunks)
> * `src/composables/useTheme.ts` (3 hunks)
> * `src/lib/OpenApi.ts` (9 hunks)
> * `src/lib/generateMissingTags.ts` (1 hunks)
> * `test/composables/openapi.test.ts` (1 hunks)
> * `test/composables/useTheme.test.ts` (2 hunks)
> 
> </details>
> 
> ```ascii
>  ________________________________
> < My GPUs mine bugs, not Crypto. >
>  --------------------------------
>   \
>    \   (\__/)
>        (•ㅅ•)
>        / 　 づ
> ```

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

<!-- 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 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.

</details>

<!-- tips_end -->
pkg-pr-new[bot]: 
[Open in Stackblitz](https://pkg.pr.new/template/9cf4630f-b253-40db-8722-15f58f63f1e6)


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


_commit: <a href="https://github.com/enzonotario/vitepress-openapi/runs/32433963137"><code>3dc44b5</code></a>_


Patch:
diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts
index c59ded1..b654212 100644
--- a/docs/.vitepress/config.mts
+++ b/docs/.vitepress/config.mts
@@ -3,7 +3,9 @@ import { useSidebar } from 'vitepress-openapi'
 import spec from '../public/openapi.json' assert { type: 'json' }
 import { defineConfigWithTheme } from 'vitepress'
 
-const sidebar = useSidebar({ spec })
+const sidebar = useSidebar({
+  spec,
+})
 
 const gaId = 'G-ELG8ZW19X4'
 
diff --git a/src/composables/useTheme.ts b/src/composables/useTheme.ts
index 9b6a435..675b97f 100644
--- a/src/composables/useTheme.ts
+++ b/src/composables/useTheme.ts
@@ -79,6 +79,7 @@ export interface SpecConfig {
   avoidCirculars?: Ref<boolean>
   lazyRendering?: Ref<boolean>
   defaultTag?: string
+  defaultTagDescription?: string
 }
 
 export interface UseThemeConfig {
@@ -170,6 +171,7 @@ const themeConfig: UseThemeConfig = {
     avoidCirculars: ref(false),
     lazyRendering: ref(false),
     defaultTag: 'Default',
+    defaultTagDescription: '',
   },
 }
 
@@ -470,6 +472,10 @@ export function useTheme(config: Partial<UseThemeConfig> = {}) {
     if (config.defaultTag !== undefined) {
       themeConfig.spec.defaultTag = config.defaultTag
     }
+
+    if (config.defaultTagDescription !== undefined) {
+      themeConfig.spec.defaultTagDescription = config.defaultTagDescription
+    }
   }
 
   return {
diff --git a/src/lib/OpenApi.ts b/src/lib/OpenApi.ts
index 8bf85e4..5e34081 100644
--- a/src/lib/OpenApi.ts
+++ b/src/lib/OpenApi.ts
@@ -27,6 +27,10 @@ export function OpenApi({
     return null
   }
 
+  function getSpec() {
+    return parsedSpec ?? transformedSpec ?? spec ?? {}
+  }
+
   function getParsedSpec() {
     if (!parsedSpec) {
       parsedSpec = parseSpec(transformedSpec ?? spec)
@@ -39,7 +43,7 @@ export function OpenApi({
     if (operationId) {
       const operationPath = getOperationPath(operationId)
       if (operationPath) {
-        const pathServers = spec.paths[operationPath]?.servers
+        const pathServers = getSpec().paths[operationPath]?.servers
         if (pathServers && pathServers.length > 0) {
           try {
             const firstUrl = pathServers[0].url
@@ -57,12 +61,12 @@ export function OpenApi({
       }
     }
 
-    if (!spec?.servers || spec.servers.length === 0) {
+    if (!getSpec().servers || getSpec().servers.length === 0) {
       return DEFAULT_SERVER_URL
     }
 
     try {
-      const firstUrl = spec.servers[0].url
+      const firstUrl = getSpec().servers[0].url
 
       const isValid = new URL(firstUrl)
       if (!isValid) {
@@ -71,25 +75,25 @@ export function OpenApi({
 
       return firstUrl
     } catch {
-      console.warn('Invalid server URL:', spec.servers)
+      console.warn('Invalid server URL:', getSpec().servers)
       return DEFAULT_SERVER_URL
     }
   }
 
   function getOperation(operationId: string) {
-    if (!spec?.paths) {
+    if (!getSpec().paths) {
       return null
     }
 
-    return findOperation(spec.paths, operationId)
+    return findOperation(getSpec().paths, operationId)
   }
 
   function getOperationPath(operationId: string) {
-    if (!spec?.paths) {
+    if (!getSpec().paths) {
       return null
     }
 
-    for (const [path, methods] of Object.entries(spec.paths)) {
+    for (const [path, methods] of Object.entries(getSpec().paths)) {
       for (const verb of httpVerbs) {
         if (methods[verb]?.operationId === operationId) {
           return path
@@ -101,11 +105,11 @@ export function OpenApi({
   }
 
   function getOperationMethod(operationId: string) {
-    if (!spec?.paths) {
+    if (!getSpec().paths) {
       return null
     }
 
-    for (const path of Object.values(spec.paths)) {
+    for (const path of Object.values(getSpec().paths)) {
       for (const verb of httpVerbs) {
         if (path[verb]?.operationId === operationId) {
           return verb
@@ -157,7 +161,7 @@ export function OpenApi({
   }
 
   function getPaths() {
-    return spec?.paths ?? {}
+    return getSpec().paths ?? {}
   }
 
   function getPathsByVerbs() {
@@ -182,23 +186,23 @@ export function OpenApi({
   }
 
   function getInfo() {
-    return spec?.info ?? {}
+    return getSpec().info ?? {}
   }
 
   function getExternalDocs() {
-    return spec?.externalDocs ?? {}
+    return getSpec().externalDocs ?? {}
   }
 
   function getServers() {
-    return spec?.servers ?? []
+    return getSpec().servers ?? []
   }
 
   function getOperationsTags() {
-    if (!spec?.paths) {
+    if (!getSpec().paths) {
       return []
     }
 
-    return Object.values(spec.paths).reduce((tags, path: any) => {
+    return Object.values(getSpec().paths).reduce((tags, path: any) => {
       for (const verb of httpVerbs) {
         if (path[verb]?.tags) {
           path[verb].tags.forEach((tag: string) => {
@@ -239,7 +243,7 @@ export function OpenApi({
   }
 
   function getTags() {
-    return (spec?.tags ?? [])
+    return (getSpec().tags ?? [])
       .map(({ name, description }) => ({
         name: name ?? null,
         description: description ?? null,
@@ -264,7 +268,7 @@ export function OpenApi({
   }
 
   return {
-    spec: parsedSpec ?? transformedSpec ?? spec,
+    spec: getSpec(),
     transformedSpec,
     parsedSpec,
     getBaseUrl,
diff --git a/src/lib/generateMissingTags.ts b/src/lib/generateMissingTags.ts
index 7ede77c..f8a0392 100644
--- a/src/lib/generateMissingTags.ts
+++ b/src/lib/generateMissingTags.ts
@@ -1,21 +1,29 @@
 import { useTheme } from 'vitepress-openapi'
 
 export function generateMissingTags(spec: any) {
-  const paths = spec.paths
-
-  if (!paths) {
-    return spec
-  }
-
   const defaultTag = useTheme().getSpecConfig().defaultTag
 
-  for (const path of Object.values(paths)) {
+  const operationTags = new Set<string>()
+
+  spec.paths = spec.paths || {}
+  for (const path of Object.values(spec.paths)) {
     for (const verb of Object.keys(path)) {
       const operation = path[verb]
       const tags = operation.tags || [defaultTag]
       operation.tags = tags
+      tags.forEach((tag: string) => operationTags.add(tag))
     }
   }
 
+  spec.tags = spec.tags || []
+  if (
+    operationTags.has(defaultTag)
+    && !spec.tags.find((tag: any) => tag.name === defaultTag)) {
+    spec.tags.push({
+      name: defaultTag,
+      description: useTheme().getSpecConfig().defaultTagDescription,
+    })
+  }
+
   return spec
 }


Test patch:
diff --git a/test/composables/openapi.test.ts b/test/composables/openapi.test.ts
index f003bfd..2db4e9f 100644
--- a/test/composables/openapi.test.ts
+++ b/test/composables/openapi.test.ts
@@ -1,5 +1,5 @@
 import { describe, expect, it } from 'vitest'
-import { createOpenApiInstance } from 'vitepress-openapi'
+import { createOpenApiInstance, useOpenapi } from 'vitepress-openapi'
 import { spec } from '../testsConstants'
 
 describe('openapi with spec', () => {
@@ -182,6 +182,10 @@ describe('openapi with spec', () => {
         name: 'pets',
         description: 'Operations about pets',
       },
+      {
+        name: 'Default',
+        description: '',
+      },
     ])
   })
 
@@ -236,3 +240,39 @@ describe('spec with different servers for specific path', () => {
     expect(result).toBe('https://api.local.com')
   })
 })
+
+describe('custom specs', () => {
+  it('supports custom default tag name and description', () => {
+    const customTag = 'Custom'
+    const customDescription = 'Custom default description'
+    const openapi = useOpenapi({
+      spec: {
+        openapi: '3.0.0',
+        paths: {
+          '/no-tags': {
+            get: {
+              operationId: 'getNoTags',
+            },
+          },
+        },
+      },
+      config: {
+        spec: {
+          defaultTag: customTag,
+          defaultTagDescription: customDescription,
+        },
+      },
+    })
+
+    expect(openapi.getOperationsTags()).toEqual([customTag])
+
+    const tags = openapi.getTags()
+
+    expect(tags).toEqual([
+      {
+        name: customTag,
+        description: customDescription,
+      },
+    ])
+  })
+})
diff --git a/test/composables/useTheme.test.ts b/test/composables/useTheme.test.ts
index cda4d0d..2ff7453 100644
--- a/test/composables/useTheme.test.ts
+++ b/test/composables/useTheme.test.ts
@@ -91,6 +91,7 @@ describe('composition API', () => {
       avoidCirculars: ref(false),
       lazyRendering: ref(false),
       defaultTag: 'Default',
+      defaultTagDescription: '',
     })
   })
 
@@ -330,6 +331,7 @@ describe('useTheme', () => {
       avoidCirculars: ref(false),
       lazyRendering: ref(false),
       defaultTag: 'Default',
+      defaultTagDescription: '',
     })
   })