dojoengine / dojo.js

Official JavaScript packages for Dojo.
https://dojoengine.github.io/dojo.js/
MIT License
28 stars 47 forks source link

feat: wasm, cleanup packages, adds event streaming #258

Closed ponderingdemocritus closed 2 months ago

ponderingdemocritus commented 2 months ago

Summary by CodeRabbit

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

Walkthrough

The updates across multiple package.json files for the @dojoengine packages involve modifications to the description and author fields, indicating a rebranding effort. Descriptions have been revised for clarity and specificity, while author fields have been consolidated under "dojo." Additionally, some packages received updates to the main entries, exports, and sideEffects to enhance structure and compatibility, particularly for web and Node.js environments. New TypeScript files have been introduced to define contract interactions and models for the Dojo framework.

Changes

File Path Change Summary
packages/core/package.json Updated description for clarity; changed author from "Loaf" to "dojo".
packages/create-burner/package.json Changed description to prefix with "dojo: ".
packages/create-dojo/package.json Modified description for specificity; added author as "dojo".
packages/react/package.json Revised description for clarity; updated author from "Loaf" to "dojo".
packages/state/package.json Enhanced description to specify state syncing in dojo games; changed author from "Loaf" to "dojo".
packages/torii-client/package.json Altered description for clarity; changed author from "Dojo" to "dojo".
packages/torii-wasm/package.json Updated description; populated author with "ohayo"; adjusted main, added exports, and sideEffects for better structure.
packages/utils-wasm/package.json Changed description to "dojo: wasm utils"; updated author to "dojo".
packages/utils/package.json Modified description to "dojo: utils"; changed author from "Loaf" to "dojo".
examples/clients/react/react-app/src/dojo/createClientComponents.ts Updated import path for ContractComponents from ./generated/contractComponents to ./typescript/models.gen.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant PackageManager
    participant Package

    User->>PackageManager: Install package
    PackageManager->>Package: Fetch metadata
    Package-->>PackageManager: Return updated metadata
    PackageManager-->>User: Provide package with new metadata

🐰 In the land of code where the bunnies play,
πŸ‡ The packages danced in a brand new way.
With "dojo" they hop, and descriptions refined,
A clearer path for all bunnies to find.
So let’s celebrate with cheer and delight,
For changes so bright, they shine in the night! ✨


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.