software-mansion / software-mansion/cairo-debugger
Add `test` and `debug` profiles in Scarb
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 7
- Forks
- 2
- Avg merge
- 5d 2h
- Merged PRs (30d)
- 1
Description
It is mostly for convenience.
-
debugprofile - name TBD
TODO:debugprofile should have all the things debugger needs turned on by default (e.g.skip-optimizations = true). We can make it a default profile used bysnforge test --launch-debugger- mind that it would require changes in debug lenses logic in LS. Feel free to create appropriate follow-up tasks after taking on this issue.
Effect: better UX when using debugger. -
testprofile
TODO:testprofile should have the same settings asdevbut withsierra-replace-ids = false. It would serve the same function as in Cargo. Then we can make test targets in scarb respectsierra-replace-ids- currently it has it hardcoded tofalse. Rationale for hardcoding it tofalsewas that tests in projects such as garaga would crash with OOM ifsierra-replace-ids = truewas respected (which is the default fordevprofile).
Effect: better devX forcairo-debuggerdevelopers (ability to obtain human readable sierra in tests)
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with Scarb's existing profile configuration and scarb/src/compiler/compilers/test.rs, where sierra-replace-ids is currently hardcoded to false. Read the debug lenses logic in the language server before deciding how the debug profile should be wired in. Done means test and debug profiles have the specified behavior and test targets respect the test profile setting.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- build-system, developer-experience, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100