fix: improve lifecycle deprecated message

[fengmk2]

Summary by CodeRabbit

• Bug Fixes

  • Updated deprecation messages for beforeStart, readyCallback, and beforeClose methods to clarify recommended alternatives.

• Documentation

  • Enhanced clarity regarding deprecated features and their replacements in method documentation.

[coderabbitai]

Walkthrough

The pull request introduces updates to the deprecation messages in the EggCore class within src/egg.ts. The changes focus on improving the clarity of deprecation warnings for methods like beforeStart, readyCallback, and beforeClose. These updates aim to provide more explicit guidance to developers about using alternative "Life Cycles" methods, while maintaining the existing functionality and method signatures of the class.

Changes

File	Change Summary
src/egg.ts	Updated deprecation messages for beforeStart(), readyCallback(), and beforeClose() methods in EggCore class

Poem

🐰 Hop along, dev friends, hear my tale so bright,
Deprecation messages now shine clear and light!
Life Cycles beckon with their siren call,
Old methods whisper, "We're not the best after all!"
Code evolves, warnings dance with glee! 🚀

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. We would love to hear your feedback on Discord.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (3)

src/egg.ts (3)

236-236: Update URL format for consistency

The deprecation message URL should follow the standard EggJS documentation URL format.

-    this.deprecate('`beforeStart` was deprecated, please use "Life Cycles" instead, see https://www.eggjs.org/advanced/loader#life-cycles');
+    this.deprecate('`beforeStart` was deprecated, please use "Life Cycles" instead, see https://eggjs.org/advanced/loader-life-cycles');

---

279-279: Update URL format for consistency

The deprecation message URL should follow the standard EggJS documentation URL format.

-    this.deprecate('`readyCallback` was deprecated, please use "Life Cycles" instead, see https://www.eggjs.org/advanced/loader#life-cycles');
+    this.deprecate('`readyCallback` was deprecated, please use "Life Cycles" instead, see https://eggjs.org/advanced/loader-life-cycles');

---

296-296: Update URL format for consistency

The deprecation message URL should follow the standard EggJS documentation URL format.

-    this.deprecate('`beforeClose` was deprecated, please use "Life Cycles" instead, see https://www.eggjs.org/advanced/loader#life-cycles');
+    this.deprecate('`beforeClose` was deprecated, please use "Life Cycles" instead, see https://eggjs.org/advanced/loader-life-cycles');

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 7a4f340 and 00cf4c7.

📒 Files selected for processing (1)

• src/egg.ts (3 hunks)

🔇 Additional comments (1)

src/egg.ts (1)

Line range hint 236-296: LGTM! Clear and consistent deprecation messages

The changes improve the clarity of deprecation messages across all lifecycle methods (beforeStart, readyCallback, and beforeClose). The messages are consistent in their structure and effectively guide users to the Life Cycles documentation.

[pkg-pr-new]

Open in Stackblitz

npm i https://pkg.pr.new/eggjs/egg-core/@eggjs/core@275

commit: 00cf4c7

[codecov]

Codecov Report

Attention: Patch coverage is 0% with 3 lines in your changes missing coverage. Please review.

Project coverage is 92.89%. Comparing base (cb48d0e) to head (00cf4c7).
Report is 3 commits behind head on master.

Files with missing lines	Patch %	Lines
src/egg.ts	0.00%	3 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##           master     #275   +/-   ##
=======================================
  Coverage   92.89%   92.89%           
=======================================
  Files          10       10           
  Lines        3294     3294           
  Branches      529      529           
=======================================
  Hits         3060     3060           
  Misses        234      234           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.