Skip to content

Commit 9e1d76a

Browse files
committed
Document how to create a VSCode task to rerun StepUp
1 parent 080451f commit 9e1d76a

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

stepup/core/interact.py

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,33 @@
5252
so you don't need to set it.
5353
This is only needed if processes other than subprocesses need to interact with the director,
5454
as in this example.
55+
56+
You can define a
57+
[Custom Task in VSCode](https://code.visualstudio.com/docs/editor/tasks#_custom-tasks)
58+
to rerun StepUp with the following `tasks.json` file:
59+
60+
```json
61+
{
62+
"version": "2.0.0",
63+
"tasks": [
64+
{
65+
"label": "StepUp run",
66+
"type": "shell",
67+
"command": "STEPUP_DIRECTOR_SOCKET=$(python -c 'import stepup.core.director; \
68+
print(stepup.core.director.get_socket())') python -c 'from stepup.core.interact import run; run()'",
69+
"options": {"cwd": "./path/from/project/root/to/stepup/root/"},
70+
"presentation": {
71+
"echo": true,
72+
"reveal": "silent",
73+
"focus": false,
74+
"panel": "shared",
75+
"showReuseMessage": false,
76+
"clear": true
77+
}
78+
}
79+
]
80+
}
81+
```
5582
"""
5683

5784
from .api import RPC_CLIENT, translate

0 commit comments

Comments
 (0)