feat: Desktop Application for Vue Simulator [Tauri] #374
Conversation
WalkthroughThe changes encompass updates to several configuration files and components within the project. Key modifications include the introduction of Tauri support, adjustments to build commands, and enhancements to file handling methods. The Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant App
participant Tauri
participant Server
User->>App: Initiate file download
App->>App: Determine environment (Tauri or Web)
alt Tauri
App->>Tauri: Call downloadImageDesktop()
Tauri->>Tauri: Fetch image data
Tauri->>User: Save image to downloads directory
else Web
App->>App: Call downloadFileWeb()
App->>User: Trigger browser download
end
Recent review detailsConfiguration used: CodeRabbit UI Files selected for processing (1)
Files skipped from review as they are similar to previous changes (1)
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? TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
src/simulator/src/node.js
Outdated
| @@ -255,7 +255,7 @@ | |||
| * function for saving a node | |||
| */ | |||
| saveObject() { | |||
| if (this.type == NODE_INTERMEDIATE2) { | |||
| if (this.type == NODE_INTERMEDIATE) { | |||
Check failure
Code scanning / ESLint
disallow the use of undeclared variables unless mentioned in `/*global */` comments Error
✅ Deploy Preview for circuitverse ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (18)
package-lock.jsonis excluded by!**/package-lock.jsonsrc-tauri/Cargo.lockis excluded by!**/*.locksrc-tauri/icons/128x128.pngis excluded by!**/*.pngsrc-tauri/icons/[email protected]is excluded by!**/*.pngsrc-tauri/icons/32x32.pngis excluded by!**/*.pngsrc-tauri/icons/Square107x107Logo.pngis excluded by!**/*.pngsrc-tauri/icons/Square142x142Logo.pngis excluded by!**/*.pngsrc-tauri/icons/Square150x150Logo.pngis excluded by!**/*.pngsrc-tauri/icons/Square284x284Logo.pngis excluded by!**/*.pngsrc-tauri/icons/Square30x30Logo.pngis excluded by!**/*.pngsrc-tauri/icons/Square310x310Logo.pngis excluded by!**/*.pngsrc-tauri/icons/Square44x44Logo.pngis excluded by!**/*.pngsrc-tauri/icons/Square71x71Logo.pngis excluded by!**/*.pngsrc-tauri/icons/Square89x89Logo.pngis excluded by!**/*.pngsrc-tauri/icons/StoreLogo.pngis excluded by!**/*.pngsrc-tauri/icons/cvlogo.pngis excluded by!**/*.pngsrc-tauri/icons/icon.icois excluded by!**/*.icosrc-tauri/icons/icon.pngis excluded by!**/*.png
Files selected for processing (16)
- .gitignore (1 hunks)
- netlify.toml (1 hunks)
- package.json (3 hunks)
- src-tauri/.gitignore (1 hunks)
- src-tauri/Cargo.toml (1 hunks)
- src-tauri/build.rs (1 hunks)
- src-tauri/src/main.rs (1 hunks)
- src-tauri/tauri.conf.json (1 hunks)
- src/components/DialogBox/ExportProject.vue (2 hunks)
- src/components/DialogBox/ExportVerilog.vue (2 hunks)
- src/components/DialogBox/OpenOffline.vue (1 hunks)
- src/simulator/src/data/project.ts (1 hunks)
- src/simulator/src/node.js (1 hunks)
- src/simulator/src/plotArea.js (2 hunks)
- src/simulator/src/utils.ts (4 hunks)
- vite.config.ts (2 hunks)
Files skipped from review due to trivial changes (4)
- .gitignore
- src-tauri/.gitignore
- src-tauri/build.rs
- src/components/DialogBox/ExportVerilog.vue
Additional context used
GitHub Check: ESLint
src/simulator/src/node.js
[failure] 258-258: disallow the use of undeclared variables unless mentioned in
/*global */comments
'NODE_INTERMEDIATE' is not defined.
Additional comments not posted (32)
netlify.toml (2)
2-2: LGTM!The change to use a direct reference to the
publicdirectory simplifies the path and reduces potential errors.
7-7: LGTM! But verify the path usage in the codebase.The change to the destination path for
index.htmlsuggests a restructuring of the output directory layout. Ensure that this change is reflected in other parts of the codebase that reference this path.Run the following script to verify the path usage:
Verification successful
Path change is correctly implemented.
The change to the destination path for
index.htmlis properly handled within thenetlify.tomlfile. The command ensures thatindex.htmlis moved to the correct location for deployment, and there are no other references to this path that need adjustment.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify all references to the new path for `index.html`. # Test: Search for the path usage. Expect: Only occurrences of the new path. rg --type toml -A 5 $'./dist/output/index.html'Length of output: 316
src-tauri/src/main.rs (3)
1-1: LGTM!The comment is informative and should not be removed.
2-2: LGTM!The
cfg_attrattribute is correctly used to prevent an additional console window on Windows in release mode.
4-8: LGTM!The main function is correctly implemented to initialize and run the Tauri application.
src-tauri/Cargo.toml (5)
1-10: LGTM!The
[package]section is correctly configured with metadata about the package.
12-12: LGTM!The comment is informative and should not be removed.
14-16: LGTM!The
[build-dependencies]section is correctly configured with a dependency ontauri-build.
17-20: LGTM!The
[dependencies]section is correctly configured with dependencies onserde_json,serde, andtauri.
22-26: LGTM!The
[features]section is correctly configured with a custom protocol feature.src-tauri/tauri.conf.json (5)
3-7: LGTM!The build section is correctly configured for the Tauri application.
8-11: LGTM!The package section is correctly configured.
12-22: LGTM! But consider narrowing the scope for file system access.The allowlist section is correctly configured, but the scope for file system access is very broad. Consider narrowing it down to specific directories if possible.
23-54: LGTM!The bundle section is correctly configured for the Tauri application.
62-70: LGTM!The windows section is correctly configured for the Tauri application.
vite.config.ts (3)
32-32: LGTM!Using an environment variable for the base URL enhances flexibility for different deployment environments.
34-45: LGTM!The build section is correctly configured for the Vite build tool.
57-60: LGTM!The server section is correctly configured for the Vite build tool.
package.json (3)
6-9: LGTM!The scripts section is correctly configured for the project.
18-18: LGTM!The dependencies section is correctly configured for the project.
48-48: LGTM!The devDependencies section is correctly configured for the project.
src/components/DialogBox/ExportProject.vue (2)
44-44: LGTM!The import statement change from
downloadtodownloadFileis approved.
76-76: LGTM!The function call change from
downloadtodownloadFileis approved.src/components/DialogBox/OpenOffline.vue (1)
70-70: LGTM!The change from
reactivetoreffor theprojectListvariable is approved.src/simulator/src/data/project.ts (1)
96-96: Verify the data format before storing.The
saveOfflinefunction no longer serializes thedataobject before saving it to local storage. Ensure thatdatais already in a suitable format for storage.Run the following script to verify the data format:
src/simulator/src/utils.ts (5)
13-14: LGTM!The new imports from
@tauri-apps/api/fsand@tauri-apps/api/pathare necessary for the Tauri-specific functions.
121-127: LGTM!The
downloadFilefunction correctly determines the environment and calls the appropriate download function.
Line range hint
130-142: LGTM!The
downloadFileWebfunction correctly handles web-based file downloads.
148-157: LGTM!The
downloadFileDesktopfunction correctly handles desktop-based file downloads using the Tauri API.
292-294: LGTM!The
isTaurifunction correctly checks if the application is running in a Tauri environment.src/simulator/src/plotArea.js (2)
112-116: LGTM!The
downloadfunction correctly integrates the new Tauri-specific download logic.
124-148: LGTM!The
downloadImageDesktopfunction correctly handles desktop-based image downloads using the Tauri API.
|
could you explore adding native menu? |
|
You can also add github action for release https://github.com/tauri-apps/tauri-action |
|
@niladrix719 Could you fix the git conflict ? |
…into desktop-app
There was a problem hiding this comment.
Actionable comments posted: 1
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (1)
package-lock.jsonis excluded by!**/package-lock.json
Files selected for processing (6)
- package.json (3 hunks)
- src/simulator/src/data.js (1 hunks)
- src/simulator/src/listeners.js (3 hunks)
- src/simulator/src/plotArea.js (2 hunks)
- src/simulator/src/utils.ts (4 hunks)
- vite.config.ts (2 hunks)
Files skipped from review as they are similar to previous changes (1)
- src/simulator/src/data.js
Additional context used
GitHub Check: ESLint
src/simulator/src/listeners.js
[failure] 27-27: disallow unused variables
'lineTo' is defined but never used.
Additional comments not posted (33)
vite.config.ts (5)
33-33: LGTM!Using an environment variable for the
baseproperty is a good practice for flexible deployments.
35-35: LGTM!The change in the output directory structure is noted and looks good.
37-37: LGTM!Increasing the
chunkSizeWarningLimitto accommodate larger chunks without triggering warnings is a reasonable change.
38-46: LGTM!The addition of
rollupOptionswith themanualChunksfunction is a good approach for optimizing the chunking behavior and improving performance.
71-71: LGTM!Enabling external access to the server by setting the
hostproperty totrueis a helpful change for enhancing the development experience.package.json (5)
6-6: LGTM!The
servescript has been updated to usecross-envfor setting theVITE_BASE_URLenvironment variable, which is a good practice for cross-platform compatibility.
7-7: LGTM!The
buildscript has been enhanced with the following changes:
- Using
cross-envfor setting theVITE_BASE_URLenvironment variable to./, indicating that the built application will be served from the current directory.- Adding the
--mode buildflag to specify the build mode, which could be used to apply specific configurations or optimizations.- Including the
--emptyOutDirflag to ensure that the output directory is emptied before the build, preventing stale files.These changes improve the build process and provide more control over the build output.
8-8: LGTM!The
devscript has been updated to usecross-envfor setting theVITE_BASE_URLenvironment variable, aligning with the changes made to theservescript. This ensures consistency in the base URL during development.
9-9: LGTM!The new
tauriscript has been added to integrate with the Tauri framework for building desktop applications. It usescross-envto set theVITE_BASE_URLenvironment variable to/simulatorvue/, ensuring that the application is served from the correct base URL when running with Tauri.
19-19: LGTM!The following dependencies have been added to the project:
@tauri-apps/apiand@tauri-apps/cli: These dependencies are related to the Tauri framework, indicating that the project is integrating with Tauri for building desktop applications.cross-env: This dependency is used in the scripts to set environment variables in a cross-platform manner.dotenv: This dependency is commonly used for loading environment variables from a.envfile.The versions of the dependencies are properly specified, and the additions align with the changes made to the scripts and the integration with Tauri.
Also applies to: 49-49, 54-55
src/simulator/src/utils.ts (4)
121-127: LGTM!The
downloadFilefunction provides a clean and modular approach to handle file downloads across different environments. It abstracts away the platform-specific details and offers a unified interface, enhancing code maintainability and readability.
Line range hint
130-145: LGTM!The
downloadFileWebfunction follows a standard approach for triggering file downloads in web applications. It creates a temporary anchor element, sets the necessary attributes, and simulates a click event to initiate the download. The code is self-contained and does not introduce any external dependencies.
148-157: LGTM!The
downloadFileDesktopfunction utilizes the Tauri API to handle file downloads in a desktop environment. It retrieves the downloads directory, constructs the appropriate file path, and writes the provided text content to the specified file. The code leverages the capabilities of the Tauri framework to provide a seamless file download experience for desktop users.
346-348: LGTM!The
isTaurifunction provides a simple and effective way to check if the application is running in a Tauri environment. By checking for the presence of thewindow.__TAURI__property, it allows the codebase to conditionally execute Tauri-specific code or fallback to alternative implementations. This enhances code flexibility and adaptability to different environments.src/simulator/src/plotArea.js (2)
113-124: LGTM!The changes to the
downloadfunction look good. It correctly checks for the Tauri environment and calls the appropriate download method based on the environment.
126-150: Excellent implementation!The
downloadImageDesktopfunction is well-implemented and follows the necessary steps to download the canvas image as a file in a desktop environment using the Tauri API. It handles the image data conversion, file path construction, and binary data writing correctly. The inclusion of error handling ensures that any issues during the download process are caught and logged appropriately.src/simulator/src/listeners.js (17)
37-38: LGTM!The imports are valid and used appropriately in the file.
789-790: LGTM!The
zoomSliderListenersfunction is implemented correctly and sets up the necessary event listeners for the zoom slider.
791-792: LGTM!The comment is informative and helps in understanding the purpose of the subsequent code.
793-795: LGTM!The event listener for the
new-projectevent is set up correctly and calls the appropriate method oflogixFunction.
797-799: LGTM!The event listener for the
save_onlineevent is set up correctly and calls the appropriate method oflogixFunction.
801-803: LGTM!The event listener for the
save_offlineevent is set up correctly and calls the appropriate method oflogixFunction.
805-807: LGTM!The event listener for the
open_offlineevent is set up correctly and calls the appropriate method oflogixFunction.
809-811: LGTM!The event listener for the
exportevent is set up correctly and calls the appropriate method oflogixFunction.
813-815: LGTM!The event listener for the
importevent is set up correctly and calls the appropriate method oflogixFunction.
817-819: LGTM!The event listener for the
recoverevent is set up correctly and calls the appropriate method oflogixFunction.
821-823: LGTM!The event listener for the
clearevent is set up correctly and calls the appropriate method oflogixFunction.
825-827: LGTM!The event listener for the
preview_circuitevent is set up correctly and calls the appropriate method oflogixFunction.
829-831: LGTM!The event listener for the
new-circuitevent is set up correctly and calls the appropriate method oflogixFunction.
833-835: LGTM!The event listener for the
new-verilog-moduleevent is set up correctly and calls the appropriate method oflogixFunction.
837-839: LGTM!The event listener for the
insert-sub-circuitevent is set up correctly and calls the appropriate method oflogixFunction.
841-843: LGTM!The event listener for the
combinational-analysisevent is set up correctly and calls the appropriate method oflogixFunction.
845-879: LGTM!The event listeners for various events are set up correctly and call the appropriate methods of
logixFunction.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Desktop Application for Vue Simulator using Tauri
Screen.Recording.2024-08-26.at.11.02.34.PM.mov
Summary by CodeRabbit
New Features
Bug Fixes
Chores
.gitignorefiles to streamline version control.