Fix: DebugLog - print box align, same contents #40

black7375 commented 2 months ago

Description

Adjust the type and print of @mincho/debug-log pacakge.

Related Issue

40

Summary by CodeRabbit

New Features
- Enhanced type safety for logging functions, allowing only JSON-compatible objects.
- Updated debugLog, jsonPrint, jsonLog, and jsonExpect functions with improved signatures for flexibility.
- Introduced multiple overloads for functions to better accommodate different input types.
Improvements
- Enhanced visual formatting of log outputs through modified padding options.
- Clearer output for comparisons in the jsonExpect function, improving usability.

coderabbitai[bot] commented 2 months ago

Walkthrough

The changes to the debug-log package significantly enhance type safety and logging functionality. New TypeScript types ensure that logged objects are JSON-compatible, preventing unsupported types. Function signatures have been updated for clarity, accepting only valid argument types, while overloaded functions improve usability. Overall, these modifications lead to a more robust and user-friendly logging system.

Changes

File	Change Summary
`packages/debug-log/src/index.ts`	Updated types for `debugLog`, `jsonPrint`, `jsonLog`, and `jsonExpect` functions to enhance type safety and JSON compatibility. Introduced new overloads for flexibility. Modified `boxen` padding in `consola` for improved log formatting.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant DebugLog
    participant JsonPrint
    participant JsonLog
    participant JsonExpect

    User->>DebugLog: call debugLog(name)
    DebugLog-->>User: log message

    User->>JsonPrint: call jsonPrint(obj)
    JsonPrint-->>User: print JSON

    User->>JsonLog: call jsonLog(name, obj)
    JsonLog-->>User: log JSON object

    User->>JsonExpect: call jsonExpect(name, obj1, obj2)
    JsonExpect-->>User: compare values and log results

Poem

In the world of logs, we hop and play,
With types so safe, they brighten the day.
JSON-friendly, our messages sing,
Robust and clear, oh what joy they bring!
So here's to the changes, with a bounce and a cheer,
A rabbit's delight, as we log without fear! 🐇✨

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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 as 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 resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

github-actions[bot] commented 2 months ago

Triggered from https://github.com/mincho-js/mincho/pull/41 by @black7375.

Checking if we can fast forward main (47e2bf3b0a94503ea94b90bb6869c2bcd0f00e8a) to debug-log-print (38d40dbb793f65e43c40bf78adcb3d86954f2d83).

Target branch (main):

commit 47e2bf3b0a94503ea94b90bb6869c2bcd0f00e8a (HEAD -> main, origin/main, origin/HEAD)
Author: alstjr7375 <alstjr7375@daum.net>
Date:   Sun Jul 21 14:24:27 2024 +0900

    Docs: Apply suggestions from code review #39

Pull request (debug-log-print):

commit 38d40dbb793f65e43c40bf78adcb3d86954f2d83 (pull_request/debug-log-print)
Author: alstjr7375 <alstjr7375@daum.net>
Date:   Sun Jul 21 15:35:48 2024 +0900

    Fix: DebugLog - declare type with function overload #40

It is possible to fast forward main (47e2bf3b0a94503ea94b90bb6869c2bcd0f00e8a) to debug-log-print (38d40dbb793f65e43c40bf78adcb3d86954f2d83). If you have write access to the target repository, you can add a comment with /fast-forward to fast forward main to debug-log-print.

github-actions[bot] commented 2 months ago

Triggered from https://github.com/mincho-js/mincho/pull/41 by @black7375.

Checking if we can fast forward main (47e2bf3b0a94503ea94b90bb6869c2bcd0f00e8a) to debug-log-print (4975f3afe25ea520e053c25016e5384e2bac63cf).

Target branch (main):

commit 47e2bf3b0a94503ea94b90bb6869c2bcd0f00e8a (HEAD -> main, origin/main, origin/HEAD)
Author: alstjr7375 <alstjr7375@daum.net>
Date:   Sun Jul 21 14:24:27 2024 +0900

    Docs: Apply suggestions from code review #39

Pull request (debug-log-print):

commit 4975f3afe25ea520e053c25016e5384e2bac63cf (pull_request/debug-log-print)
Author: alstjr7375 <alstjr7375@daum.net>
Date:   Sun Jul 21 15:46:21 2024 +0900

    Fix: DebugLog - declare type with function overload #40

It is possible to fast forward main (47e2bf3b0a94503ea94b90bb6869c2bcd0f00e8a) to debug-log-print (4975f3afe25ea520e053c25016e5384e2bac63cf). If you have write access to the target repository, you can add a comment with /fast-forward to fast forward main to debug-log-print.

black7375 commented 2 months ago

/fast-forward

github-actions[bot] commented 2 months ago

Triggered from https://github.com/mincho-js/mincho/pull/41#issuecomment-2241499686 by @black7375.

Trying to fast forward main (47e2bf3b0a94503ea94b90bb6869c2bcd0f00e8a) to debug-log-print (4975f3afe25ea520e053c25016e5384e2bac63cf).

Target branch (main):

commit 47e2bf3b0a94503ea94b90bb6869c2bcd0f00e8a (HEAD -> main, origin/main, origin/HEAD)
Author: alstjr7375 <alstjr7375@daum.net>
Date:   Sun Jul 21 14:24:27 2024 +0900

    Docs: Apply suggestions from code review #39

Pull request (debug-log-print):

commit 4975f3afe25ea520e053c25016e5384e2bac63cf (pull_request/debug-log-print)
Author: alstjr7375 <alstjr7375@daum.net>
Date:   Sun Jul 21 15:46:21 2024 +0900

    Fix: DebugLog - declare type with function overload #40

Fast forwarding main (47e2bf3b0a94503ea94b90bb6869c2bcd0f00e8a) to debug-log-print (4975f3afe25ea520e053c25016e5384e2bac63cf).

$ git push origin 4975f3afe25ea520e053c25016e5384e2bac63cf:main
To https://github.com/mincho-js/mincho.git
   47e2bf3..4975f3a  4975f3afe25ea520e053c25016e5384e2bac63cf -> main

mincho-js / mincho