-
Notifications
You must be signed in to change notification settings - Fork 436
Update cookie secret comment in migration guide #709
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Clarified comment about cookie secret in Elysia setup.
WalkthroughDocumentation was updated in the Hono-to-Elysia migration guide to add a clarifying comment to the cookie example, explaining that the secret parameter must be configured to enable cookie signing functionality. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
🧹 Nitpick comments (1)
docs/migrate/from-hono.md (1)
1065-1065: Clarify the comment for better user understanding.The comment "// Need to set to have cookies signed" is helpful, but consider being more explicit about the implications. Users may benefit from knowing this is a required configuration step.
Consider updating the comment to be slightly more descriptive:
- secret: 'secret' // Need to set to have cookies signed + secret: 'secret' // Required to enable automatic cookie signingAlternatively, if you want to keep it concise, the current phrasing works but "must be set" is slightly clearer than "need to set":
- secret: 'secret' // Need to set to have cookies signed + secret: 'secret' // Must be set to enable cookie signing
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/migrate/from-hono.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
docs/migrate/from-hono.md
1065-1065: Hard tabs
Column: 1
(MD010, no-hard-tabs)
| const app = new Elysia({ | ||
| cookie: { | ||
| secret: 'secret' | ||
| secret: 'secret' // Need to set to have cookies signed |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fix indentation: replace hard tab with spaces.
The static analysis tool flagged a hard tab character at the beginning of this line. Markdown files should use spaces for indentation to maintain consistency.
Replace the hard tab with spaces to align indentation with the rest of the code block.
- [TAB]secret: 'secret' // Need to set to have cookies signed
+ [SPACES]secret: 'secret' // Need to set to have cookies signedCommittable suggestion skipped: line range outside the PR's diff.
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
1065-1065: Hard tabs
Column: 1
(MD010, no-hard-tabs)
🤖 Prompt for AI Agents
In docs/migrate/from-hono.md around line 1065, the line beginning with a hard
tab (" secret: 'secret' // Need to set to have cookies signed") uses a tab for
indentation; replace the leading tab character with the appropriate number of
spaces to match the surrounding code block indentation (use spaces consistently,
e.g., two or four spaces as used elsewhere in that block) so the file no longer
contains hard tabs.
Clarified comment about cookie secret in Elysia setup.
Summary by CodeRabbit