Feat: Support ESM-CJS compatibility for debug-log #38

black7375 commented 1 month ago

Description

Load the package synchronously to make it available to CommonJS as well.

Related Issue

Summary by CodeRabbit

New Features
- Added new dependencies for improved type support and asynchronous operations.
Improvements
- Enhanced module loading process by switching to dynamic imports for better compatibility with ES modules.

Additional context

Checklist

coderabbitai[bot] commented 1 month ago

Walkthrough

The updates enhance the packages/debug-log project by adding new dependencies to support asynchronous operations and improving module loading compatibility. The changes involve implementing dynamic imports for chalk and boxen, addressing previous compatibility issues with ES modules. This refactor ensures the application waits for necessary modules before proceeding, streamlining functionality and supporting ongoing development.

Changes

Files	Change Summary
`packages/debug-log/package.json`	Added `@types/deasync` and `deasync` to `devDependencies` for improved type support and functionality.
`packages/debug-log/src/index.ts`	Switched from static to dynamic imports for `chalk` and `boxen`, enhancing compatibility with ES modules.

Poem

In the code where rabbits hop,
New imports make the laughter stop.
With deasync, we wait in cheer,
As chalk and boxen draw near.
Hopping through modules, oh what a sight,
Our code now dances with delight! 🐇✨

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 1 month ago

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

Checking if we can fast forward main (c06046b8b00308c4d855c831a68a3178770b32e4) to esm-cjs (26fa10a13819f6be20e8c52e267572763b52cb67).

Target branch (main):

commit c06046b8b00308c4d855c831a68a3178770b32e4 (HEAD -> main, origin/main, origin/HEAD)
Author: JeongJun <rgfdds98@gmail.com>
Date:   Sun Jul 28 17:43:34 2024 +0900

    Fix: rewrite gitignore and yarnrc.yml #51

Pull request (esm-cjs):

commit 26fa10a13819f6be20e8c52e267572763b52cb67 (pull_request/esm-cjs)
Author: alstjr7375 <alstjr7375@daum.net>
Date:   Mon Jul 29 14:17:15 2024 +0900

    Fix: Remove `test-debug-log` #38

Can't fast forward main (c06046b8b00308c4d855c831a68a3178770b32e4) to esm-cjs (26fa10a13819f6be20e8c52e267572763b52cb67). main (c06046b8b00308c4d855c831a68a3178770b32e4) is not a direct ancestor of esm-cjs (26fa10a13819f6be20e8c52e267572763b52cb67). Branches appear to have diverged at b8c0760d3717922cf3d3f18a8a83e0ab5cd82b60:

* 26fa10a13819f6be20e8c52e267572763b52cb67 Fix: Remove `test-debug-log` #38
* 5bd15ec9a6cf9c350f2dc99d239aebedf86fbe1f Fix: Sync package load with deasync #38
* 3360b125ab025dcd1c1e4847b4ab3428cb13c344 Feat: Experimenting with ESM-CJS compatibility #38
| * c06046b8b00308c4d855c831a68a3178770b32e4 Fix: rewrite gitignore and yarnrc.yml #51
|/  
* b8c0760d3717922cf3d3f18a8a83e0ab5cd82b60 Fix: changed dependency lib #38

commit b8c0760d3717922cf3d3f18a8a83e0ab5cd82b60
Author: JeongJun <rgfdds98@gmail.com>
Date:   Sun Jul 28 17:07:38 2024 +0900

    Fix: changed dependency lib #38

Rebase locally, and then force push to esm-cjs.

github-actions[bot] commented 1 month ago

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

Checking if we can fast forward main (c06046b8b00308c4d855c831a68a3178770b32e4) to esm-cjs (5b86d9e553e839a49b1ebdeae47859b4c1a5c541).

Target branch (main):

commit c06046b8b00308c4d855c831a68a3178770b32e4 (HEAD -> main, origin/main, origin/HEAD)
Author: JeongJun <rgfdds98@gmail.com>
Date:   Sun Jul 28 17:43:34 2024 +0900

    Fix: rewrite gitignore and yarnrc.yml #51

Pull request (esm-cjs):

commit 5b86d9e553e839a49b1ebdeae47859b4c1a5c541 (pull_request/esm-cjs)
Author: alstjr7375 <alstjr7375@daum.net>
Date:   Mon Jul 29 14:24:25 2024 +0900

    Fix: Remove `test-debug-log` #38

It is possible to fast forward main (c06046b8b00308c4d855c831a68a3178770b32e4) to esm-cjs (5b86d9e553e839a49b1ebdeae47859b4c1a5c541). If you have write access to the target repository, you can add a comment with /fast-forward to fast forward main to esm-cjs.

mincho-js / mincho