fix: update Swagger plugin install to use @elysiajs/swagger - #874
Conversation
WalkthroughThe documentation now uses ChangesSwagger documentation updates
Estimated code review effort: 1 (Trivial) | ~2 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/plugins/swagger.md`:
- Line 29: Update the remaining Swagger import examples in
docs/plugins/swagger.md to use the installed package name `@elysiajs/swagger`
instead of `@elysia/swagger`, including all three import occurrences referenced in
the documentation.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: b67daafa-2366-48e4-bdb5-94feea1bd128
📒 Files selected for processing (2)
docs/plugins/openapi.mddocs/plugins/swagger.md
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/migrate/from-fastify.txt`:
- Line 1226: Update the OpenAPI comparison description near the
`@elysia/openapi` import reference to name `@elysia/openapi` instead of
`@elysiajs/swagger`, keeping the surrounding Scalar and Swagger wording
unchanged.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: ed48e9d8-50ef-4f2d-9cd2-c9e64a37e81d
📒 Files selected for processing (3)
docs/eden/installation.mddocs/migrate/from-fastify.txtdocs/plugins/swagger.md
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/plugins/swagger.md
| <template v-slot:right-content> | ||
|
|
||
| > Elysia use `@elysia/swagger` for OpenAPI documentation using Scalar by default, or optionally Swagger | ||
| > Elysia use `@elysiajs/swagger` for OpenAPI documentation using Scalar by default, or optionally Swagger |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟠 Major | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
set -euo pipefail
# Verify that each documentation example uses one consistent package/API pair.
rg -n -C 3 '`@elysia`(openapi|js/swagger)|\b(openapi|swagger)\(\)|Scalar|Swagger' \
docs/migrate/from-fastify.txt \
docs/plugins/openapi.md \
docs/plugins/swagger.mdRepository: elysiajs/documentation
Length of output: 12528
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "## Relevant migration section"
sed -n '1118,1232p' docs/migrate/from-fastify.txt | cat -n -v | sed 's/^/ /'
echo
echo "## Repository package metadata references"
git ls-files | rg '(^|/)(package\.json|bun\.lockb|bun\.lock|pnpm-lock\.yaml|yarn\.lock)$' || true
rg -n '"name"\s*:\s*"(?:`@elysia/openapi`|`@elysiajs/swagger`)"|`@elysia/openapi`|`@elysiajs/swagger`|export \* as openapi|export \* as swagger|openapi:\s*\{|swagger:\s*\{|const openapi|const swagger' . \
--glob '!vendor/**' --glob '!node_modules/**' --glob '!dist/**' --glob '!build/**' | head -200Repository: elysiajs/documentation
Length of output: 9579
Fix the comparison package label, dummy~ ♡
This section is for OpenAPI and the code uses import { openapi } from '@elysia/openapi', but the description still says @elysiajs/swagger. Change the description to @elysia/openapi so the example and text match. (ง ˃̣̣̥̀ᴗ˂̣̣̥́)ง~♡
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/migrate/from-fastify.txt` at line 1226, Update the OpenAPI comparison
description near the `@elysia/openapi` import reference to name
`@elysia/openapi` instead of `@elysiajs/swagger`, keeping the surrounding Scalar
and Swagger wording unchanged.
Update installation command for Swagger plugin to use @elysiajs/swagger
https://www.npmjs.com/package/@elysiajs/swagger
Summary by CodeRabbit
@elysiajs/swagger.