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
package/docs/readme/README.es.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<div align="center">
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
<h1><picture><source media="(prefers-color-scheme: dark)" srcset="../images/brand/qgraphflow-lockup-dark.svg"><img src="../images/brand/qgraphflow-lockup-light.svg" alt="QGraphFlow" height="64"></picture></h1>
|
|
4
4
|
|
|
5
5
|
### Convierte código complejo en diagramas que puedes explorar.
|
|
6
6
|
|
|
@@ -10,17 +10,25 @@ Sigue el recorrido. Comprueba las evidencias. Comparte un archivo sin conexión.
|
|
|
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
|
-
[Demo en línea](https://supermax92.github.io/qgraphflow/) · [Instalación por cliente](#guía-de-instalación) · [Informar de un problema](https://github.com/supermax92/qgraphflow/issues) · [MIT](../../LICENSE)
|
|
13
|
+
[Demo en línea](https://supermax92.github.io/qgraphflow/) · [Primeros pasos](#primeros-pasos) · [Instalación por cliente](#guía-de-instalación) · [Informar de un problema](https://github.com/supermax92/qgraphflow/issues) · [MIT](../../LICENSE)
|
|
14
14
|
|
|
15
15
|
</div>
|
|
16
16
|
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
*Nueve tipos: arquitectura, flujo, secuencia, ER, despliegue, clases, estados, casos de uso y flujo de datos.*
|
|
17
|
+
*Once tipos de diagramas: arquitectura de capacidades de la plataforma, arquitectura por capas de ingeniería, arquitectura de relaciones entre componentes, diagrama de flujo, secuencia, ER, despliegue, clases, estados, casos de uso y flujo de datos.*
|
|
20
18
|
|
|
21
19
|
QGraphFlow genera diagramas de software interactivos a partir del código, los esquemas, la configuración y los requisitos. Permite comprobar las relaciones y compartir el resultado como HTML sin conexión.
|
|
22
20
|
|
|
23
|
-
**Qué lo distingue:**
|
|
21
|
+
**Qué lo distingue:** once tipos de diagrama en una sola habilidad, un tipo de evidencia en cada relación y la línea de código detrás de cada una respaldada por código, diseño automático, edición en la propia página y ninguna solicitud de red de los scripts del complemento ni del propio Viewer.
|
|
22
|
+
|
|
23
|
+

|
|
24
|
+
|
|
25
|
+
Con el código fuente real de Jeepay, alterna entre diagramas de arquitectura de relaciones entre componentes, secuencia y ER para explorar componentes y relaciones de llamadas. [Ver GIF a tamaño original](https://github.com/supermax92/qgraphflow/releases/download/showcase-v2/jeepay.en.hero.gif)
|
|
26
|
+
|
|
27
|
+
**Presentación de un diagrama de secuencia complejo**
|
|
28
|
+
|
|
29
|
+

|
|
30
|
+
|
|
31
|
+
Un escenario ficticio de comercio electrónico contiene 9 participantes, 29 mensajes y 6 fragmentos combinados, con reintentos de inventario, ramas anidadas, procesamiento paralelo, compensación de fallos y callbacks asíncronos. La animación muestra gradualmente el diagrama generado para presentar su estructura y sus detalles. [Ver GIF a tamaño original](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 @@ Un solo comando instala la habilidad para Claude Code, Codex, Cursor y Qoder; la
|
|
|
30
38
|
|
|
31
39
|
- **Explorar:** buscar, ampliar y desplazar el lienzo; consultar responsabilidades y relaciones entrantes y salientes.
|
|
32
40
|
|
|
33
|
-

|
|
34
|
-
|
|
35
41
|
- **Verificar:** inspeccionar nodos y conexiones para revisar archivos, líneas, símbolos e incertidumbres explícitas.
|
|
36
42
|
|
|
37
|
-

|
|
38
|
-
|
|
39
43
|
- **Editar:** desbloquear el diseño, cambiar textos y mover elementos; restablecer cuando sea necesario.
|
|
40
44
|
|
|
41
|
-

|
|
42
|
-
|
|
43
45
|
- **Compartir:** abrir el HTML sin conexión o exportar el diagrama completo a SVG / PNG.
|
|
44
46
|
|
|
45
|
-
|
|
47
|
+
El [corpus de Jeepay](../../examples/jeepay), basado en código fuente real, contiene las once vistas utilizadas por CI y la demostración online.
|
|
48
|
+
|
|
49
|
+
## Primeros pasos
|
|
50
|
+
|
|
51
|
+
Tras la instalación, abre tu proyecto de negocio en el cliente y selecciona la habilidad `q-flow`. Los ejemplos usan `/q-flow` de Claude Code; en Codex, usa la entrada `$q-flow` o `$qgraphflow:q-flow` que ofrezca tu cliente. ¿Todavía no lo has instalado? Consulta primero la [guía de instalación](#guía-de-instalación).
|
|
52
|
+
|
|
53
|
+
### 1. Entrada vacía: No sabes por dónde empezar
|
|
54
|
+
|
|
55
|
+
Invoca la habilidad sin añadir una petición:
|
|
56
|
+
|
|
57
|
+
```text
|
|
58
|
+
/q-flow
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
La habilidad te guía para elegir la parte que analizar y la pregunta que debe responder el diagrama. Empieza a dibujar cuando la información necesaria está clara.
|
|
62
|
+
|
|
63
|
+
### 2. Preguntar por las capacidades: Saber qué puede dibujar
|
|
64
|
+
|
|
65
|
+
```text
|
|
66
|
+
/q-flow ¿Qué tipos de diagramas puedes dibujar? ¿Qué preguntas responde cada tipo? Acabo de hacerme cargo de un proyecto; presenta tus capacidades y sugiere un punto de partida.
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
Conoce primero los usos de los once tipos de diagramas y decide después si quieres ver la estructura del proyecto, el orden de llamadas, las relaciones de datos u otro contenido.
|
|
70
|
+
|
|
71
|
+
### 3. Entrada vaga: Solo tienes un objetivo general
|
|
72
|
+
|
|
73
|
+
```text
|
|
74
|
+
/q-flow Ayúdame a dibujar este proyecto. Quiero entenderlo lo antes posible.
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
No necesitas indicar primero el tipo de diagrama. La habilidad determina una vista adecuada según el proyecto y tu objetivo, y pregunta cuando falta información necesaria.
|
|
78
|
+
|
|
79
|
+
### 4. Entrada precisa: Definir el alcance y pedir detalles del dibujo
|
|
80
|
+
|
|
81
|
+
Sustituye los nombres de negocio y los pasos siguientes por procesos que existan realmente en tu proyecto:
|
|
82
|
+
|
|
83
|
+
```text
|
|
84
|
+
/q-flow Analiza el proceso de creación de pedidos del proyecto actual y genera un diagrama de secuencia en chino.
|
|
85
|
+
Incluye la entrada de solicitudes, el cálculo de precios, la reserva de inventario, la autorización de pago y la persistencia del pedido.
|
|
86
|
+
Conserva las llamadas síncronas, mensajes asíncronos, retornos emparejados, barras de activación, ramas condicionales, reintentos y compensaciones de fallos que existan realmente en el código. No omitas detalles por brevedad.
|
|
87
|
+
Indica los archivos y números de línea del código de los componentes y llamadas, y guarda el resultado en docs/qgraphflow/order-sequence/.
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
Define claramente el objeto, la pregunta, el nivel de detalle y la ubicación de salida para empezar directamente. El diagrama conserva solo hechos respaldados por evidencia.
|
|
91
|
+
|
|
92
|
+
### 5. Seguir refinando: Ampliar una parte del diagrama anterior
|
|
93
|
+
|
|
94
|
+
Una vez generado el resultado, continúa en la misma conversación:
|
|
95
|
+
|
|
96
|
+
```text
|
|
97
|
+
/q-flow Amplía el paso de reserva de inventario del diagrama de secuencia anterior en un diagrama de flujo independiente en chino.
|
|
98
|
+
Muestra todas las ramas de validación de inventario, reserva exitosa, fallos reintentables, límite de reintentos y liberación de inventario. Sigue el código fuente y no añadas pasos que no existan en él.
|
|
99
|
+
```
|
|
46
100
|
|
|
47
|
-
|
|
101
|
+
Mira primero el conjunto y profundiza después en un paso. También puedes pedir más detalles de un diagrama existente o verificar sus relaciones.
|
|
48
102
|
|
|
49
103
|
## Guía de instalación
|
|
50
104
|
|
|
@@ -62,9 +116,18 @@ Para instalarla como complemento, seguir los pasos siguientes. En [Qoder Desktop
|
|
|
62
116
|
|
|
63
117
|
### 1. Descargar el complemento
|
|
64
118
|
|
|
65
|
-
|
|
119
|
+
Obtener el complemento desde npmjs.com, sin cuenta, inicio de sesión ni token. Crear un directorio independiente fuera del proyecto de la aplicación:
|
|
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
|
+
Ahora se está en la raíz del complemento. **La descarga mediante npm no instala automáticamente el complemento en el cliente**; continuar con el paso 2. El paquete también ofrece el comando `qgraphflow`, que se usa en [Mantener los diagramas sincronizados con el código](#mantener-los-diagramas-sincronizados-con-el-código).
|
|
66
129
|
|
|
67
|
-
Ejecutar los comandos siguientes desde **la raíz del complemento
|
|
130
|
+
Ejecutar los comandos siguientes desde **la raíz del complemento, que contiene `skills/`**.
|
|
68
131
|
|
|
69
132
|
### 2. Instalar en el cliente
|
|
70
133
|
|
|
@@ -81,17 +144,8 @@ Iniciar una sesión nueva, escribir `$` y seleccionar `qgraphflow:q-flow`.
|
|
|
81
144
|
|
|
82
145
|
#### Claude Code
|
|
83
146
|
|
|
84
|
-
Instalar directamente desde GitHub sin descargar el ZIP:
|
|
85
|
-
|
|
86
147
|
```bash
|
|
87
|
-
claude plugin marketplace add
|
|
88
|
-
claude plugin install qgraphflow@supermax92 --scope user
|
|
89
|
-
```
|
|
90
|
-
|
|
91
|
-
O bien, desde la raíz del complemento extraído:
|
|
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 @@ Iniciar una sesión nueva y seleccionar `q-flow`.
|
|
|
107
161
|
|
|
108
162
|
#### Qoder Desktop
|
|
109
163
|
|
|
110
|
-
**Recomendado:** Abre **Settings → Plugins → Marketplace**, busca
|
|
164
|
+
**Recomendado:** Abre **Settings → Plugins → Marketplace**, busca **QGraphFlow** o **代码图谱可视化** e instala el complemento. Inicia una sesión nueva y selecciona `q-flow`.
|
|
111
165
|
|
|
112
|
-
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
|
|
166
|
+
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. Inicia una sesión nueva y selecciona `q-flow`.
|
|
113
167
|
|
|
114
168
|
#### Cursor
|
|
115
169
|
|
|
@@ -123,27 +177,11 @@ Comprobar que allí existe `.cursor-plugin/plugin.json`, recargar la ventana y b
|
|
|
123
177
|
|
|
124
178
|
### 3. Empezar a usarlo
|
|
125
179
|
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
<details>
|
|
129
|
-
<summary>Otra forma de instalación: npm</summary>
|
|
130
|
-
|
|
131
|
-
También se puede obtener el complemento desde npmjs.com en lugar del ZIP, sin cuenta, inicio de sesión ni token. Crear un directorio independiente fuera del proyecto de la aplicación:
|
|
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
|
-
Ahora se está en la raíz del complemento. Continuar con los pasos de instalación del cliente indicados arriba. **La descarga mediante npm no instala automáticamente el complemento en el cliente.** El paquete también ofrece el comando `qgraphflow`, que se usa en [Mantener los diagramas sincronizados con el código](#mantener-los-diagramas-sincronizados-con-el-código).
|
|
141
|
-
|
|
142
|
-
</details>
|
|
180
|
+
Abre tu proyecto de negocio en el cliente, inicia una sesión nueva y selecciona la habilidad. Describe tu petición siguiendo los ejemplos de [Primeros pasos](#primeros-pasos). Abre el HTML generado en el navegador.
|
|
143
181
|
|
|
144
182
|
¿Prefieres compilarlo? Consulta las [instrucciones de compilación desde el código fuente](https://github.com/supermax92/qgraphflow/blob/main/docs/distribution.md#prepare-locally).
|
|
145
183
|
|
|
146
|
-
##
|
|
184
|
+
## Uso rápido
|
|
147
185
|
|
|
148
186
|
Estos ejemplos usan `$qgraphflow:q-flow` en Codex. Si el cliente muestra `$q-flow`, seleccionar esa entrada. En los demás clientes, usar la forma de invocación indicada arriba.
|
|
149
187
|
|
|
@@ -158,7 +196,7 @@ $qgraphflow:q-flow
|
|
|
158
196
|
### Ejemplo 1: Entender la arquitectura
|
|
159
197
|
|
|
160
198
|
```text
|
|
161
|
-
$qgraphflow:q-flow Analiza este proyecto y crea un diagrama de arquitectura en
|
|
199
|
+
$qgraphflow:q-flow Analiza este proyecto y crea un diagrama de arquitectura en chino que muestre responsabilidades de los módulos, dependencias y límites del sistema.
|
|
162
200
|
```
|
|
163
201
|
|
|
164
202
|
Útil para conocer la estructura general al llegar a un proyecto.
|
|
@@ -166,13 +204,13 @@ $qgraphflow:q-flow Analiza este proyecto y crea un diagrama de arquitectura en e
|
|
|
166
204
|
### Ejemplo 2: Seguir un flujo de negocio
|
|
167
205
|
|
|
168
206
|
```text
|
|
169
|
-
$qgraphflow:q-flow Analiza la creación de pedidos y genera un diagrama de secuencia en
|
|
207
|
+
$qgraphflow:q-flow Analiza la creación de pedidos y genera un diagrama de secuencia en chino con cálculo de precios, reserva de inventario, pago y persistencia del pedido, incluidas las ramas de fallo.
|
|
170
208
|
```
|
|
171
209
|
|
|
172
210
|
Sustituir la creación de pedidos y sus pasos por el flujo real del proyecto. Continuar en la misma conversación:
|
|
173
211
|
|
|
174
212
|
```text
|
|
175
|
-
$qgraphflow:q-flow Amplía la reserva de inventario del diagrama anterior en un diagrama de flujo independiente en
|
|
213
|
+
$qgraphflow:q-flow Amplía la reserva de inventario del diagrama anterior en un diagrama de flujo independiente en chino, con el tratamiento de éxitos y fallos.
|
|
176
214
|
```
|
|
177
215
|
|
|
178
216
|
Los resultados se guardan bajo `docs/qgraphflow/` de forma predeterminada. Abrir `index.html` para explorar, editar y exportar; `graph.json` conserva los datos. Cada vista también se escribe como SVG (`diagram.svg`, o `diagram-<n>-<type>.svg` cuando hay varias), que puede incrustarse como imagen en un README, una pull request o una wiki.
|
|
@@ -180,26 +218,23 @@ Los resultados se guardan bajo `docs/qgraphflow/` de forma predeterminada. Abrir
|
|
|
180
218
|
Después de editar en la página, **Más → Guardar cambios** en Chrome o Edge reescribe en su sitio la página, `graph.json` y los SVG, tras elegir una vez la carpeta del diagrama. Otros navegadores solo guardan `graph.json`: colocarlo en la carpeta y volver a generar la página y los SVG con `npx -y qgraphflow generate docs/qgraphflow/<name>/graph.json docs/qgraphflow/<name> --layout preserve --force`.
|
|
181
219
|
|
|
182
220
|
<details>
|
|
183
|
-
<summary>Ejecutar
|
|
221
|
+
<summary>Ejecutar el ejemplo de Jeepay con once vistas basado en código fuente</summary>
|
|
184
222
|
|
|
185
|
-
|
|
223
|
+
Selecciona tu copia local del código fuente de Jeepay para verificar la evidencia:
|
|
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.es.graph.json output/ecommerce-es
|
|
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
|
-
|
|
195
|
-
|
|
196
|
-
El Viewer precompilado no necesita instalar dependencias, claves API ni servicios de backend. La búsqueda de evidencias y la creación de gráficos con IA usan el servicio de modelos del cliente elegido.
|
|
231
|
+
Abre `output/jeepay/index.html`; sus once SVG están en el mismo directorio. Consulta el [README del corpus](../../examples/jeepay) para conocer la revisión del código fuente y el procedimiento de actualización.
|
|
197
232
|
|
|
198
233
|
</details>
|
|
199
234
|
|
|
200
235
|
## Mantener los diagramas sincronizados con el código
|
|
201
236
|
|
|
202
|
-
Un diagrama generado con la raíz del repositorio registra dónde se define cada componente. La validación con `--repo-root` falla cuando falta un archivo registrado, un rango de líneas ya no cabe en el archivo o un símbolo registrado salió de sus líneas, y el error indica en qué líneas está ahora el símbolo. Añadir este trabajo a la CI; no necesita compilación, inicio de sesión ni token:
|
|
237
|
+
Un diagrama generado con la raíz del repositorio registra dónde se define cada componente y la línea detrás de cada relación respaldada por código (una llamada, una clave foránea). La validación con `--repo-root` falla cuando falta un archivo registrado, un rango de líneas ya no cabe en el archivo o un símbolo registrado salió de sus líneas, y el error indica en qué líneas está ahora el símbolo. Añadir este trabajo a la CI; no necesita compilación, inicio de sesión ni token:
|
|
203
238
|
|
|
204
239
|
```yaml
|
|
205
240
|
name: Diagrams
|
|
@@ -227,19 +262,21 @@ $qgraphflow:q-flow La CI dice que docs/qgraphflow/order-sequence está desactual
|
|
|
227
262
|
|
|
228
263
|
La habilidad mueve los anclajes cuyo símbolo encuentra una sola vez en el archivo, corrige solo los que siguen fallando y vuelve a generar la página y los SVG conservando las posiciones y los textos editados. No redibuja el diagrama.
|
|
229
264
|
|
|
230
|
-
## Qué responde cada
|
|
265
|
+
## Qué responde cada uno de los once tipos de diagramas
|
|
231
266
|
|
|
232
267
|
| Vista · PNG | Pregunta principal | Alcance del ejemplo |
|
|
233
268
|
| --- | --- | --- |
|
|
234
|
-
| Arquitectura
|
|
235
|
-
|
|
|
236
|
-
|
|
|
237
|
-
|
|
|
238
|
-
|
|
|
239
|
-
|
|
|
240
|
-
|
|
|
241
|
-
|
|
|
242
|
-
|
|
|
269
|
+
| Arquitectura de capacidades de la plataforma | ¿Qué capacidades ofrece la plataforma? | Zonas de capacidades y matrices |
|
|
270
|
+
| Arquitectura por capas de ingeniería | ¿Cómo se organiza el código del proyecto? | Capas de ingeniería y soporte compartido |
|
|
271
|
+
| Arquitectura de relaciones entre componentes | ¿Qué límites de responsabilidad colaboran en el sistema? | Canales, orquestación de transacciones, precios, riesgo, inventario, pago, pedidos, eventos y ejecución de pedidos |
|
|
272
|
+
| Diagrama de flujo | ¿Cómo se bifurca y converge cada decisión? | Falta de inventario, rechazo de riesgo, compensación de fallos de pago y confirmación exitosa |
|
|
273
|
+
| Secuencia | ¿En qué orden hace llamadas y recibe retornos una solicitud? | Flujo principal de compra exitosa y OrderPaid asíncrono |
|
|
274
|
+
| ER | ¿Cómo se relacionan los datos principales? | Carrito, pedidos, líneas, pagos, reservas de inventario y paquetes |
|
|
275
|
+
| Despliegue | ¿Dónde se ubican las unidades de ejecución y cómo se conectan? | Borde, Kubernetes, servicios de datos, pago y redes de almacén y logística |
|
|
276
|
+
| Clases | ¿Cómo dependen los objetos de dominio y los contratos del código? | Servicio de aplicación Checkout, Order y cuatro puertos |
|
|
277
|
+
| Estados | ¿Qué eventos y condiciones de guarda hacen avanzar un pedido? | Pago, ejecución del pedido, cancelación, reembolso y cierre |
|
|
278
|
+
| Casos de uso | ¿Qué capacidades tiene cada actor? | Comprador, comercio, almacén y atención al cliente |
|
|
279
|
+
| Flujo de datos | ¿Por qué transformaciones y almacenes pasan los activos de datos? | Carrito, decisiones de transacción, eventos de pedidos, almacén y logística y comprobantes de entrega |
|
|
243
280
|
|
|
244
281
|
Este modelo conceptual demuestra QGraphFlow y no corresponde a un repositorio de comercio concreto. El ejemplo `graph.json` no inventa rutas de código y marca las evidencias de las relaciones como `inference`. Los diagramas reales necesitan código, DDL, configuración, pruebas y requisitos aceptados que se puedan rastrear.
|
|
245
282
|
|
|
@@ -253,10 +290,22 @@ node --test tests/*.test.mjs skills/q-flow/scripts/*.test.mjs
|
|
|
253
290
|
|
|
254
291
|
Se necesitan Node.js 22 o posterior, npm, tar, zip y unzip. Al informar de un problema, incluir un gráfico mínimo sin datos sensibles, versiones del cliente y navegador y pasos de reproducción.
|
|
255
292
|
|
|
256
|
-
Documentación de referencia (en inglés): [Fuentes de evidencia](../../skills/q-flow/references/evidence-sources.md) · [Formato de gráficos](../../skills/q-flow/references/graph-schema.md) · [Consulta guiada](../../skills/q-flow/references/guided-intake.md) · [Desarrollo del Viewer](../../skills/q-flow/references/viewer-development.md) · [Composición de diagramas](../../skills/q-flow/references/visual-contract.md)
|
|
293
|
+
Documentación de referencia (en inglés): [Fuentes de evidencia](../../skills/q-flow/references/evidence-sources.md) · [Formato de gráficos](../../skills/q-flow/references/graph-schema.md) · [Consulta guiada](../../skills/q-flow/references/guided-intake.md) · [Desarrollo y aceptación del Viewer](../../skills/q-flow/references/viewer-development.md) · [Composición de diagramas](../../skills/q-flow/references/visual-contract.md)
|
|
257
294
|
|
|
258
295
|
## Licencia y atribución
|
|
259
296
|
|
|
260
297
|
[MIT](../../LICENSE) · [Avisos de terceros](../../THIRD_PARTY_NOTICES.md)
|
|
261
298
|
|
|
262
|
-
QGraphFlow es un proyecto independiente con licencia MIT. Los escenarios de este documento son conceptuales y no representan la arquitectura de producción de ninguna empresa
|
|
299
|
+
QGraphFlow es un proyecto independiente con licencia MIT. Los escenarios de este documento son ejemplos conceptuales y no representan la arquitectura de producción de ninguna empresa real.
|
|
300
|
+
|
|
301
|
+
## Vistas generales de arquitectura
|
|
302
|
+
|
|
303
|
+
La arquitectura incluye ahora relaciones entre componentes, capacidades de la plataforma y capas de ingeniería. Describe el objeto y la pregunta; la habilidad elige la plantilla. Las colecciones solicitadas pueden contener varias vistas de arquitectura con ediciones independientes.
|
|
304
|
+
|
|
305
|
+
```text
|
|
306
|
+
$qgraphflow:q-flow Analiza las capacidades de la plataforma y las formas de integración de negocio del proyecto actual, y genera una vista general de capacidades de la plataforma en chino.
|
|
307
|
+
$qgraphflow:q-flow Analiza la organización del proyecto actual y sus capas de componentes, y genera vistas generales en chino del proyecto completo y de una sección de un componente.
|
|
308
|
+
$qgraphflow:q-flow Genera una vista general en inglés de las capacidades de la plataforma de este proyecto y muestra cómo se integran los módulos de aplicación.
|
|
309
|
+
```
|
|
310
|
+
|
|
311
|
+
Consulta [examples/jeepay](../../examples/jeepay) para ver las vistas de arquitectura de plataforma, ingeniería y relaciones entre componentes basadas en código fuente real. Desbloquea una vista general para reordenar tarjetas dentro de una capa o editar texto. Guardar conserva todas las vistas; restablecer restaura solo la actual.
|