search

eggjs / tegg

Strong Type framework with eggjs.
MIT License
240 stars 35 forks source link

feat: add dump switcher #252

Closed gxkl closed 3 weeks ago

gxkl commented 3 weeks ago
Checklist
Affected core subsystem(s)
Description of change

Summary by CodeRabbit

coderabbitai[bot] commented 3 weeks ago

Walkthrough

The pull request introduces updates to the @eggjs/tegg-standalone project by adding a new development dependency and enhancing the configuration options for module loading. Specifically, a dump property is added to both the EggModuleLoaderOptions and RunnerOptions interfaces, allowing for conditional dumping of module descriptors. Additionally, the test suite is modified to validate the new functionality, ensuring that the dump method behaves correctly based on the specified options.

Changes

File Path Change Summary
standalone/standalone/package.json Added new development dependency: "mm": "^3.2.1" in devDependencies.
standalone/standalone/src/EggModuleLoader.ts Added optional property dump?: boolean to EggModuleLoaderOptions. Modified generateAppGraph to conditionally dump module descriptors based on options.dump.
standalone/standalone/src/Runner.ts Updated RunnerOptions to include dump?: boolean;. Modified constructor and loadUnitLoader to utilize the dump option.
standalone/standalone/test/index.test.ts Added imports for mocking and dumping. Introduced beforeEach hook for restoring mocks. Added tests for main function to check behavior with and without dump option.

Possibly related PRs

Poem

🐇 In the land of code where rabbits play,
New dependencies hop in, brightening the day.
With dump options added, our modules align,
Testing their behavior, all will be fine!
So let’s celebrate changes, both big and small,
In the world of coding, we’re having a ball! 🎉

📜 Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
📥 Commits Files that changed from the base of the PR and between a1bd4562e08533bef84b2495167cd6609d5f3d48 and 5fc779b998b8521a0598357cdd2920a8038aef4d.
📒 Files selected for processing (2) * standalone/standalone/src/EggModuleLoader.ts (2 hunks) * standalone/standalone/src/Runner.ts (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (2) * standalone/standalone/src/EggModuleLoader.ts * standalone/standalone/src/Runner.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 - [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 , 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 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](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](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
gxkl commented 3 weeks ago

Successfully published: