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

refact: use packages/mako for js entry package #1010

Merged
merged 1 commit into from
Apr 3, 2024
Merged

Conversation

sorrycc
Copy link
Member

@sorrycc sorrycc commented Apr 3, 2024

.

Summary by CodeRabbit

  • New Features
    • Added "father": "^4.4.0" and "typescript": "^5.4.3" dependencies.
    • Introduced configuration for the CommonJS output directory in the Mako package.
    • Added scripts for building and releasing in package.json.
    • Restructured functionality of the release.ts script.
    • Added an error throwing statement in cli.ts for unimplemented functionality.
    • Exported functionality from binding.ts in index.ts.
  • Refactor
    • Refined a comment related to chunk splitting in generate_chunks.rs.
    • Adjusted formatting in binding.js for improved readability.
  • Documentation
    • Removed deprecated documentation about project structure in CONTRIBUTING.md.
  • Chores
    • Updated build commands and artifact paths.
    • Adjusted paths and targets for building and stripping node modules.
    • Updated comments for consistency in release.ts.
    • Extended base configuration in tsconfig.json.

Copy link
Contributor

coderabbitai bot commented Apr 3, 2024

Walkthrough

The changes encompass updates to build configurations, removal of deprecated documentation, refinements in code comments, dependency additions, and restructuring of scripts for building and releasing. These modifications aim to enhance project efficiency, streamline processes, and improve code readability and maintainability.

Changes

File(s) Change Summary
.github/workflows/node-bind-build.yml Update build commands and artifact paths for different platforms.
CONTRIBUTING.md Remove deprecated documentation on project structure and mako core crate details.
crates/mako/src/generate_chunks.rs Refine comment on chunk splitting and generation.
crates/node/.cargo/config.toml Retain rustflags setting for aarch64-unknown-linux-musl target.
package.json Add "father": "^4.4.0" and "typescript": "^5.4.3" dependencies.
packages/mako/... Introduce configuration, gitignore rules, scripts, and file updates for the Mako package.
scripts/release.ts Restructure script functionality with improved logic, error handling, and detailed logging.
packages/mako/src/... Update code formatting and readability without changing logic.
tsconfig.json Introduce compiler options for TypeScript with directory exclusions.

Poem

In code we weave, paths adjust and scripts dance,
Dependencies new, old docs bid farewell in a trance.
Rabbit's touch refines, like a poet's rhyme,
Building blocks rearrange in rhythm and time. 🐇✨
Tech whispers secrets, in files and config's chime.

Note

Pull Request Summarized by CodeRabbit Free

Your organization is on the Free plan. CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please upgrade your subscription to CodeRabbit Pro by visiting https://coderabbit.ai


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 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.

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.
  • Please see the configuration documentation 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/coderabbit-overrides.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@sorrycc sorrycc merged commit 7d58a6f into master Apr 3, 2024
8 checks passed
@delete-merged-branch delete-merged-branch bot deleted the sorrycc-2hv5 branch April 3, 2024 06:15
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.

1 participant