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

chore: add local serve command #2521

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

MrKou47
Copy link
Member

@MrKou47 MrKou47 commented Jan 20, 2025

Summary by CodeRabbit

  • Chores
    • Added a new development script to simplify local development workflow
    • Configured environment and build settings for development mode

Copy link

coderabbitai bot commented Jan 20, 2025

Walkthrough

The pull request introduces a new development script in the package.json file. This script configures a development environment using cross-env to set specific environment variables, enabling module-based builds with Rollup in watch mode and inline source map generation. The addition provides developers with a streamlined command for running the project during development.

Changes

File Change Summary
package.json Added new "dev" script with cross-env configuration for development environment

Poem

🐰 A dev script hops into view,
Rollup watches with maps so true,
Modules dance in development's light,
Cross-env sets the build just right,
A rabbit's script, lean and bright! 🚀


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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (1)
package.json (1)

13-13: Consider consolidating watch scripts to reduce duplication.

The new "dev" script is very similar to the existing "watch" script, differing only in NODE_ENV. Consider using a single script with an environment parameter.

-    "watch": "cross-env NODE_ENV=release BUILD_TYPE=MODULE rollup -cw -m inline",
-    "dev": "cross-env NODE_ENV=development BUILD_TYPE=MODULE rollup -cw -m inline",
+    "watch": "cross-env BUILD_TYPE=MODULE rollup -cw -m inline",
+    "dev": "cross-env NODE_ENV=development pnpm watch",
+    "watch:prod": "cross-env NODE_ENV=release pnpm watch",

Also applies to: 15-15

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b274e2e and 6624012.

📒 Files selected for processing (1)
  • package.json (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: build (22.x, windows-latest)
  • GitHub Check: e2e (22.x)
  • GitHub Check: codecov

@@ -12,6 +12,7 @@
"lint": "eslint packages/*/src --ext .ts",
"watch": "cross-env NODE_ENV=release BUILD_TYPE=MODULE rollup -cw -m inline",
"watch:umd": "cross-env NODE_ENV=release BUILD_TYPE=UMD rollup -cw -m inline",
"dev": "cross-env NODE_ENV=development BUILD_TYPE=MODULE rollup -cw -m inline",
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Add serve functionality to match PR objectives.

The PR title mentions adding a local serve command, but the new "dev" script doesn't include any server functionality. Consider utilizing the rollup-plugin-serve package that's already listed in devDependencies.

Here's how to add server functionality:

-    "dev": "cross-env NODE_ENV=development BUILD_TYPE=MODULE rollup -cw -m inline",
+    "dev": "cross-env NODE_ENV=development BUILD_TYPE=MODULE rollup -cw -m inline --config rollup.config.serve.js",

Then create a new rollup.config.serve.js that extends your base config and adds the serve plugin:

import serve from 'rollup-plugin-serve';
import baseConfig from './rollup.config.js';

export default {
  ...baseConfig,
  plugins: [
    ...baseConfig.plugins,
    serve({
      contentBase: 'dist',
      port: 3000
    })
  ]
};

Copy link

codecov bot commented Jan 20, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.58%. Comparing base (15e7b8b) to head (6624012).
Report is 3 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2521      +/-   ##
==========================================
- Coverage   69.01%   68.58%   -0.44%     
==========================================
  Files         957      957              
  Lines      100052   100068      +16     
  Branches     8554     8563       +9     
==========================================
- Hits        69054    68628     -426     
- Misses      30742    31184     +442     
  Partials      256      256              
Flag Coverage Δ
unittests 68.58% <ø> (-0.44%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@GuoLei1990 GuoLei1990 added the ignore for release ignore for release label Jan 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ignore for release ignore for release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants