Skip to content

Commit d555f5c

Browse files
committed
Add command execution flow diagram
1 parent 5f95fcb commit d555f5c

File tree

2 files changed

+47
-0
lines changed

2 files changed

+47
-0
lines changed

docs/command-execution.puml

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
@startuml
2+
skinparam ParticipantPadding 20
3+
skinparam BoxPadding 10
4+
5+
header "v0.1.0"
6+
footer ""
7+
8+
title "Command execution flow"
9+
caption ""
10+
11+
box "Extension"
12+
participant Popup as "popup.js"
13+
participant Background as "background.js"
14+
end box
15+
participant Host as "host"
16+
participant Command as "command"
17+
18+
== Commands listing ==
19+
20+
[-> Popup : List available commands
21+
Popup ->> Background : ListCommands JSON-RPC/2.0
22+
Background -> Host: ListCommands JSON-RPC/2.0
23+
24+
Host -> Host : Load configuration file
25+
Host --> Background : JSON-RPC/2.0 result
26+
27+
Background -->> Popup : JSON-RPC/2.0 result
28+
Popup -->[ : Display commands listing
29+
30+
== Command execution ==
31+
32+
[-> Popup : Run selected command
33+
Popup ->> Background : RunCommand JSON-RPC/2.0
34+
Popup -->[ : Hide commands listing
35+
36+
Background -> Host : RunCommand JSON-RPC/2.0
37+
Host -> Host : Prepare runtime environment
38+
Host -> Command ** : Execute command
39+
...
40+
opt "if command sends something to STDOUT stream"
41+
Command --> Host : STDOUT
42+
Host ->> Background : JSON-RPC/2.0 result
43+
Background ->>[ : Display notification
44+
end
45+
...
46+
Command --> Host : Exit 0
47+
@enduml

docs/command-execution.puml.png

62.2 KB
Loading

0 commit comments

Comments
 (0)