Skip to content
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

feat(doc): cookies 增加 partitioned、removeUnpartitioned 和 priority 选项文档 #5376

Merged
merged 1 commit into from
Dec 16, 2024

Conversation

yisibl
Copy link
Contributor

@yisibl yisibl commented Dec 15, 2024

Checklist
  • npm test passes
  • tests and/or benchmarks are included
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)
Description of change

Summary by CodeRabbit

  • New Features

    • Introduced new cookie options: partitioned, removeUnpartitioned, and priority for enhanced control over cookie behavior.
  • Documentation

    • Updated documentation for cookie and session management, including clarifications and expanded explanations of existing and new options.
    • Provided comprehensive examples for correct usage patterns of session management.

Copy link

coderabbitai bot commented Dec 15, 2024

Walkthrough

The documentation for cookie and session management in the Chinese language version has been updated to provide more comprehensive information about cookie settings and session handling. The changes focus on introducing new cookie options like partitioned, removeUnpartitioned, and priority, while also clarifying existing options such as httpOnly and secure. The document now offers more detailed explanations about cookie and session methods, their usage, and configuration, enhancing the overall understanding of these core functionalities.

Changes

File Change Summary
site/docs/core/cookie-and-session.zh-CN.md - Added new cookie options: partitioned, removeUnpartitioned, priority
- Enhanced explanations for existing cookie settings
- Expanded documentation on ctx.cookies.set() and ctx.cookies.get() methods
- Improved session management documentation

Poem

🍪 Cookies dance, sessions sing,
New options take their mighty wing!
Partitioned, prioritized with care,
Security leaps beyond compare!
A rabbit's guide to web's sweet art 🔒

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. This feature will be included in our Pro Plan when released.


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?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • 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 for this PR. (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 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
site/docs/core/cookie-and-session.zh-CN.md (1)

31-31: Documentation looks good, with minor enhancement suggestions

The documentation for the new cookie options is well-structured and accurate. Consider these enhancements:

  1. Add quotes around the priority values for better clarity:
-可选值为 Low、Medium、High
+可选值为 'Low'、'Medium'、'High'
  1. Consider adding a code example demonstrating the usage of these new options, similar to the existing examples for httpOnly and encrypt.

Also applies to: 34-34, 37-41

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ce4fd67 and 291ba0a.

📒 Files selected for processing (1)
  • site/docs/core/cookie-and-session.zh-CN.md (1 hunks)
🔇 Additional comments (1)
site/docs/core/cookie-and-session.zh-CN.md (1)

Line range hint 1-300: Documentation formatting and structure is excellent

The document maintains consistent formatting and clear structure throughout. Technical terms are well-explained and properly linked to external resources. Browser compatibility information is clearly stated where relevant.

🧰 Tools
🪛 Markdownlint (0.37.0)

29-29: Expected: h3; Actual: h4
Heading levels should only increment by one level at a time

(MD001, heading-increment)

@fengmk2 fengmk2 merged commit 60eb8a1 into eggjs:master Dec 16, 2024
14 of 21 checks passed
fengmk2 pushed a commit that referenced this pull request Dec 16, 2024
[skip ci]

## [3.25.0](v3.24.1...v3.25.0) (2024-12-16)

### Features

* **doc:** cookies 增加 partitioned、removeUnpartitioned 和 priority 选项文档 ([#5376](#5376)) ([60eb8a1](60eb8a1))
@yisibl yisibl deleted the fix-cookies-doc branch December 16, 2024 02:34
fengmk2 pushed a commit that referenced this pull request Jan 11, 2025
[skip ci]

## [4.0.0](v3.24.1...v4.0.0) (2025-01-11)

### ⚠ BREAKING CHANGES

* Drop Node.js < 18.19.0 support

part of #3644

Breaking changes:
 - Drop Node.js < 18.19.0 support
 - Drop generator function support

use @eggjs/core@4 eggjs/core#265

### Features

* **doc:** cookies 增加 partitioned、removeUnpartitioned 和 priority 选项文档 ([#5376](#5376)) ([60eb8a1](60eb8a1))
* refactor with typescript to support cjs ane esm both ([#5328](#5328)) ([a09b1cf](a09b1cf))
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants