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

👍 Print human-readable error object in console output #320

Merged
merged 1 commit into from
Feb 6, 2024

Conversation

Milly
Copy link
Contributor

@Milly Milly commented Feb 6, 2024

Improve console.* methods when specify Error object.
This is for debugging purposes used by plugin developers.

Example of use:

try {
  somethingError();
} catch (e: unknown) {
  console.error(e);
}

Example output:

[denops] TypeError: This is my something error
[denops]     at innerSomethingError (file:///your/plugin/denops/foo.ts:50:12)
[denops]     at somethingError (file:///your/plugin/denops/foo.ts:30:10)

Summary by CodeRabbit

  • Bug Fixes
    • Improved error logging by including stack traces for better troubleshooting.

Copy link

coderabbitai bot commented Feb 6, 2024

Walkthrough

A recent update enhances error handling within a specific function, detectHost, by introducing a refined approach to argument formatting. This improvement involves a new check to ascertain if an argument is an instance of Error, and if so, it formats this argument as a string, thoughtfully including the stack trace. This adjustment aids in clearer, more informative error reporting and debugging processes.

Changes

File Change Summary
denops/.../worker.ts Updated detectHost to enhance formatArgs for better error instance handling, including stack traces.

🐇✨
In the code's vast, woven tapestry,
A rabbit hopped, fixing bugs with glee.
Now errors shine clear, as bright as day,
Helping humans find their way.
🌟🐾

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>.
    • Generate unit-tests for this file.
  • 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 tests 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 generate interesting stats about this repository from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

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.

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between b886389 and 1918967.
Files selected for processing (1)
  • denops/@denops-private/worker.ts (1 hunks)

denops/@denops-private/worker.ts Show resolved Hide resolved
@lambdalisue lambdalisue merged commit ebda886 into main Feb 6, 2024
7 checks passed
@lambdalisue lambdalisue deleted the serialize-error-in-console branch February 6, 2024 10:46
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