Repository: enzonotario/vitepress-openapi
Pull request #106 (2024-11-01 22:52:15)

fix(spec): generate defaultTag for operations that has no tags
<!-- Provide a general summary of your changes in the title above. -->

# Description

Adds a `generateMissingTags` function to set a `defaultTag` for operations that has no tags, as a Tag is needed for sidebar/routing to group operations without tags.

## Related issues/external references

#105 (Just saw this issue when testing the reproduction)

## Types of changes

- Bug fix


vercel[bot]: [vc]: #HOmafY9mgITQieK7bHMUlS1vM40JPkDWq+z+QVydbdo=:eyJpc01vbm9yZXBvIjp0cnVlLCJ0eXBlIjoiZ2l0aHViIiwicHJvamVjdHMiOlt7Im5hbWUiOiJ2aXRlcHJlc3Mtb3BlbmFwaSIsImxpdmVGZWVkYmFjayI6eyJyZXNvbHZlZCI6MCwidW5yZXNvbHZlZCI6MCwidG90YWwiOjAsImxpbmsiOiJ2aXRlcHJlc3Mtb3BlbmFwaS1naXQtZmVhdHVyZS1kZWZhdWx0dGFnLWVuem8tbm90YXJpb3MtcHJvamVjdHMudmVyY2VsLmFwcCJ9LCJpbnNwZWN0b3JVcmwiOiJodHRwczovL3ZlcmNlbC5jb20vZW56by1ub3Rhcmlvcy1wcm9qZWN0cy92aXRlcHJlc3Mtb3BlbmFwaS9IdFFoenE5Z2JvQkNQN3VQMmRlNVdhRHJxWnprIiwicHJldmlld1VybCI6InZpdGVwcmVzcy1vcGVuYXBpLWdpdC1mZWF0dXJlLWRlZmF1bHR0YWctZW56by1ub3Rhcmlvcy1wcm9qZWN0cy52ZXJjZWwuYXBwIiwibmV4dENvbW1pdFN0YXR1cyI6IkRFUExPWUVEIn1dfQ==
**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/HtQhzq9gboBCP7uP2de5WaDrqZzk)) | [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 1, 2024 10:52pm |


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 89c4b1a7983b0ab9c84ecd854500774fa92b2b49 and 07c8c4bed7608cb852f116f5e22cd64394b0d136.
> 
> </details>
> 
> <details>
> <summary>📒 Files selected for processing (9)</summary>
> 
> * `docs/composables/useTheme.md` (2 hunks)
> * `src/components/Path/OAPathsByTags.vue` (1 hunks)
> * `src/composables/useOpenapi.ts` (2 hunks)
> * `src/composables/usePaths.ts` (1 hunks)
> * `src/composables/useSidebar.ts` (3 hunks)
> * `src/composables/useTheme.ts` (3 hunks)
> * `src/lib/OpenApi.ts` (4 hunks)
> * `src/lib/generateMissingTags.ts` (1 hunks)
> * `src/lib/transformSpec.ts` (2 hunks)
> 
> </details>
> 
> ```ascii
>  _________________________________________
> < Digging deeper than a Minecraft player. >
>  -----------------------------------------
>   \
>    \   (\__/)
>        (•ㅅ•)
>        / 　 づ
> ```

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

<!-- usage_tips_start -->

> [!TIP]
> <details>
> <summary>You can disable sequence diagrams in the walkthrough.</summary>
> 
> Disable the `reviews.sequence_diagrams` setting in your project's settings in CodeRabbit to disable sequence diagrams in the walkthrough.
> 
> </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 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/c0ff0e90-4cf2-4342-aba6-38daf300d0b5)


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


_commit: <a href="https://github.com/enzonotario/vitepress-openapi/runs/32410678863"><code>07c8c4b</code></a>_


Patch:
diff --git a/docs/composables/useTheme.md b/docs/composables/useTheme.md
index 5b1a0cf..cd52216 100644
--- a/docs/composables/useTheme.md
+++ b/docs/composables/useTheme.md
@@ -90,6 +90,7 @@ export default {
                 showPathsSummary: true, // Show a summary of the paths when grouping by tags.
                 avoidCirculars: false, // Avoid circular references when parsing schemas.
                 lazyRendering: false, // Lazy render Paths and Tags components.
+                defaultTag: 'Default', // Default tag to use when a path has no tags.
             },
         })
     }
