qgraphflow 0.0.6 → 0.0.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.claude-plugin/marketplace.json +1 -1
- package/.claude-plugin/plugin.json +1 -1
- package/.codex-plugin/plugin.json +2 -2
- package/.cursor-plugin/plugin.json +1 -1
- package/.qoder-plugin/plugin.json +1 -1
- package/README.md +119 -70
- package/docs/clients.de.md +15 -24
- package/docs/clients.es.md +15 -24
- package/docs/clients.ja.md +15 -24
- package/docs/clients.md +15 -24
- package/docs/clients.pt.md +15 -24
- package/docs/clients.ru.md +15 -24
- package/docs/clients.zh-CN.md +15 -24
- package/docs/readme/README.de.md +120 -71
- package/docs/readme/README.es.md +120 -71
- package/docs/readme/README.ja.md +120 -71
- package/docs/readme/README.pt.md +120 -71
- package/docs/readme/README.ru.md +120 -71
- package/docs/readme/README.zh-CN.md +106 -59
- package/examples/jeepay/README.md +23 -0
- package/examples/jeepay/capabilities.graph.json +270 -0
- package/examples/jeepay/class.graph.json +237 -0
- package/examples/jeepay/collection.graph.json +3057 -0
- package/examples/jeepay/dataflow.graph.json +212 -0
- package/examples/jeepay/deployment.graph.json +222 -0
- package/examples/jeepay/engineering.graph.json +277 -0
- package/examples/jeepay/er.graph.json +482 -0
- package/examples/jeepay/flowchart.graph.json +312 -0
- package/examples/jeepay/relations.graph.json +289 -0
- package/examples/jeepay/sequence.graph.json +355 -0
- package/examples/jeepay/source.json +95 -0
- package/examples/jeepay/state.graph.json +175 -0
- package/examples/jeepay/usecase.graph.json +222 -0
- package/package.json +14 -3
- package/skills/q-flow/SKILL.md +28 -20
- package/skills/q-flow/agents/openai.yaml +1 -1
- package/skills/q-flow/assets/viewer/package.json +1 -1
- package/skills/q-flow/assets/viewer/src/architecture-overview-theme.js +22 -0
- package/skills/q-flow/assets/viewer/src/architecture-overview.js +340 -0
- package/skills/q-flow/assets/viewer/src/diagrams/architecture.js +8 -5
- package/skills/q-flow/assets/viewer/src/diagrams/card.js +35 -17
- package/skills/q-flow/assets/viewer/src/diagrams/deployment.js +7 -5
- package/skills/q-flow/assets/viewer/src/diagrams/drawing.js +5 -2
- package/skills/q-flow/assets/viewer/src/diagrams/registry.js +10 -0
- package/skills/q-flow/assets/viewer/src/diagrams/sequence.js +13 -7
- package/skills/q-flow/assets/viewer/src/edge-routing.js +43 -22
- package/skills/q-flow/assets/viewer/src/export-svg.js +27 -5
- package/skills/q-flow/assets/viewer/src/graph-validation.js +72 -15
- package/skills/q-flow/assets/viewer/src/i18n-messages.json +184 -8
- package/skills/q-flow/assets/viewer/src/layout-compaction.js +123 -0
- package/skills/q-flow/assets/viewer/src/layout-measure.js +14 -8
- package/skills/q-flow/assets/viewer/src/layout-policy.js +6 -0
- package/skills/q-flow/assets/viewer/src/layout-quality.js +61 -15
- package/skills/q-flow/assets/viewer/src/layout-refinement.js +271 -0
- package/skills/q-flow/assets/viewer/src/layout-semantics.js +8 -0
- package/skills/q-flow/assets/viewer/src/layout-spacing.js +23 -4
- package/skills/q-flow/assets/viewer/src/layout-templates.js +298 -0
- package/skills/q-flow/assets/viewer/src/node-svg.js +1 -1
- package/skills/q-flow/assets/viewer/src/orthogonal-routing.js +475 -0
- package/skills/q-flow/assets/viewer/src/presentation-graph.js +31 -0
- package/skills/q-flow/assets/viewer/src/route-clearance.js +144 -0
- package/skills/q-flow/assets/viewer/src/sequence-executions.js +22 -0
- package/skills/q-flow/assets/viewer/src/sequence-fragments.js +20 -2
- package/skills/q-flow/assets/viewer/src/session-graph.js +46 -3
- package/skills/q-flow/assets/viewer/src/text-layout.js +33 -6
- package/skills/q-flow/assets/viewer/src/view-identity.js +26 -0
- package/skills/q-flow/assets/viewer/src/visual-style.js +13 -5
- package/skills/q-flow/assets/viewer-dist/index.html +30 -28
- package/skills/q-flow/references/evidence-sources.md +7 -5
- package/skills/q-flow/references/graph-common.md +34 -34
- package/skills/q-flow/references/graph-schema.md +28 -7
- package/skills/q-flow/references/guided-intake.md +51 -71
- package/skills/q-flow/references/layout-routing.md +47 -0
- package/skills/q-flow/references/types/architecture.md +42 -22
- package/skills/q-flow/references/types/class.md +9 -2
- package/skills/q-flow/references/types/dataflow.md +11 -4
- package/skills/q-flow/references/types/deployment.md +11 -3
- package/skills/q-flow/references/types/er.md +8 -1
- package/skills/q-flow/references/types/flowchart.md +12 -5
- package/skills/q-flow/references/types/sequence.md +20 -16
- package/skills/q-flow/references/types/state.md +10 -3
- package/skills/q-flow/references/types/usecase.md +6 -0
- package/skills/q-flow/references/viewer-development.md +37 -24
- package/skills/q-flow/references/visual-contract.md +12 -6
- package/skills/q-flow/scripts/compile-layout.mjs +85 -102
- package/skills/q-flow/scripts/compile-sequence.mjs +4 -21
- package/skills/q-flow/scripts/generate-viewer.mjs +18 -9
- package/skills/q-flow/scripts/validate-graph.mjs +38 -21
- package/examples/order-flow.graph.json +0 -94
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "qgraphflow",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.7",
|
|
4
4
|
"description": "Generate evidence-grounded interactive software diagrams with offline HTML, SVG and PNG export.",
|
|
5
5
|
"author": {
|
|
6
6
|
"name": "Max Zheng"
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
"skills": "./skills/",
|
|
9
9
|
"interface": {
|
|
10
10
|
"displayName": "QGraphFlow",
|
|
11
|
-
"shortDescription": "Architecture and flow diagrams:
|
|
11
|
+
"shortDescription": "Architecture and flow diagrams: eleven kinds of interactive software diagrams from source, configuration and documents",
|
|
12
12
|
"longDescription": "Generate flow, architecture, sequence, ER, deployment, class, state, use-case and data-flow diagrams from CodeGraph or raw repository evidence; deliver an offline HTML viewer and an auditable graph.json with in-page SVG and PNG download.",
|
|
13
13
|
"developerName": "Max Zheng",
|
|
14
14
|
"category": "Productivity",
|
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<div align="center">
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
<h1><picture><source media="(prefers-color-scheme: dark)" srcset="docs/images/brand/qgraphflow-lockup-dark.svg"><img src="docs/images/brand/qgraphflow-lockup-light.svg" alt="QGraphFlow" height="64"></picture></h1>
|
|
4
4
|
|
|
5
5
|
### Turn complex code into diagrams you can explore.
|
|
6
6
|
|
|
@@ -10,17 +10,25 @@ Follow the path. Inspect the evidence. Share one offline file.
|
|
|
10
10
|
|
|
11
11
|
[English](README.md) · [中文](docs/readme/README.zh-CN.md) · [Русский](docs/readme/README.ru.md) · [Português](docs/readme/README.pt.md) · [日本語](docs/readme/README.ja.md) · [Deutsch](docs/readme/README.de.md) · [Español](docs/readme/README.es.md)
|
|
12
12
|
|
|
13
|
-
[Live demo](https://supermax92.github.io/qgraphflow/) · [Client installation](#installation-guide) · [Report an issue](https://github.com/supermax92/qgraphflow/issues) · [MIT](LICENSE)
|
|
13
|
+
[Live demo](https://supermax92.github.io/qgraphflow/) · [Getting started](#getting-started) · [Client installation](#installation-guide) · [Report an issue](https://github.com/supermax92/qgraphflow/issues) · [MIT](LICENSE)
|
|
14
14
|
|
|
15
15
|
</div>
|
|
16
16
|
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
*Nine diagram types: architecture, flowchart, sequence, ER, deployment, class, state, use case and data flow.*
|
|
17
|
+
*Eleven diagram types: platform capability architecture, engineering layer architecture, component relationship architecture, flowchart, sequence, ER, deployment, class, state, use case and data flow.*
|
|
20
18
|
|
|
21
19
|
QGraphFlow turns source code, schemas, configuration and requirements into interactive software diagrams, with evidence you can inspect and an offline HTML file you can share.
|
|
22
20
|
|
|
23
|
-
**What sets it apart:**
|
|
21
|
+
**What sets it apart:** eleven diagram types from one skill, an evidence kind on every relationship and the source line behind each code-backed one, automatic layout, editing in the page, and no network requests from the plugin scripts or the Viewer itself.
|
|
22
|
+
|
|
23
|
+

|
|
24
|
+
|
|
25
|
+
Using real Jeepay source code, switch between component relationship architecture, sequence and ER diagrams to explore components and call relationships. [View full-size GIF](https://github.com/supermax92/qgraphflow/releases/download/showcase-v2/jeepay.en.hero.gif)
|
|
26
|
+
|
|
27
|
+
**Complex sequence diagram showcase**
|
|
28
|
+
|
|
29
|
+

|
|
30
|
+
|
|
31
|
+
A fictional e-commerce scenario contains 9 participants, 29 messages and 6 combined fragments, covering stock retries, nested branches, parallel processing, failure compensation and asynchronous callbacks. The animation progressively reveals the generated diagram to show its structure and details. [View full-size GIF](https://github.com/supermax92/qgraphflow/releases/download/showcase-v2/checkout.en.sequence-drawing.gif)
|
|
24
32
|
|
|
25
33
|
```bash
|
|
26
34
|
npx skills add supermax92/qgraphflow
|
|
@@ -30,21 +38,67 @@ One command installs the skill for Claude Code, Codex, Cursor and Qoder; the [in
|
|
|
30
38
|
|
|
31
39
|
- **Explore:** search, zoom and pan; inspect responsibilities and upstream/downstream relationships.
|
|
32
40
|
|
|
33
|
-

|
|
34
|
-
|
|
35
41
|
- **Verify:** inspect nodes and edges for source files, lines, symbols and explicitly marked uncertainty.
|
|
36
42
|
|
|
37
|
-

|
|
38
|
-
|
|
39
43
|
- **Edit:** unlock the layout, change text and move elements; reset when needed.
|
|
40
44
|
|
|
41
|
-

|
|
42
|
-
|
|
43
45
|
- **Share:** open offline HTML or export the complete diagram as SVG / PNG.
|
|
44
46
|
|
|
45
|
-
|
|
47
|
+
The real-source [Jeepay corpus](examples/jeepay) contains all eleven views used by CI and the live demo.
|
|
48
|
+
|
|
49
|
+
## Getting started
|
|
50
|
+
|
|
51
|
+
After installation, open your application project in the client and select the `q-flow` skill. These examples use Claude Code's `/q-flow`; in Codex, use the `$q-flow` or `$qgraphflow:q-flow` entry actually provided by your client. Not installed yet? Read the [installation guide](#installation-guide) first.
|
|
52
|
+
|
|
53
|
+
### 1. Empty input: Not sure where to start
|
|
54
|
+
|
|
55
|
+
Invoke the skill without adding a request:
|
|
56
|
+
|
|
57
|
+
```text
|
|
58
|
+
/q-flow
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
The skill guides you to choose the part to analyze and the question the diagram should answer. Drawing starts once the necessary information is clear.
|
|
62
|
+
|
|
63
|
+
### 2. Ask about capabilities: Learn what it can draw
|
|
64
|
+
|
|
65
|
+
```text
|
|
66
|
+
/q-flow What types of diagrams can you draw? What questions does each type answer? I have just taken over a project; introduce your capabilities and suggest a starting point.
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
Learn what the eleven diagram types are for, then decide whether to explore project structure, call order, data relationships or something else.
|
|
70
|
+
|
|
71
|
+
### 3. Vague input: Only a general goal
|
|
72
|
+
|
|
73
|
+
```text
|
|
74
|
+
/q-flow Help me draw this project. I want to understand it as quickly as possible.
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
You do not need to specify a diagram type first. The skill selects a suitable view based on the project and your goal, and asks follow-up questions when necessary information is missing.
|
|
78
|
+
|
|
79
|
+
### 4. Precise input: Define the scope and request drawing details
|
|
80
|
+
|
|
81
|
+
Replace the business names and steps below with flows that actually exist in your project:
|
|
82
|
+
|
|
83
|
+
```text
|
|
84
|
+
/q-flow Analyze the order creation flow in the current project and generate a sequence diagram in Chinese.
|
|
85
|
+
Cover the request entry point, pricing, stock reservation, payment authorization and order persistence.
|
|
86
|
+
Retain the synchronous calls, asynchronous messages, paired returns, activation bars, conditional branches, retries and failure compensation that actually exist in the source. Do not omit details for brevity.
|
|
87
|
+
Mark the source files and line numbers for components and calls, and save the result to docs/qgraphflow/order-sequence/.
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
State the subject, question, level of detail and output location clearly to start directly. The diagram retains only facts supported by evidence.
|
|
91
|
+
|
|
92
|
+
### 5. Refine further: Expand part of the previous diagram
|
|
93
|
+
|
|
94
|
+
After the result is generated, continue in the same conversation:
|
|
95
|
+
|
|
96
|
+
```text
|
|
97
|
+
/q-flow Expand the stock reservation step in the previous sequence diagram into a separate flowchart in Chinese.
|
|
98
|
+
Show all branches for stock validation, successful reservation, retryable failures, the retry limit and stock release. Follow the source code and add no steps absent from it.
|
|
99
|
+
```
|
|
46
100
|
|
|
47
|
-
|
|
101
|
+
Start with the overall picture, then explore one step in depth. You can also request more detail in an existing diagram or verify its relationships.
|
|
48
102
|
|
|
49
103
|
## Installation guide
|
|
50
104
|
|
|
@@ -62,9 +116,18 @@ To install it as a plugin instead, follow the steps below. [Qoder Desktop](#qode
|
|
|
62
116
|
|
|
63
117
|
### 1. Download the plugin
|
|
64
118
|
|
|
65
|
-
|
|
119
|
+
Get the plugin from npmjs.com; no account, login or token is needed. Create a separate directory outside your application project:
|
|
120
|
+
|
|
121
|
+
```bash
|
|
122
|
+
mkdir qgraphflow-install
|
|
123
|
+
cd qgraphflow-install
|
|
124
|
+
npm install qgraphflow --ignore-scripts
|
|
125
|
+
cd node_modules/qgraphflow
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
You are now in the plugin root. **Downloading through npm does not automatically install the plugin in your client;** continue with step 2. The package also provides the `qgraphflow` command used in [Keep diagrams in sync with code](#keep-diagrams-in-sync-with-code).
|
|
66
129
|
|
|
67
|
-
Run the following terminal commands from **the
|
|
130
|
+
Run the following terminal commands from **the plugin root containing `skills/`**.
|
|
68
131
|
|
|
69
132
|
### 2. Install in your client
|
|
70
133
|
|
|
@@ -81,17 +144,8 @@ Start a new session, type `$`, and select `qgraphflow:q-flow`.
|
|
|
81
144
|
|
|
82
145
|
#### Claude Code
|
|
83
146
|
|
|
84
|
-
Install directly from GitHub without downloading the ZIP:
|
|
85
|
-
|
|
86
147
|
```bash
|
|
87
|
-
claude plugin marketplace add
|
|
88
|
-
claude plugin install qgraphflow@supermax92 --scope user
|
|
89
|
-
```
|
|
90
|
-
|
|
91
|
-
Or, from the extracted plugin root:
|
|
92
|
-
|
|
93
|
-
```bash
|
|
94
|
-
claude plugin marketplace add .
|
|
148
|
+
claude plugin marketplace add ./
|
|
95
149
|
claude plugin install qgraphflow@supermax92 --scope user
|
|
96
150
|
```
|
|
97
151
|
|
|
@@ -107,9 +161,9 @@ Start a new session and select `q-flow`.
|
|
|
107
161
|
|
|
108
162
|
#### Qoder Desktop
|
|
109
163
|
|
|
110
|
-
**Recommended:** Open **Settings → Plugins → Marketplace**, search for
|
|
164
|
+
**Recommended:** Open **Settings → Plugins → Marketplace**, search for **QGraphFlow** or **代码图谱可视化**, and install the plugin. Start a new session and select `q-flow`.
|
|
111
165
|
|
|
112
|
-
For local installation, complete step 1, then open **Settings → Plugins → Custom → Import** and import the complete
|
|
166
|
+
For local installation, complete step 1, then open **Settings → Plugins → Custom → Import** and import the complete plugin root directory. Start a new session and select `q-flow`.
|
|
113
167
|
|
|
114
168
|
#### Cursor
|
|
115
169
|
|
|
@@ -123,27 +177,11 @@ Confirm that `.cursor-plugin/plugin.json` exists there, reload the window, and f
|
|
|
123
177
|
|
|
124
178
|
### 3. Start using it
|
|
125
179
|
|
|
126
|
-
Open your project in the client, start a new session
|
|
127
|
-
|
|
128
|
-
<details>
|
|
129
|
-
<summary>Alternative installation: npm</summary>
|
|
130
|
-
|
|
131
|
-
You can also get the plugin from npmjs.com instead of the ZIP; no account, login or token is needed. Create a separate directory outside your application project:
|
|
132
|
-
|
|
133
|
-
```bash
|
|
134
|
-
mkdir qgraphflow-install
|
|
135
|
-
cd qgraphflow-install
|
|
136
|
-
npm install qgraphflow --ignore-scripts
|
|
137
|
-
cd node_modules/qgraphflow
|
|
138
|
-
```
|
|
139
|
-
|
|
140
|
-
You are now in the plugin root. Continue with the client installation steps above. **Downloading through npm does not automatically install the plugin in your client.** The package also provides the `qgraphflow` command used in [Keep diagrams in sync with code](#keep-diagrams-in-sync-with-code).
|
|
141
|
-
|
|
142
|
-
</details>
|
|
180
|
+
Open your application project in the client, start a new session and select the skill. Describe your request using the [Getting started](#getting-started) examples. Open the generated HTML in your browser.
|
|
143
181
|
|
|
144
182
|
Building it yourself? See the [source build instructions](https://github.com/supermax92/qgraphflow/blob/main/docs/distribution.md#prepare-locally).
|
|
145
183
|
|
|
146
|
-
## Quick
|
|
184
|
+
## Quick usage
|
|
147
185
|
|
|
148
186
|
These examples use `$qgraphflow:q-flow` in Codex. If your client shows `$q-flow`, select that entry instead. For other clients, use the skill entry described above.
|
|
149
187
|
|
|
@@ -158,7 +196,7 @@ $qgraphflow:q-flow
|
|
|
158
196
|
### Example 1: Understand the architecture
|
|
159
197
|
|
|
160
198
|
```text
|
|
161
|
-
$qgraphflow:q-flow Analyze
|
|
199
|
+
$qgraphflow:q-flow Analyze the current project and generate an architecture diagram in Chinese, showing the responsibilities of the main modules, dependencies and system boundaries.
|
|
162
200
|
```
|
|
163
201
|
|
|
164
202
|
Useful when joining a project and learning its overall structure.
|
|
@@ -166,13 +204,13 @@ Useful when joining a project and learning its overall structure.
|
|
|
166
204
|
### Example 2: Trace a business flow
|
|
167
205
|
|
|
168
206
|
```text
|
|
169
|
-
$qgraphflow:q-flow Analyze order creation and
|
|
207
|
+
$qgraphflow:q-flow Analyze order creation and generate a sequence diagram in Chinese, showing the call order for pricing, stock reservation, payment and order persistence, and mark failure branches.
|
|
170
208
|
```
|
|
171
209
|
|
|
172
210
|
Replace order creation and its steps with your project's actual flow. Continue in the same conversation:
|
|
173
211
|
|
|
174
212
|
```text
|
|
175
|
-
$qgraphflow:q-flow Expand stock reservation
|
|
213
|
+
$qgraphflow:q-flow Expand the stock reservation step in the previous diagram into a separate flowchart in Chinese, showing success and failure handling.
|
|
176
214
|
```
|
|
177
215
|
|
|
178
216
|
Results go under `docs/qgraphflow/` by default. Open `index.html` to explore, edit and export; `graph.json` retains the graph data. Each view is also written as an SVG (`diagram.svg`, or `diagram-<n>-<type>.svg` for several views) that you can embed as an image in a README, pull request or wiki.
|
|
@@ -180,26 +218,23 @@ Results go under `docs/qgraphflow/` by default. Open `index.html` to explore, ed
|
|
|
180
218
|
After editing in the page, **More → Save changes** in Chrome or Edge rewrites the page, `graph.json` and the SVGs in place once you pick the diagram's folder. Other browsers save `graph.json` only: put it in the folder and regenerate the page and SVGs with `npx -y qgraphflow generate docs/qgraphflow/<name>/graph.json docs/qgraphflow/<name> --layout preserve --force`.
|
|
181
219
|
|
|
182
220
|
<details>
|
|
183
|
-
<summary>Run the
|
|
221
|
+
<summary>Run the eleven-view Jeepay source example</summary>
|
|
184
222
|
|
|
185
|
-
|
|
223
|
+
Select your Jeepay source checkout to verify the evidence:
|
|
186
224
|
|
|
187
225
|
```bash
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
node skills/q-flow/scripts/
|
|
191
|
-
node skills/q-flow/scripts/generate-viewer.mjs examples/showcase/ecommerce.en.graph.json output/ecommerce-en
|
|
226
|
+
export JEEPAY_REPO_ROOT="<local Jeepay repository root>"
|
|
227
|
+
node skills/q-flow/scripts/validate-graph.mjs examples/jeepay/collection.graph.json --input-only --repo-root "$JEEPAY_REPO_ROOT"
|
|
228
|
+
node skills/q-flow/scripts/generate-viewer.mjs examples/jeepay/collection.graph.json output/jeepay --repo-root "$JEEPAY_REPO_ROOT"
|
|
192
229
|
```
|
|
193
230
|
|
|
194
|
-
Open `output/
|
|
195
|
-
|
|
196
|
-
The prebuilt Viewer needs no dependency installation, API key or backend service. AI-assisted evidence gathering and graph authoring use your chosen client's model service.
|
|
231
|
+
Open `output/jeepay/index.html`; its eleven SVGs are in the same directory. See the [corpus README](examples/jeepay) for the source revision and refresh procedure.
|
|
197
232
|
|
|
198
233
|
</details>
|
|
199
234
|
|
|
200
235
|
## Keep diagrams in sync with code
|
|
201
236
|
|
|
202
|
-
A diagram generated with a repository root records where each component is defined. Validating it with `--repo-root` fails when a recorded file is gone, a line range no longer fits, or a recorded symbol has left its lines, and the error names the lines where the symbol is now. Add this job to your CI; it needs no build, login or token:
|
|
237
|
+
A diagram generated with a repository root records where each component is defined and the line behind each code-backed relationship (a call, a foreign key). Validating it with `--repo-root` fails when a recorded file is gone, a line range no longer fits, or a recorded symbol has left its lines, and the error names the lines where the symbol is now. Add this job to your CI; it needs no build, login or token:
|
|
203
238
|
|
|
204
239
|
```yaml
|
|
205
240
|
name: Diagrams
|
|
@@ -227,19 +262,21 @@ $qgraphflow:q-flow CI says docs/qgraphflow/order-sequence is out of date. Refres
|
|
|
227
262
|
|
|
228
263
|
The skill moves anchors whose symbol it finds once, corrects only the anchors still reported, and regenerates the page and SVGs with your edited positions and text kept. It does not redraw the diagram.
|
|
229
264
|
|
|
230
|
-
## What each of the
|
|
265
|
+
## What each of the eleven diagram types answers
|
|
231
266
|
|
|
232
267
|
| View · PNG | Main question | Example scope |
|
|
233
268
|
| --- | --- | --- |
|
|
234
|
-
|
|
|
235
|
-
|
|
|
236
|
-
|
|
|
237
|
-
|
|
|
238
|
-
|
|
|
239
|
-
|
|
|
269
|
+
| Platform capability architecture | What capabilities does the platform provide? | Capability zones and matrices |
|
|
270
|
+
| Engineering layer architecture | How is the engineering code organized? | Engineering layers and shared support |
|
|
271
|
+
| Component relationship architecture | Which responsibility boundaries collaborate in the system? | Channels, transaction orchestration, pricing, risk, stock, payment, orders, events and fulfillment |
|
|
272
|
+
| Flowchart | How does each decision point branch and converge? | Stock shortage, risk rejection, compensation for payment failure and successful commit |
|
|
273
|
+
| Sequence | In what order does a request make calls and receive returns? | Successful checkout main flow and asynchronous OrderPaid |
|
|
274
|
+
| ER | How does core data relate? | Cart, orders, items, payments, stock reservations and parcels |
|
|
275
|
+
| Deployment | Where are runtime units placed and how are they connected? | Edge, Kubernetes, data services, payment and warehouse/logistics networks |
|
|
276
|
+
| Class | How do domain objects and code contracts depend on each other? | Checkout application service, Order and four ports |
|
|
240
277
|
| State | Which events and guards advance an order? | Payment, fulfillment, cancellation, refund and closure |
|
|
241
|
-
| Use case | What
|
|
242
|
-
| Data flow |
|
|
278
|
+
| Use case | What capabilities does each actor have? | Buyer, merchant, warehouse and customer support |
|
|
279
|
+
| Data flow | What transformations and stores do data assets pass through? | Cart, transaction decisions, order events, warehouse/logistics and delivery receipts |
|
|
243
280
|
|
|
244
281
|
This is a concept model demonstrating QGraphFlow, not a particular e-commerce repository. The example `graph.json` invents no source paths and marks relationship evidence as `inference`. Real project diagrams need traceable source, DDL, configuration, tests and accepted requirements.
|
|
245
282
|
|
|
@@ -253,10 +290,22 @@ node --test tests/*.test.mjs skills/q-flow/scripts/*.test.mjs
|
|
|
253
290
|
|
|
254
291
|
Development needs Node.js 22 or later, npm, tar, zip and unzip. Include a minimal redacted graph, client/browser versions and reproduction steps in issue reports.
|
|
255
292
|
|
|
256
|
-
[Evidence sources](skills/q-flow/references/evidence-sources.md) · [Graph format](skills/q-flow/references/graph-schema.md) · [Guided intake](skills/q-flow/references/guided-intake.md) · [Viewer development](skills/q-flow/references/viewer-development.md) · [
|
|
293
|
+
Reference documentation (English): [Evidence sources](skills/q-flow/references/evidence-sources.md) · [Graph data format](skills/q-flow/references/graph-schema.md) · [Guided intake](skills/q-flow/references/guided-intake.md) · [Viewer development and acceptance](skills/q-flow/references/viewer-development.md) · [Visual conventions](skills/q-flow/references/visual-contract.md)
|
|
257
294
|
|
|
258
295
|
## License and attribution
|
|
259
296
|
|
|
260
297
|
[MIT](LICENSE) · [Third-party notices](THIRD_PARTY_NOTICES.md)
|
|
261
298
|
|
|
262
|
-
QGraphFlow is an independent MIT-licensed project. The scenarios in this document are conceptual and do not represent any company's production architecture
|
|
299
|
+
QGraphFlow is an independent MIT-licensed project. The scenarios in this document are conceptual examples and do not represent any real company's production architecture.
|
|
300
|
+
|
|
301
|
+
## Architecture overviews
|
|
302
|
+
|
|
303
|
+
Architecture now includes component relations, platform capabilities and engineering layers. Describe the subject and question; the skill chooses the template. Requested collections can contain multiple architecture views with independent edits.
|
|
304
|
+
|
|
305
|
+
```text
|
|
306
|
+
$qgraphflow:q-flow Analyze this project's platform capabilities and business integration methods, and generate a platform capability overview in Chinese.
|
|
307
|
+
$qgraphflow:q-flow Analyze the organization and component layers of the current project, and generate Chinese overviews of the whole project and a cross-section of one component.
|
|
308
|
+
$qgraphflow:q-flow Generate an English platform capability overview of this project and show how application modules integrate.
|
|
309
|
+
```
|
|
310
|
+
|
|
311
|
+
See [examples/jeepay](examples/jeepay) for real-source platform, engineering and component relationship architecture views. Unlock an overview to reorder cards within a layer or edit text. Save keeps all views; reset restores only the current one.
|
package/docs/clients.de.md
CHANGED
|
@@ -4,9 +4,9 @@
|
|
|
4
4
|
|
|
5
5
|
[Zurück zur README](readme/README.de.md)
|
|
6
6
|
|
|
7
|
-
Qoder Desktop kann das Plugin aus dem Marketplace installieren
|
|
7
|
+
Qoder Desktop kann das Plugin aus dem Marketplace installieren; dann entfällt Schritt 1 (siehe den Abschnitt unten). Die übrigen Clients installieren das Plugin-Paket von npmjs.com.
|
|
8
8
|
|
|
9
|
-
Du benötigst Node.js 22 oder neuer und einen Client mit eingerichtetem Modellzugriff.
|
|
9
|
+
Du benötigst Node.js 22 oder neuer (mit npm) und einen Client mit eingerichtetem Modellzugriff.
|
|
10
10
|
|
|
11
11
|
## Schnellinstallation
|
|
12
12
|
|
|
@@ -16,25 +16,25 @@ npx skills add supermax92/qgraphflow
|
|
|
16
16
|
|
|
17
17
|
Installiert den Skill `q-flow` für Claude Code, Codex, Cursor und Qoder (getestet mit `skills` 1.7.0) und fragt, in welche Clients installiert werden soll. Für die Installation als Plugin den folgenden Schritten folgen.
|
|
18
18
|
|
|
19
|
-
## 1.
|
|
19
|
+
## 1. Plugin über npm herunterladen
|
|
20
20
|
|
|
21
21
|
```bash
|
|
22
|
-
|
|
23
|
-
cd qgraphflow
|
|
24
|
-
npm
|
|
25
|
-
|
|
22
|
+
mkdir qgraphflow-install
|
|
23
|
+
cd qgraphflow-install
|
|
24
|
+
npm install qgraphflow --ignore-scripts
|
|
25
|
+
cd node_modules/qgraphflow
|
|
26
26
|
```
|
|
27
27
|
|
|
28
|
-
|
|
28
|
+
Lege das Verzeichnis außerhalb deines Anwendungsprojekts an; Konto, Anmeldung oder Token sind nicht nötig. Danach befindest du dich im Plugin-Stammverzeichnis. Der Download über npm installiert das Plugin nicht im Client; fahre mit Schritt 2 fort. Um noch nicht veröffentlichten Code zu installieren, siehe die [Anleitung zum Bauen aus dem Quellcode](https://github.com/supermax92/qgraphflow/blob/main/docs/distribution.md#prepare-locally).
|
|
29
29
|
|
|
30
30
|
## 2. Im Client installieren
|
|
31
31
|
|
|
32
|
-
Führe die folgenden Befehle im Stammverzeichnis
|
|
32
|
+
Führe die folgenden Befehle im Plugin-Stammverzeichnis aus Schritt 1 (`qgraphflow-install/node_modules/qgraphflow`) aus, nicht im Verzeichnis deines eigenen Anwendungsprojekts.
|
|
33
33
|
|
|
34
34
|
### Codex App / CLI
|
|
35
35
|
|
|
36
36
|
```bash
|
|
37
|
-
codex plugin marketplace add
|
|
37
|
+
codex plugin marketplace add .
|
|
38
38
|
codex plugin add qgraphflow@supermax92
|
|
39
39
|
```
|
|
40
40
|
|
|
@@ -44,17 +44,8 @@ Starte eine neue Sitzung, gib `$` ein und wähle `qgraphflow:q-flow` aus (verwen
|
|
|
44
44
|
|
|
45
45
|
### Claude Code
|
|
46
46
|
|
|
47
|
-
Direkt von GitHub installieren, ohne Schritt 1:
|
|
48
|
-
|
|
49
|
-
```bash
|
|
50
|
-
claude plugin marketplace add supermax92/qgraphflow
|
|
51
|
-
claude plugin install qgraphflow@supermax92 --scope user
|
|
52
|
-
```
|
|
53
|
-
|
|
54
|
-
Oder aus dem in Schritt 1 erstellten Laufzeitpaket:
|
|
55
|
-
|
|
56
47
|
```bash
|
|
57
|
-
claude plugin marketplace add ./
|
|
48
|
+
claude plugin marketplace add ./
|
|
58
49
|
claude plugin install qgraphflow@supermax92 --scope user
|
|
59
50
|
```
|
|
60
51
|
|
|
@@ -63,20 +54,20 @@ Starte eine neue Sitzung und gib `/q-flow` (oder den vollständigen Namen `/qgra
|
|
|
63
54
|
### Qoder CLI
|
|
64
55
|
|
|
65
56
|
```bash
|
|
66
|
-
qodercli plugins install
|
|
57
|
+
qodercli plugins install .
|
|
67
58
|
```
|
|
68
59
|
|
|
69
60
|
Starte eine neue Sitzung und wähle `q-flow` aus.
|
|
70
61
|
|
|
71
62
|
### Qoder Desktop
|
|
72
63
|
|
|
73
|
-
**Empfohlen:** Öffne **Settings → Plugins → Marketplace**, suche nach
|
|
64
|
+
**Empfohlen:** Öffne **Settings → Plugins → Marketplace**, suche nach **QGraphFlow** oder **代码图谱可视化** und installiere das Plugin. Starte eine neue Sitzung und wähle `q-flow`.
|
|
74
65
|
|
|
75
|
-
Für eine lokale Installation führe zuerst Schritt 1 aus. Öffne dann **Settings → Plugins → Custom → Import** und importiere das vollständige
|
|
66
|
+
Für eine lokale Installation führe zuerst Schritt 1 aus. Öffne dann **Settings → Plugins → Custom → Import** und importiere das vollständige Plugin-Stammverzeichnis. Lade den Client neu und wähle `q-flow`.
|
|
76
67
|
|
|
77
68
|
### Cursor
|
|
78
69
|
|
|
79
|
-
Kopiere den gesamten Inhalt
|
|
70
|
+
Kopiere den gesamten Inhalt des Plugin-Stammverzeichnisses, einschließlich versteckter Dateien, nach `~/.cursor/plugins/local/qgraphflow/`. Sichere ein vorhandenes Verzeichnis zuerst; vermische keine alten und neuen Dateien.
|
|
80
71
|
|
|
81
72
|
Prüfe, ob das Manifest unter `~/.cursor/plugins/local/qgraphflow/.cursor-plugin/plugin.json` liegt. Lade das Fenster neu und wähle unter Customize → Plugins / Skills den Skill `q-flow` aus.
|
|
82
73
|
|
package/docs/clients.es.md
CHANGED
|
@@ -4,9 +4,9 @@
|
|
|
4
4
|
|
|
5
5
|
[Volver al README](readme/README.es.md)
|
|
6
6
|
|
|
7
|
-
Qoder Desktop permite instalar el complemento desde su Marketplace
|
|
7
|
+
Qoder Desktop permite instalar el complemento desde su Marketplace y omitir el paso 1 (consulta su sección más abajo). Los demás clientes instalan el paquete del complemento obtenido de npmjs.com.
|
|
8
8
|
|
|
9
|
-
Necesitas Node.js 22 o posterior y un cliente con acceso al modelo configurado.
|
|
9
|
+
Necesitas Node.js 22 o posterior (con npm) y un cliente con acceso al modelo configurado.
|
|
10
10
|
|
|
11
11
|
## Instalación rápida
|
|
12
12
|
|
|
@@ -16,25 +16,25 @@ npx skills add supermax92/qgraphflow
|
|
|
16
16
|
|
|
17
17
|
Instala la habilidad `q-flow` en Claude Code, Codex, Cursor y Qoder (probado con `skills` 1.7.0) y pregunta en qué clientes instalar. Para instalar el complemento, sigue los pasos siguientes.
|
|
18
18
|
|
|
19
|
-
## 1. Descargar
|
|
19
|
+
## 1. Descargar el complemento con npm
|
|
20
20
|
|
|
21
21
|
```bash
|
|
22
|
-
|
|
23
|
-
cd qgraphflow
|
|
24
|
-
npm
|
|
25
|
-
|
|
22
|
+
mkdir qgraphflow-install
|
|
23
|
+
cd qgraphflow-install
|
|
24
|
+
npm install qgraphflow --ignore-scripts
|
|
25
|
+
cd node_modules/qgraphflow
|
|
26
26
|
```
|
|
27
27
|
|
|
28
|
-
|
|
28
|
+
Crea el directorio fuera del proyecto de tu aplicación; no se necesita cuenta, inicio de sesión ni token. Ahora estás en la raíz del complemento. La descarga mediante npm no instala el complemento en el cliente; continúa con el paso 2. Para instalar código aún no publicado, consulta las [instrucciones de compilación desde el código fuente](https://github.com/supermax92/qgraphflow/blob/main/docs/distribution.md#prepare-locally).
|
|
29
29
|
|
|
30
30
|
## 2. Instalar en el cliente
|
|
31
31
|
|
|
32
|
-
Ejecuta los siguientes comandos desde la raíz del
|
|
32
|
+
Ejecuta los siguientes comandos desde la raíz del complemento a la que entraste en el paso 1 (`qgraphflow-install/node_modules/qgraphflow`), no desde el directorio de tu propio proyecto.
|
|
33
33
|
|
|
34
34
|
### Codex App / CLI
|
|
35
35
|
|
|
36
36
|
```bash
|
|
37
|
-
codex plugin marketplace add
|
|
37
|
+
codex plugin marketplace add .
|
|
38
38
|
codex plugin add qgraphflow@supermax92
|
|
39
39
|
```
|
|
40
40
|
|
|
@@ -44,17 +44,8 @@ Inicia una sesión nueva, escribe `$` y selecciona `qgraphflow:q-flow` (usa el n
|
|
|
44
44
|
|
|
45
45
|
### Claude Code
|
|
46
46
|
|
|
47
|
-
Instala directamente desde GitHub, sin el paso 1:
|
|
48
|
-
|
|
49
|
-
```bash
|
|
50
|
-
claude plugin marketplace add supermax92/qgraphflow
|
|
51
|
-
claude plugin install qgraphflow@supermax92 --scope user
|
|
52
|
-
```
|
|
53
|
-
|
|
54
|
-
O bien, desde el paquete de ejecución generado en el paso 1:
|
|
55
|
-
|
|
56
47
|
```bash
|
|
57
|
-
claude plugin marketplace add ./
|
|
48
|
+
claude plugin marketplace add ./
|
|
58
49
|
claude plugin install qgraphflow@supermax92 --scope user
|
|
59
50
|
```
|
|
60
51
|
|
|
@@ -63,20 +54,20 @@ Inicia una sesión nueva y escribe `/q-flow` (o el nombre completo `/qgraphflow:
|
|
|
63
54
|
### Qoder CLI
|
|
64
55
|
|
|
65
56
|
```bash
|
|
66
|
-
qodercli plugins install
|
|
57
|
+
qodercli plugins install .
|
|
67
58
|
```
|
|
68
59
|
|
|
69
60
|
Inicia una sesión nueva y selecciona `q-flow`.
|
|
70
61
|
|
|
71
62
|
### Qoder Desktop
|
|
72
63
|
|
|
73
|
-
**Recomendado:** Abre **Settings → Plugins → Marketplace**, busca
|
|
64
|
+
**Recomendado:** Abre **Settings → Plugins → Marketplace**, busca **QGraphFlow** o **代码图谱可视化** e instala el complemento. Inicia una sesión nueva y selecciona `q-flow`.
|
|
74
65
|
|
|
75
|
-
Para una instalación local, completa primero el paso 1. Después abre **Settings → Plugins → Custom → Import** e importa el directorio completo
|
|
66
|
+
Para una instalación local, completa primero el paso 1. Después abre **Settings → Plugins → Custom → Import** e importa el directorio raíz completo del complemento. Recarga el cliente y selecciona `q-flow`.
|
|
76
67
|
|
|
77
68
|
### Cursor
|
|
78
69
|
|
|
79
|
-
Copia todo el contenido de
|
|
70
|
+
Copia todo el contenido de la raíz del complemento, incluidos los archivos ocultos, a `~/.cursor/plugins/local/qgraphflow/`. Si el directorio ya existe, haz una copia de seguridad antes; no mezcles archivos antiguos y nuevos.
|
|
80
71
|
|
|
81
72
|
Comprueba que el manifiesto esté en `~/.cursor/plugins/local/qgraphflow/.cursor-plugin/plugin.json`. Recarga la ventana y selecciona `q-flow` en Customize → Plugins / Skills.
|
|
82
73
|
|