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

fix: deprecated should print to stdout #281

Merged
merged 2 commits into from
Dec 31, 2024
Merged

fix: deprecated should print to stdout #281

merged 2 commits into from
Dec 31, 2024

Conversation

fengmk2
Copy link
Member

@fengmk2 fengmk2 commented Dec 31, 2024

Summary by CodeRabbit

  • Chores

    • Updated logging namespaces from @eggjs/core:* to @eggjs/core/* across multiple files
    • Standardized debug and error logging formats
    • Minor adjustments to logging messages in test cases
  • Documentation

    • Improved consistency in logging message formats

Note: These changes do not impact the core functionality of the application and are primarily related to internal logging conventions.

Copy link

coderabbitai bot commented Dec 31, 2024

Walkthrough

This pull request focuses on standardizing the logging namespace across multiple files in the Egg.js framework. The changes involve systematically replacing the colon (:) with a forward slash (/) in debug logging namespaces. This modification spans several files including egg.ts, loader/egg_loader.ts, utils/index.ts, utils/sequencify.ts, utils/timing.ts, and a corresponding test file. The changes are purely cosmetic and do not impact the underlying functionality of the code.

Changes

File Change Summary
src/egg.ts Updated debug logging namespace from @eggjs/core:egg to @eggjs/core/egg
src/loader/egg_loader.ts Modified logging context in multiple log statements from [@eggjs/core:egg_loader] to [@eggjs/core/egg_loader]
src/utils/index.ts Changed logging namespaces in debuglog and deprecated methods from : to /
src/utils/sequencify.ts Updated import path for debuglog from @eggjs/core:utils:sequencify to @eggjs/core/utils/sequencify
src/utils/timing.ts Modified import path from @eggjs/core:utils:timing to @eggjs/core/utils/timing
test/loader/mixin/load_plugin.test.ts Updated warning message prefix to match new logging namespace format

Possibly related PRs

  • fix: load extend #279: The changes in this PR involve modifications to the logging context in src/egg.ts, which is related to the cosmetic adjustments made in the main PR regarding logging namespaces.
  • fix: ignore js file when the same ts file exists #280: This PR also modifies logging strings in src/loader/file_loader.ts, changing the format from @eggjs/core:file_loader to @eggjs/core/file_loader, which aligns with the namespace changes in the main PR.

Poem

🐰 A Rabbit's Logging Delight

From colons to slashes, we dance with glee,
Namespaces transformed, so clean and free!
No function changed, just a path refined,
Our logging now sleek, perfectly aligned!
Debug on, little code, hop bright and light! 🌟


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 712742d and 39b8e0a.

📒 Files selected for processing (1)
  • test/loader/mixin/load_plugin.test.ts (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • test/loader/mixin/load_plugin.test.ts

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

pkg-pr-new bot commented Dec 31, 2024

Open in Stackblitz

npm i https://pkg.pr.new/eggjs/core/@eggjs/core@281

commit: 39b8e0a

Copy link

codecov bot commented Dec 31, 2024

Codecov Report

Attention: Patch coverage is 93.33333% with 1 line in your changes missing coverage. Please review.

Project coverage is 97.86%. Comparing base (a6acc88) to head (39b8e0a).
Report is 2 commits behind head on master.

Files with missing lines Patch % Lines
src/utils/index.ts 75.00% 1 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##           master     #281   +/-   ##
=======================================
  Coverage   97.86%   97.86%           
=======================================
  Files          10       10           
  Lines        3373     3373           
  Branches      594      594           
=======================================
  Hits         3301     3301           
  Misses         72       72           

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

@fengmk2 fengmk2 merged commit 2aeb0e2 into master Dec 31, 2024
22 of 23 checks passed
@fengmk2 fengmk2 deleted the fix-deprecated branch December 31, 2024 12:34
fengmk2 pushed a commit that referenced this pull request Dec 31, 2024
[skip ci]

## [6.2.7](v6.2.6...v6.2.7) (2024-12-31)

### Bug Fixes

* deprecated should print to stdout ([#281](#281)) ([2aeb0e2](2aeb0e2))
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.

1 participant