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

Fix for: Build should stop if npm fails #4513 #4556

Merged
merged 1 commit into from
Feb 15, 2025
Merged

Conversation

spiro-c
Copy link
Contributor

@spiro-c spiro-c commented Feb 15, 2025

Fixes #4513

This will check if Node,js is present in path and will continue to build WLED

node

or it will cancel the build and show error

node-ex

Summary by CodeRabbit

  • Chores
    • Improved the build process to verify required dependencies before proceeding.
    • Now displays clear error messages if any prerequisites are missing.
    • Ensures a smoother build execution by installing necessary packages only when conditions are met.

Copy link

coderabbitai bot commented Feb 15, 2025

Walkthrough

The pull request modifies the build UI script to enhance its error handling and control flow. The script now uses double quotes for importing the environment module and adds the shutil module. It checks for Node.js by calling shutil.which("node"), printing an error and executing a no-op if Node.js is not found. When Node.js is available, the script installs necessary node packages using npm install and then runs the build command via npm run build, exiting with an error code upon failure.

Changes

File(s) Change Summary
pio-scripts/build_ui.py - Changed env import to use double quotes.
- Added import for shutil.
- Introduced a check for Node.js using shutil.which("node").
- Prints an error and executes a no-op command if Node.js is missing.
- Executes npm install and npm run build with error handling.
✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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: 0

🧹 Nitpick comments (2)
pio-scripts/build_ui.py (2)

8-8: Consider using a more explicit no-op command.

Instead of "null", consider using a more standard no-op command like ":" (colon) which is a built-in shell no-op command.

-    exitCode = env.Execute("null")
+    exitCode = env.Execute(":")
🧰 Tools
🪛 Ruff (0.8.2)

8-8: Undefined name env

(F821)


7-7: Consider extracting ANSI color codes into constants.

The ANSI color codes are duplicated and could be hard to maintain. Consider extracting them into named constants at the top of the file.

# Add at the top of the file
ERROR_STYLE = '\x1b[0;31;43m'
SUCCESS_STYLE = '\x1b[6;33;42m'
RESET_STYLE = '\x1b[0m'

# Then use them in the messages
print(ERROR_STYLE + 'Node.js is not installed...' + RESET_STYLE)

Also applies to: 12-12, 20-20

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a0c55c6 and 778cecb.

📒 Files selected for processing (1)
  • pio-scripts/build_ui.py (1 hunks)
🧰 Additional context used
🪛 Ruff (0.8.2)
pio-scripts/build_ui.py

1-1: Undefined name Import

(F821)


8-8: Undefined name env

(F821)


13-13: Undefined name env

(F821)


16-16: Undefined name env

(F821)

🔇 Additional comments (2)
pio-scripts/build_ui.py (2)

1-2: LGTM! Good use of shutil for executable checking.

Using shutil.which() is the recommended way to check for executables in the system PATH.

🧰 Tools
🪛 Ruff (0.8.2)

1-1: Undefined name Import

(F821)


10-21: LGTM! Good error handling and user feedback.

The implementation successfully:

  • Runs npm commands in the correct order
  • Checks for failures and aborts the build when needed
  • Provides helpful error messages with documentation links
🧰 Tools
🪛 Ruff (0.8.2)

13-13: Undefined name env

(F821)


16-16: Undefined name env

(F821)

@netmindz netmindz merged commit 2b9ff31 into wled:main Feb 15, 2025
20 checks passed
@spiro-c spiro-c deleted the npm-check branch February 16, 2025 00:11
netmindz added a commit that referenced this pull request Feb 22, 2025
Fix for: Build should stop if npm fails #4513
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.

Build should stop if npm fails
2 participants