@@ -150,6 +151,6 @@ export default {
 
 ## Spec Configuration
 
-| Function        | Description                  | Default Value                                                         | Allowed Values                                                                |
-|-----------------|------------------------------|-----------------------------------------------------------------------|-------------------------------------------------------------------------------|
-| `setSpecConfig` | Sets the spec configuration. | `{ groupByTags: true, collapsePaths: false, showPathsSummary: true, avoidCirculars: false, lazyRendering: false }` | `{ groupByTags: boolean, collapsePaths: boolean, showPathsSummary: boolean, avoidCirculars: boolean, lazyRendering: boolean }` |
+| Function        | Description                  | Default Value                                                                                                                             | Allowed Values                                                                                                                                     |
+|-----------------|------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|
+| `setSpecConfig` | Sets the spec configuration. | `{ groupByTags: true, collapsePaths: false, showPathsSummary: true, avoidCirculars: false, lazyRendering: false, defaultTag: 'Default' }` | `{ groupByTags: boolean, collapsePaths: boolean, showPathsSummary: boolean, avoidCirculars: boolean, lazyRendering: boolean, defaultTag: string }` |
diff --git a/package.json b/package.json
index c34e8d2..ea8524a 100644
--- a/package.json
+++ b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "vitepress-openapi",
   "type": "module",
-  "version": "0.0.3-alpha.46",
+  "version": "0.0.3-alpha.47",
   "packageManager": "pnpm@9.1.1",
   "homepage": "https://vitepress-openapi.vercel.app/",
   "repository": {
diff --git a/src/components/Path/OAPathsByTags.vue b/src/components/Path/OAPathsByTags.vue
index fae8910..c8d25df 100644
--- a/src/components/Path/OAPathsByTags.vue
+++ b/src/components/Path/OAPathsByTags.vue
@@ -56,7 +56,7 @@ const internalTags = ref([
   ...(pathsWithoutTags.length
     ? [
         {
-          tag: t('Default'),
+          tag: t(useTheme().getSpecConfig.defaultTag),
           paths: pathsWithoutTags,
           isOpen: !themeConfig.getSpecConfig().collapsePaths.value,
         },
diff --git a/src/composables/useOpenapi.ts b/src/composables/useOpenapi.ts
index 44e80aa..0630c86 100644
--- a/src/composables/useOpenapi.ts
+++ b/src/composables/useOpenapi.ts
@@ -30,6 +30,10 @@ export function useOpenapi({
   spec: null,
   config: null,
 }) {
+  if (config) {
+    useTheme(config)
+  }
+
   if (spec !== null) {
     setupOpenApi({ spec, config })
   }
@@ -49,9 +53,7 @@ export function useOpenapi({
 
   function addSchema({ id, spec, config }) {
     const openapi = createOpenApiInstance({ spec })
-    if (config) {
-      useTheme(config)
-    }
+
     schemas.set(id, {
       ...openapi,
       id,
diff --git a/src/composables/usePaths.ts b/src/composables/usePaths.ts
index b81877b..1b7991a 100644
--- a/src/composables/usePaths.ts
+++ b/src/composables/usePaths.ts
@@ -10,7 +10,7 @@ export function usePaths({
   const openapi = OpenApi({ spec, transformedSpec: transformSpec(spec) })
 
   function getTags() {
-    return openapi.getFilteredTests()
+    return openapi.getFilteredTags()
   }
 
   return {
diff --git a/src/composables/useSidebar.ts b/src/composables/useSidebar.ts
index 16bc4bf..80938cc 100644
--- a/src/composables/useSidebar.ts
+++ b/src/composables/useSidebar.ts
@@ -1,5 +1,7 @@
 import { OpenApi, httpVerbs, useOpenapi } from 'vitepress-openapi'
+import { transformSpec } from '../lib/transformSpec'
 import type { OpenAPI } from './useOpenapi'
+import { useTheme } from './useTheme'
 
 interface GenerateSidebarGroupsOptions {
   tags?: string[] | null
@@ -17,26 +19,38 @@ const defaultOptions = {
   spec: null,
   linkPrefix: '/operations/',
   tagLinkPrefix: '/tags/',
+  defaultTag: 'Default',
 }
 
 export function useSidebar({
   spec,
   linkPrefix,
   tagLinkPrefix,
+  defaultTag,
 }: {
   spec?: OpenAPI
   linkPrefix?: string
   tagLinkPrefix?: string
+  defaultTag?: string
 } = {
   ...defaultOptions,
 }) {
+  useTheme({
+    spec: {
+      defaultTag: defaultTag || defaultOptions.defaultTag,
+    },
+  })
+
   const options = {
     spec: spec || useOpenapi().json,
     linkPrefix: linkPrefix || defaultOptions.linkPrefix,
     tagLinkPrefix: tagLinkPrefix || defaultOptions.tagLinkPrefix,
   }
 
-  const openapi = OpenApi({ spec: options.spec })
+  const openapi = OpenApi({
+    spec: options.spec,
+    transformedSpec: transformSpec(options.spec),
+  })
 
   function sidebarItemTemplate(method: string, title: string) {
     return `<span class="OASidebarItem group/oaSidebarItem">
@@ -136,7 +150,7 @@ export function useSidebar({
     tags,
     linkPrefix,
   }: GenerateSidebarGroupsOptions = {}) {
-    tags = tags || openapi.getFilteredTests().map(({ name }) => name)
+    tags = tags || openapi.getFilteredTags().map(({ name }) => name)
     linkPrefix = linkPrefix || options.tagLinkPrefix
 
     if (!openapi.getPaths()) {
diff --git a/src/composables/useTheme.ts b/src/composables/useTheme.ts
index 6bacc1b..9b6a435 100644
--- a/src/composables/useTheme.ts
+++ b/src/composables/useTheme.ts
@@ -73,11 +73,12 @@ export interface I18nConfig {
 }
 
 export interface SpecConfig {
-  groupByTags: Ref<boolean>
-  collapsePaths: Ref<boolean>
-  showPathsSummary: Ref<boolean>
-  avoidCirculars: Ref<boolean>
-  lazyRendering: Ref<boolean>
+  groupByTags?: Ref<boolean>
+  collapsePaths?: Ref<boolean>
+  showPathsSummary?: Ref<boolean>
+  avoidCirculars?: Ref<boolean>
+  lazyRendering?: Ref<boolean>
+  defaultTag?: string
 }
 
 export interface UseThemeConfig {
@@ -168,6 +169,7 @@ const themeConfig: UseThemeConfig = {
     showPathsSummary: ref(true),
     avoidCirculars: ref(false),
     lazyRendering: ref(false),
+    defaultTag: 'Default',
   },
 }
 
@@ -464,6 +466,10 @@ export function useTheme(config: Partial<UseThemeConfig> = {}) {
     if (config.lazyRendering !== undefined) {
       themeConfig.spec.lazyRendering.value = config.lazyRendering
     }
+
+    if (config.defaultTag !== undefined) {
+      themeConfig.spec.defaultTag = config.defaultTag
+    }
   }
 
   return {
diff --git a/src/lib/OpenApi.ts b/src/lib/OpenApi.ts
index 28af012..8bf85e4 100644
--- a/src/lib/OpenApi.ts
+++ b/src/lib/OpenApi.ts
@@ -175,7 +175,7 @@ export function OpenApi({
               verb,
               operationId,
               summary,
-              tags,
+              tags: tags ?? [],
             }
           })
       })
@@ -235,7 +235,7 @@ export function OpenApi({
   }
 
   function getPathsWithoutTags() {
-    return filterPaths(operation => !operation?.tags)
+    return filterPaths(operation => !operation?.tags || operation.tags.length === 0)
   }
 
   function getTags() {
@@ -246,7 +246,7 @@ export function OpenApi({
       }))
   }
 
-  function getFilteredTests() {
+  function getFilteredTags() {
     const operationsTags = getOperationsTags()
 
     const tags = getTags()
@@ -284,6 +284,6 @@ export function OpenApi({
     getPathsByTags,
     getPathsWithoutTags,
     getTags,
-    getFilteredTests,
+    getFilteredTags,
   }
 }
diff --git a/src/lib/generateMissingTags.ts b/src/lib/generateMissingTags.ts
new file mode 100644
index 0000000..7ede77c
--- /dev/null
+++ b/src/lib/generateMissingTags.ts
@@ -0,0 +1,21 @@
+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)) {
+    for (const verb of Object.keys(path)) {
+      const operation = path[verb]
+      const tags = operation.tags || [defaultTag]
+      operation.tags = tags
+    }
+  }
+
+  return spec
+}
diff --git a/src/lib/transformSpec.ts b/src/lib/transformSpec.ts
index bcea768..94196f2 100644
--- a/src/lib/transformSpec.ts
+++ b/src/lib/transformSpec.ts
@@ -1,5 +1,6 @@
 import { generateMissingOperationIds } from './generateMissingOperationIds'
 import { generateMissingSummary } from './generateMissingSummary'
+import { generateMissingTags } from './generateMissingTags'
 
 export function transformSpec(spec) {
   if (import.meta.env.VITE_DEBUG) {
@@ -17,6 +18,7 @@ export function transformSpec(spec) {
   if (spec?.paths) {
     spec = generateMissingOperationIds(spec)
     spec = generateMissingSummary(spec)
+    spec = generateMissingTags(spec)
   }
 
   return Object.assign({}, spec)


Test patch:
diff --git a/test/composables/openapi.test.ts b/test/composables/openapi.test.ts
index ed755ab..f003bfd 100644
--- a/test/composables/openapi.test.ts
+++ b/test/composables/openapi.test.ts
@@ -139,7 +139,7 @@ describe('openapi with spec', () => {
     expect(paths).toMatchObject({})
   })
 
-  it('getPathsWithoutTags returns paths without tags', () => {
+  it('sets defaultTag for operations without tags', () => {
     const api = createOpenApiInstance({
       spec: {
         ...spec,
@@ -159,16 +159,9 @@ describe('openapi with spec', () => {
       },
     })
 
-    const paths = api.getPathsWithoutTags()
+    expect(api.getPathsWithoutTags()).toMatchObject({})
 
-    expect(paths).toMatchObject({
-      '/no-tags': {
-        get: {
-          operationId: 'getNoTags',
-          summary: 'GET /no-tags',
-        },
-      },
-    })
+    expect(api.getOperationsTags()).toEqual(['users', 'Default'])
   })
 
   it('getPathsWithoutTags returns empty array if no paths without tags', () => {
diff --git a/test/composables/useSidebar.test.ts b/test/composables/useSidebar.test.ts
index 8f15738..a7f2520 100644
--- a/test/composables/useSidebar.test.ts
+++ b/test/composables/useSidebar.test.ts
@@ -179,10 +179,4 @@ describe('itemsByTags', () => {
       { text: 'pets', link: '/tags/pets' },
     ])
   })
-
-  it('returns an empty array when there are no paths', () => {
-    const emptySidebar = useSidebar({ spec: {} })
-    const result = emptySidebar.itemsByTags()
-    expect(result).toEqual([])
-  })
 })
diff --git a/test/composables/useTheme.test.ts b/test/composables/useTheme.test.ts
index e7b1943..cda4d0d 100644
--- a/test/composables/useTheme.test.ts
+++ b/test/composables/useTheme.test.ts
@@ -90,6 +90,7 @@ describe('composition API', () => {
       showPathsSummary: ref(false),
       avoidCirculars: ref(false),
       lazyRendering: ref(false),
+      defaultTag: 'Default',
     })
   })
 
@@ -328,6 +329,7 @@ describe('useTheme', () => {
       showPathsSummary: ref(true),
       avoidCirculars: ref(false),
       lazyRendering: ref(false),
+      defaultTag: 'Default',
     })
   })