Some files for debugging via VSCode #604

Hecatron · 2021-10-28T20:20:58Z

I've added some files for debugging under Visual Studio Code
This should allow for stepping through the code / breakpoints etc

I'd recommend the following to use it

LLVM (For the LLDB Debugger) installed and on the path
VSCode Extension - CodeLLDB
VSCode Extension - "rust-analyser" (not the "rust" one)
VSCode Extension - "Task Explorer"
VSCode Extension - "crates"

sagiegurari · 2021-10-29T06:10:34Z

not sure about this one. i use nvim myself, but even if i would use vscode, i would prefer not to have stuff injected into my project or get pushed by mistake.
this feels like something we can expand on in the documentation, in the IDE support section. maybe have the files in the documentation folder and link to them from the readme.
wdyt?

Hecatron · 2021-10-29T09:50:33Z

I've relocated the vscode files into the docs directory, although I'm not sure how to integrate them into Jekyl since I don't have ruby installed.
Also added .vscode to .gitignore
and updated the readme

For the readme I added a small development section at the bottom, but I wasn't sure if that should be in the Contributing page instead.
Let me know if any other changes are needed.

sagiegurari

you put the vscode files in the right place.
the docs, you need to modify the md files (content and nav md files) which are used

in the github.io site as is
used to generate the full readme md

sagiegurari · 2021-10-31T13:09:07Z

.gitignore

@@ -9,3 +9,4 @@ dump.rdb
 /rs*.sh
 /docs/_site
 /core
+/.vscode


i think we can remove this entry.

This should now be done

sagiegurari · 2021-10-31T13:09:39Z

README.md

