coze-js icon indicating copy to clipboard operation
coze-js copied to clipboard

feat: use @coze-infra/rslib-config

Open wfc-web opened this issue 11 months ago • 2 comments

feat: use @coze-infra/rslib-config

Summary by CodeRabbit

Release Notes

  • New Features

    • Introduced two new packages: @coze-infra/rslib-config and @coze-infra/rsbuild-config.
    • Added new executable commands for both packages.
    • Updated build and start scripts in the web example project to use the rsbuild tool.
  • Bug Fixes

    • Adjusted the basename prop in the Router component to ensure proper routing when PUBLIC_URL is undefined.
  • Documentation

    • New ESLint and TypeScript configuration files added for both rslib-config and rsbuild-config.
  • Chores

    • Updated .gitignore to refine ignored files and directories.

wfc-web avatar Dec 03 '24 07:12 wfc-web

Walkthrough

This pull request introduces two new configuration packages, @coze-infra/rslib-config and @coze-infra/rsbuild-config, which provide standardized build and configuration settings for various projects. The changes involve creating new package configurations, updating existing project dependencies, and modifying build scripts across multiple packages. The primary goal appears to be centralizing and standardizing build configurations, development tools, and package management across the project ecosystem.

Changes

File Change Summary
config/rslib-config/package.json New package configuration for @coze-infra/rslib-config with build and lint scripts
packages/coze-js/package.json, packages/realtime-api/package.json Added @coze-infra/rslib-config as dev dependency, removed @rslib/core
packages/coze-js/rslib.config.ts, packages/realtime-api/rslib.config.ts Replaced local configuration with imported getRslibConfig from new package
rush.json Added new projects for @coze-infra/rslib-config and @coze-infra/rsbuild-config
examples/coze-js-web/package.json Updated scripts to use rsbuild, added new dependencies

Sequence Diagram

sequenceDiagram
    participant Dev as Developer
    participant Config as @coze-infra/rslib-config
    participant Build as Build System
    
    Dev->>Config: Import configuration
    Config-->>Dev: Provide standardized config
    Dev->>Build: Execute build/lint
    Build->>Config: Retrieve build settings
    Config-->>Build: Return configuration details

Possibly related PRs

  • #15: Package dependency updates related to @coze-infra/rslib-config
  • #27: Implementation of build formats using new configuration package
  • #34: Potential demo utilizing new configuration package
  • #44: ChatX demo potentially leveraging new configurations
  • #46: Workflow setup that might use new package functionalities

Suggested Reviewers

  • Tecvan-fe
  • jsongo

Poem

🐰 Configs dancing, neat and bright, Rush and build with pure delight! Packages aligned, scripts so clean, A rabbit's dream of dev routine! Hop, hop, hooray for config's might! 🚀


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
🪧 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>, 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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 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 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.

coderabbitai[bot] avatar Dec 03 '24 07:12 coderabbitai[bot]

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.


wfc seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

CLAassistant avatar May 28 '25 06:05 CLAassistant