Skip to content

refactor: remove jQuery from circuit.js and use Vue reactivity #575

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

blazethunderstorm
Copy link

@blazethunderstorm blazethunderstorm commented Jun 5, 2025

Fixes #433

Describe the changes you have made in this PR -

Removed remaining jQuery from circuit.js and migrated DOM logic to Vue reactivity.

Note: Please check Allow edits from maintainers. if you would like us to assist in the PR.

Summary by CodeRabbit

  • Refactor
    • Improved UI event handling by migrating from jQuery to Vue components for circuit management.
    • Removed outdated and commented-out jQuery code for cleaner, more maintainable codebase.
    • Enhanced clarity with updated comments and minor code cleanup.

Copy link

netlify bot commented Jun 5, 2025

Deploy Preview for circuitverse ready!

Name Link
🔨 Latest commit ae2f7e9
🔍 Latest deploy log https://app.netlify.com/projects/circuitverse/deploys/6841dad68474740008bcb96c
😎 Deploy Preview https://deploy-preview-575--circuitverse.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 37 (🔴 down 9 from production)
Accessibility: 72 (no change from production)
Best Practices: 92 (no change from production)
SEO: 80 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link
Contributor

coderabbitai bot commented Jun 5, 2025

Walkthrough

This change removes remaining jQuery-based UI event handling and DOM manipulation code from the circuit management logic, replacing it with comments noting migration to Vue components and reactive state updates. The update clarifies the separation of UI logic from core circuit logic, with no changes to public function signatures or core data structures.

Changes

Files Change Summary
v1/src/simulator/src/circuit.js Removed commented-out jQuery event handlers and DOM manipulation; clarified migration to Vue; updated internal logic for focus state to use Vue reactivity; cleaned up comments and unused imports.

Assessment against linked issues

Objective (Issue #) Addressed Explanation
Remove jQuery and DOM manipulation logic; migrate to Vue reactives and components (#433)

Assessment against linked issues: Out-of-scope changes

No out-of-scope changes were found.

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

npm error Exit handler never called!
npm error This is an error with npm itself. Please report this error at:
npm error https://github.com/npm/cli/issues
npm error A complete log of this run can be found in: /.npm/_logs/2025-06-05T18_00_29_361Z-debug-0.log

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

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
Contributor

@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 (1)
v1/src/simulator/src/circuit.js (1)

271-282: Consider removing commented line for cleaner code.

The commented line about activeCircuit.value.name should either be implemented if needed or removed to keep the code clean.

  const index = circuit_list.value.findIndex((circuit) => circuit.id === id)
  circuit_list.value[index].name = name
- // activeCircuit.value.name = name // add later if necessary at current stage not important handled by projectProperty on switching circuit
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f64c366 and ae2f7e9.

📒 Files selected for processing (1)
  • v1/src/simulator/src/circuit.js (6 hunks)
🔇 Additional comments (3)
v1/src/simulator/src/circuit.js (3)

87-90: Excellent migration to Vue reactivity!

The replacement of jQuery class toggling with Vue reactive state updates is well-implemented. The code correctly clears the focussed state of all circuits before setting the new focused circuit, maintaining the same logical behavior while leveraging Vue's reactivity system.


236-249: Clear documentation of Vue migration.

The updated comments effectively document the migration of jQuery event handlers to Vue components. This provides good context for future developers understanding why certain jQuery code is commented out.


206-210:

✅ Verification successful

Verify Verilog state management logic.

The comment indicates "Reset all other circuits' verilog state" but the code sets isVerilog = false for all circuits, then immediately sets the last circuit's isVerilog = true. This seems to implement exclusive Verilog state (only one circuit can be Verilog at a time).

Please verify this is the intended behavior. If multiple circuits should be able to have Verilog state simultaneously, this logic needs adjustment:


🏁 Script executed:

#!/bin/bash
# Search for other references to isVerilog property to understand intended behavior
rg -A 3 -B 3 "isVerilog.*=" --type js

Length of output: 8977


Verilog state exclusivity confirmed.

The newCircuit function in v1/src/simulator/src/circuit.js (lines 206–210) deliberately clears every circuit’s isVerilog flag then sets it only on the newly added/loaded circuit, matching the // Reset all other circuits' verilog state comment. This enforces a single Verilog circuit at a time.

• v1/src/simulator/src/circuit.js:206–210 – reset loop enforces exclusive isVerilog state

If you intend to allow multiple circuits to carry Verilog state simultaneously, you’ll need to remove or adjust that reset loop.

@blazethunderstorm
Copy link
Author

@Arnabdaz @niladrix719 can you pls review this pr , thanks

@ThatDeparted2061
Copy link
Member

Thanks for the PR but we don't want ts integration in v0 or v1 at the moment, You can try it for files which dont have pre-existing PRs

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.

Removal of JQuery to Vue's reactives
2 participants