@@ -113,6 +113,7 @@
 * [Roadmap](#roadmap)
 * [Editor Support](#editor-support)
 * [Contributing](.github/CONTRIBUTING.md)
+* [Development](#development)


this is a generated file. you can look at the doc folder, and you will see a sub folder with templates for the nav and content md files.
so this goes to the nav.
also, we should not add a new section, instead lets use the Editor Support section that already exists and talks about vim.

sagiegurari · 2021-10-31T13:10:42Z

README.md

+
+### VSCode
+
+For debugging purposes there are some example .vscode files located within the [docs/vscode-example](./docs/vscode-example) directory


sagiegurari · 2021-10-31T13:11:12Z

README.md

@@ -3477,6 +3478,32 @@ You can view the future development items list in the [github project issues](ht
 ## Contributing
 See [contributing guide](.github/CONTRIBUTING.md)

+<a name="development"></a>
+## Development


lets move this whole thing under 'editor support' and maybe create sub section for vim and vscode (vim already exists).

codecov-commenter · 2021-10-31T13:20:09Z

Codecov Report

Merging #604 (b3c9b68) into 0.35.7 (f02b0b9) will decrease coverage by 25.62%.
The diff coverage is n/a.

@@             Coverage Diff             @@
##           0.35.7     #604       +/-   ##
===========================================
- Coverage   93.51%   67.89%   -25.63%     
===========================================
  Files          98       98               
  Lines       19390    19624      +234     
===========================================
- Hits        18132    13323     -4809     
- Misses       1258     6301     +5043

Impacted Files	Coverage Δ
src/lib/storage_test.rs	`0.00% <0.00%> (-100.00%)`	⬇️
src/lib/proxy_task_test.rs	`0.00% <0.00%> (-100.00%)`	⬇️
src/lib/recursion_level_test.rs	`0.00% <0.00%> (-100.00%)`	⬇️
src/lib/scriptengine/rsscript.rs	`0.00% <0.00%> (-92.99%)`	⬇️
src/lib/cli_test.rs	`5.11% <0.00%> (-91.70%)`	⬇️
src/lib/scriptengine/rsscript_test.rs	`0.00% <0.00%> (-86.62%)`	⬇️
src/lib/environment/mod_test.rs	`11.91% <0.00%> (-83.83%)`	⬇️
src/lib/legacy_test.rs	`17.64% <0.00%> (-82.36%)`	⬇️
src/lib/runner_test.rs	`29.74% <0.00%> (-61.11%)`	⬇️
src/lib/profile_test.rs	`40.27% <0.00%> (-59.73%)`	⬇️
... and 50 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f02b0b9...b3c9b68. Read the comment docs.

sagiegurari · 2021-11-02T05:53:46Z

@grbd just want to make sure you saw the comments in this PR

sagiegurari · 2021-11-29T09:28:40Z

@grbd friendly ping :)
you don't really need jekyl for this PR. just look at the generated md files.

Hecatron · 2021-11-29T16:11:58Z

Ok I think I've resolved all the above now

sagiegurari · 2021-11-29T16:48:14Z

docs/vscode-example/tasks.json

+                "clean"
+            ]
+        },
+        {


i'll change this one to use the cargo-make formatter task.
it comes with built in support to auto install rustfmt

sagiegurari · 2021-11-29T16:48:36Z

docs/_includes/content.md

+### Rust Format
+
+After making changes to the code, rustfmt can be used to automatically reformat the code within the repository
+```
+# To install
+rustup component add rustfmt
+# To run on the cargo project
+cargo fmt
+```
+


i'll remove this one as cargo make comes with built in formatting task that auto installs it for you

sagiegurari · 2021-11-29T16:49:19Z

docs/vscode-example/tasks.json

+        {
+            "label": "run the tests",
+            "detail": "Run the tests",
+            "type": "process",
+            "group": "build",
+            "command": "cargo",
+            "args": [
+                "test"
+            ]
+        },


i'll also change this one to use the cargo make test which knows to run multi phase tests (tests for single thread + multi thread + custom tasks for tests)

sagiegurari · 2021-11-29T16:50:45Z

thanks @grbd
i'll be doing changes after merge to use the cargo-make tasks and not cargo commands as they do a lot more (including auto install rustfmt, run multi phase tests and so on...)

Hecatron · 2021-11-29T19:21:48Z

Ok, the bit I added about using cargo fmt
was just a reminder to use cargo fmt after changing any code to check for any formatting issues before submitting changes to the cargo-make repo.

sagiegurari · 2021-11-30T18:13:29Z

@grbd thanks for the PR. i'm merging it and i'll make few changes as i commented on the files themselves.

Hecatron added 2 commits October 28, 2021 21:16

Added vscode files

ca25e01

formatting update

b673a0a

Hecatron added 3 commits October 29, 2021 10:35

relocate vscode files to docs directory

ea016e1

added root vscode dir to gitignore

92e0041

Change to readme

75c0175

Add list of vscode extensions to readme

1896efa

sagiegurari requested changes Oct 31, 2021

View reviewed changes

sagiegurari changed the base branch from master to 0.35.6 October 31, 2021 13:13

sagiegurari changed the base branch from 0.35.6 to 0.35.7 November 1, 2021 15:47

sagiegurari added this to the 0.35.7 milestone Nov 8, 2021

sagiegurari added the documentation label Nov 29, 2021

Hecatron added 4 commits November 29, 2021 15:52

remove .vscode from gitignore

0ecf5ef

updates docs content

8008107

doc updates

6bf47d5

updates to readme

b3c9b68

sagiegurari approved these changes Nov 29, 2021

View reviewed changes

sagiegurari merged commit e1d0bd1 into sagiegurari:0.35.7 Nov 30, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Some files for debugging via VSCode #604

Some files for debugging via VSCode #604

Hecatron commented Oct 28, 2021

sagiegurari commented Oct 29, 2021

Hecatron commented Oct 29, 2021

sagiegurari left a comment

sagiegurari Oct 31, 2021

Hecatron Nov 29, 2021

sagiegurari Oct 31, 2021

sagiegurari Oct 31, 2021

sagiegurari Oct 31, 2021

codecov-commenter commented Oct 31, 2021 •

edited

sagiegurari commented Nov 2, 2021

sagiegurari commented Nov 29, 2021

Hecatron commented Nov 29, 2021

sagiegurari Nov 29, 2021

sagiegurari Nov 29, 2021

sagiegurari Nov 29, 2021

sagiegurari commented Nov 29, 2021

Hecatron commented Nov 29, 2021

sagiegurari commented Nov 30, 2021


		### VSCode

		For debugging purposes there are some example .vscode files located within the [docs/vscode-example](./docs/vscode-example) directory

Some files for debugging via VSCode #604

Some files for debugging via VSCode #604

Conversation

Hecatron commented Oct 28, 2021

sagiegurari commented Oct 29, 2021

Hecatron commented Oct 29, 2021

sagiegurari left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov-commenter commented Oct 31, 2021 • edited

Codecov Report

sagiegurari commented Nov 2, 2021

sagiegurari commented Nov 29, 2021

Hecatron commented Nov 29, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sagiegurari commented Nov 29, 2021

Hecatron commented Nov 29, 2021

sagiegurari commented Nov 30, 2021

codecov-commenter commented Oct 31, 2021 •

edited