doc: add windows generated project mock test workaround #374
Conversation
There was a problem hiding this comment.
Pull request overview
This pull request adds Windows-specific documentation to help users work around a known issue with mock tests in generated projects. The workaround involves manually installing the native ckb-debugger binary and disabling the WASM debugger until an upstream fix is applied.
Changes:
- Added comprehensive Windows user instructions for setting up
ckb-debuggermanually - Included step-by-step installation guide with PATH configuration
- Documented how to disable WASM debugger in mock test files
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ``` | ||
| - The `-c` option is optional, if not provided, the contract name defaults to `hello-world`. | ||
|
|
||
| **Note for Windows Users:** |
There was a problem hiding this comment.
Inconsistent capitalization: This line uses "Windows Users" (capital U) while line 58 of the same file uses "Windows users" (lowercase u). For consistency with the existing note, this should be "Windows users".
| - Comment out or delete the `verifier.setWasmDebuggerEnabled(true)` line: | ||
| ```typescript | ||
| // When using native ckb-debugger, comment out or delete the following line: |
There was a problem hiding this comment.
The comment in the code example is slightly inconsistent with the actual template code. The template files at lines 32-33 of both .mock.test.ts.template and .mock.test.js.template show the comment "if you are using the native ckb-debugger, you can delete the following line." However, this documentation says "When using native ckb-debugger, comment out or delete the following line". Consider aligning the wording more closely with the template, or updating the templates to match this documentation.
| - Comment out or delete the `verifier.setWasmDebuggerEnabled(true)` line: | |
| ```typescript | |
| // When using native ckb-debugger, comment out or delete the following line: | |
| - Delete the `verifier.setWasmDebuggerEnabled(true)` line: | |
| ```typescript | |
| // if you are using the native ckb-debugger, you can delete the following line: |
No description provided.