JS to TS : simulator/src/app.ts

[nickhil-verma]

trafficstars

Fixes #414

Describe the changes you have made in this PR -

Screenshots of the changes (If any) -

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

Summary by CodeRabbit

Release Notes

• New Features

  • Enhanced element display in the Elements Panel with improved name visibility and styling
  • Added TypeScript interfaces for better type safety in circuit simulation

• Refactoring

  • Replaced JavaScript loading module with TypeScript implementation
  • Updated project management logic for handling new projects

• Improvements

  • Streamlined circuit loading and initialization process
  • Simplified project creation workflow

[coderabbitai[bot]]

Walkthrough

This pull request focuses on migrating simulator-related files from JavaScript to TypeScript and refactoring the project's data loading and management components. The changes include converting load.js to load.ts, adding new TypeScript interfaces in app.ts, and modifying project management logic in project.ts. Additionally, the ElementsPanel.vue component receives UI improvements for displaying element names more clearly.

Changes

File	Change Summary
src/components/Panels/ElementsPanel/ElementsPanel.vue	Added new <div> elements to display element names with improved styling in search results
src/simulator/src/app.ts	Introduced new TypeScript interfaces: Device, Connector, and Circuit; converted js variable to a typed constant
src/simulator/src/data/load.js	Deleted JavaScript file with loading-related functions
src/simulator/src/data/load.ts	New TypeScript file replacing load.js with enhanced type safety and loading functions
src/simulator/src/data/project.ts	Modified project creation logic and commented out onbeforeunload event handler

Assessment against linked issues

Objective	Addressed	Explanation
Typescript Integration in /simulator/src files [#414]	✅

Possibly related PRs

• #384: Changes in ProjectProperty.vue related to UI template structure modifications

Poem

🐰 In circuits and code, a rabbit's delight, TypeScript weaves types with algorithmic might Elements dance, interfaces gleam bright From JavaScript's shadows to a type-safe height A digital warren of logic takes flight! 🖥️

✨ 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

• X
• Mastodon
• Reddit
• LinkedIn

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

[netlify[bot]]

✅ Deploy Preview for circuitverse ready!

Name	Link
🔨 Latest commit	aedba883a3f4abf7e2a489a433699575f212677d
🔍 Latest deploy log	https://app.netlify.com/sites/circuitverse/deploys/67920175a88257000890eae1
😎 Deploy Preview	https://deploy-preview-426--circuitverse.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

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