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.pt.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
|
### Transforme código complexo em diagramas que você pode explorar.
|
|
6
6
|
|
|
@@ -10,17 +10,25 @@ Siga o caminho. Confira as evidências. Compartilhe um arquivo offline.
|
|
|
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
|
-
[Demonstração online](https://supermax92.github.io/qgraphflow/) · [Instalação por cliente](#guia-de-instalação) · [Relatar problema](https://github.com/supermax92/qgraphflow/issues) · [MIT](../../LICENSE)
|
|
13
|
+
[Demonstração online](https://supermax92.github.io/qgraphflow/) · [Primeiros passos](#primeiros-passos) · [Instalação por cliente](#guia-de-instalação) · [Relatar problema](https://github.com/supermax92/qgraphflow/issues) · [MIT](../../LICENSE)
|
|
14
14
|
|
|
15
15
|
</div>
|
|
16
16
|
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
*Nove tipos: arquitetura, fluxograma, sequência, ER, implantação, classes, estados, casos de uso e fluxo de dados.*
|
|
17
|
+
*Onze tipos de diagrama: arquitetura de capacidades da plataforma, arquitetura em camadas de engenharia, arquitetura de relações entre componentes, fluxograma, sequência, ER, implantação, classes, estados, casos de uso e fluxo de dados.*
|
|
20
18
|
|
|
21
19
|
QGraphFlow gera diagramas de software interativos a partir de código, esquemas, configuração e requisitos. As relações podem ser verificadas e o resultado é um HTML offline compartilhável.
|
|
22
20
|
|
|
23
|
-
**O que o diferencia:**
|
|
21
|
+
**O que o diferencia:** onze tipos de diagrama em uma só habilidade, o tipo de evidência de cada relação e a linha de código por trás de cada uma que o código sustenta, layout automático, edição na própria página e nenhuma requisição de rede dos scripts do plugin nem do próprio Viewer.
|
|
22
|
+
|
|
23
|
+

|
|
24
|
+
|
|
25
|
+
Com o código-fonte real do Jeepay, alterne entre diagramas de arquitetura de relações entre componentes, sequência e ER para explorar componentes e relações de chamadas. [Ver GIF no tamanho original](https://github.com/supermax92/qgraphflow/releases/download/showcase-v2/jeepay.en.hero.gif)
|
|
26
|
+
|
|
27
|
+
**Apresentação de um diagrama de sequência complexo**
|
|
28
|
+
|
|
29
|
+

|
|
30
|
+
|
|
31
|
+
Um cenário fictício de comércio eletrônico contém 9 participantes, 29 mensagens e 6 fragmentos combinados, com novas tentativas de estoque, ramos aninhados, processamento paralelo, compensação de falhas e callbacks assíncronos. A animação revela gradualmente o diagrama gerado para mostrar sua estrutura e seus detalhes. [Ver GIF no tamanho 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 @@ Um só comando instala a habilidade para Claude Code, Codex, Cursor e Qoder; a i
|
|
|
30
38
|
|
|
31
39
|
- **Explorar:** pesquisar, ampliar e deslocar a tela; entender responsabilidades e relações de entrada e saída.
|
|
32
40
|
|
|
33
|
-

|
|
34
|
-
|
|
35
41
|
- **Verificar:** inspecionar nós e conexões para conferir arquivos, linhas, símbolos e incertezas explícitas.
|
|
36
42
|
|
|
37
|
-

|
|
38
|
-
|
|
39
43
|
- **Editar:** desbloquear o layout, alterar textos e mover elementos; redefinir quando necessário.
|
|
40
44
|
|
|
41
|
-

|
|
42
|
-
|
|
43
45
|
- **Compartilhar:** abrir o HTML offline ou exportar o diagrama completo em SVG / PNG.
|
|
44
46
|
|
|
45
|
-
|
|
47
|
+
O [corpus do Jeepay](../../examples/jeepay), baseado em código-fonte real, contém as onze vistas usadas pelo CI e pela demonstração online.
|
|
48
|
+
|
|
49
|
+
## Primeiros passos
|
|
50
|
+
|
|
51
|
+
Após a instalação, abra seu projeto de negócio no cliente e selecione a habilidade `q-flow`. Os exemplos usam `/q-flow` do Claude Code; no Codex, use a entrada `$q-flow` ou `$qgraphflow:q-flow` que seu cliente realmente oferece. Ainda não instalou? Consulte primeiro o [guia de instalação](#guia-de-instalação).
|
|
52
|
+
|
|
53
|
+
### 1. Entrada vazia: Não sabe por onde começar
|
|
54
|
+
|
|
55
|
+
Invoque a habilidade sem acrescentar uma solicitação:
|
|
56
|
+
|
|
57
|
+
```text
|
|
58
|
+
/q-flow
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
A habilidade orienta você a escolher a parte a analisar e a pergunta que o diagrama deve responder. O desenho começa quando as informações necessárias estão claras.
|
|
62
|
+
|
|
63
|
+
### 2. Perguntar sobre capacidades: Saber o que pode desenhar
|
|
64
|
+
|
|
65
|
+
```text
|
|
66
|
+
/q-flow Quais tipos de diagrama você pode desenhar? Que perguntas cada tipo responde? Acabei de assumir um projeto; apresente suas capacidades e sugira um ponto de partida.
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
Conheça primeiro os usos dos onze tipos de diagrama e depois decida se quer explorar a estrutura do projeto, a ordem das chamadas, as relações de dados ou outro conteúdo.
|
|
70
|
+
|
|
71
|
+
### 3. Entrada vaga: Apenas um objetivo geral
|
|
72
|
+
|
|
73
|
+
```text
|
|
74
|
+
/q-flow Ajude-me a desenhar este projeto. Quero entendê-lo o mais rápido possível.
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
Não é necessário indicar primeiro o tipo de diagrama. A habilidade determina uma vista adequada com base no projeto e no seu objetivo, e pergunta quando faltam informações necessárias.
|
|
78
|
+
|
|
79
|
+
### 4. Entrada precisa: Definir o escopo e pedir detalhes do desenho
|
|
80
|
+
|
|
81
|
+
Substitua os nomes de negócio e os passos abaixo por fluxos que realmente existam no seu projeto:
|
|
82
|
+
|
|
83
|
+
```text
|
|
84
|
+
/q-flow Analise o fluxo de criação de pedidos do projeto atual e gere um diagrama de sequência em chinês.
|
|
85
|
+
Inclua a entrada da solicitação, o cálculo de preços, a reserva de estoque, a autorização de pagamento e a persistência do pedido.
|
|
86
|
+
Mantenha as chamadas síncronas, mensagens assíncronas, retornos emparelhados, barras de ativação, ramificações condicionais, tentativas e compensações de falha que realmente existam no código. Não omita detalhes por brevidade.
|
|
87
|
+
Indique os arquivos e números de linha do código dos componentes e chamadas, e salve o resultado em docs/qgraphflow/order-sequence/.
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
Defina claramente o objeto, a pergunta, o nível de detalhe e o local de saída para começar diretamente. O diagrama mantém apenas fatos sustentados por evidências.
|
|
91
|
+
|
|
92
|
+
### 5. Refinar mais: Expandir parte do diagrama anterior
|
|
93
|
+
|
|
94
|
+
Após a geração do resultado, continue na mesma conversa:
|
|
95
|
+
|
|
96
|
+
```text
|
|
97
|
+
/q-flow Expanda a etapa de reserva de estoque do diagrama de sequência anterior em um fluxograma separado em chinês.
|
|
98
|
+
Mostre todos os ramos de validação do estoque, reserva bem-sucedida, falhas que permitem nova tentativa, limite de tentativas e liberação de estoque. Siga o código-fonte e não adicione etapas ausentes dele.
|
|
99
|
+
```
|
|
46
100
|
|
|
47
|
-
|
|
101
|
+
Veja primeiro o todo e depois aprofunde uma etapa. Você também pode pedir mais detalhes de um diagrama existente ou verificar suas relações.
|
|
48
102
|
|
|
49
103
|
## Guia de instalação
|
|
50
104
|
|
|
@@ -62,9 +116,18 @@ Para instalar como plugin, siga as etapas abaixo. No [Qoder Desktop](#qoder-desk
|
|
|
62
116
|
|
|
63
117
|
### 1. Baixe o plugin
|
|
64
118
|
|
|
65
|
-
|
|
119
|
+
Obtenha o plugin no npmjs.com, sem conta, login nem token. Crie um diretório separado, fora do projeto da sua aplicação:
|
|
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
|
+
Agora você está na raiz do plugin. **Baixar pelo npm não instala automaticamente o plugin no cliente**; continue na etapa 2. O pacote também oferece o comando `qgraphflow`, usado em [Mantenha os diagramas em sincronia com o código](#mantenha-os-diagramas-em-sincronia-com-o-código).
|
|
66
129
|
|
|
67
|
-
Execute os comandos abaixo na **raiz do plugin
|
|
130
|
+
Execute os comandos abaixo na **raiz do plugin, que contém `skills/`**.
|
|
68
131
|
|
|
69
132
|
### 2. Instale no seu cliente
|
|
70
133
|
|
|
@@ -81,17 +144,8 @@ Inicie uma nova sessão, digite `$` e selecione `qgraphflow:q-flow`.
|
|
|
81
144
|
|
|
82
145
|
#### Claude Code
|
|
83
146
|
|
|
84
|
-
Instale diretamente do GitHub sem baixar o ZIP:
|
|
85
|
-
|
|
86
147
|
```bash
|
|
87
|
-
claude plugin marketplace add
|
|
88
|
-
claude plugin install qgraphflow@supermax92 --scope user
|
|
89
|
-
```
|
|
90
|
-
|
|
91
|
-
Ou, a partir da raiz do plugin 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 @@ Inicie uma nova sessão e selecione `q-flow`.
|
|
|
107
161
|
|
|
108
162
|
#### Qoder Desktop
|
|
109
163
|
|
|
110
|
-
**Recomendado:** Abra **Settings → Plugins → Marketplace**, pesquise
|
|
164
|
+
**Recomendado:** Abra **Settings → Plugins → Marketplace**, pesquise **QGraphFlow** ou **代码图谱可视化** e instale o plugin. Inicie uma nova sessão e selecione `q-flow`.
|
|
111
165
|
|
|
112
|
-
Para uma instalação local, conclua primeiro a etapa 1. Depois, abra **Settings → Plugins → Custom → Import** e importe o diretório raiz completo do plugin
|
|
166
|
+
Para uma instalação local, conclua primeiro a etapa 1. Depois, abra **Settings → Plugins → Custom → Import** e importe o diretório raiz completo do plugin. Inicie uma nova sessão e selecione `q-flow`.
|
|
113
167
|
|
|
114
168
|
#### Cursor
|
|
115
169
|
|
|
@@ -123,27 +177,11 @@ Confirme que `.cursor-plugin/plugin.json` existe nesse local, recarregue a janel
|
|
|
123
177
|
|
|
124
178
|
### 3. Comece a usar
|
|
125
179
|
|
|
126
|
-
Abra seu projeto no cliente, inicie uma nova sessão e selecione a habilidade. Descreva
|
|
127
|
-
|
|
128
|
-
<details>
|
|
129
|
-
<summary>Outra forma de instalação: npm</summary>
|
|
130
|
-
|
|
131
|
-
Você também pode obter o plugin no npmjs.com em vez do ZIP, sem conta, login nem token. Crie um diretório separado, fora do projeto da sua aplicação:
|
|
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
|
-
Agora você está na raiz do plugin. Continue com as etapas de instalação no cliente acima. **Baixar pelo npm não instala automaticamente o plugin no cliente.** O pacote também oferece o comando `qgraphflow`, usado em [Mantenha os diagramas em sincronia com o código](#mantenha-os-diagramas-em-sincronia-com-o-código).
|
|
141
|
-
|
|
142
|
-
</details>
|
|
180
|
+
Abra seu projeto de negócio no cliente, inicie uma nova sessão e selecione a habilidade. Descreva sua solicitação seguindo os exemplos de [Primeiros passos](#primeiros-passos). Abra o HTML gerado no navegador.
|
|
143
181
|
|
|
144
182
|
Quer compilar por conta própria? Consulte as [instruções de compilação do código-fonte](https://github.com/supermax92/qgraphflow/blob/main/docs/distribution.md#prepare-locally).
|
|
145
183
|
|
|
146
|
-
##
|
|
184
|
+
## Uso rápido
|
|
147
185
|
|
|
148
186
|
Os exemplos usam `$qgraphflow:q-flow` no Codex. Se o cliente mostrar `$q-flow`, selecione essa entrada. Nos demais clientes, use a forma de chamada da habilidade indicada acima.
|
|
149
187
|
|
|
@@ -158,7 +196,7 @@ $qgraphflow:q-flow
|
|
|
158
196
|
### Exemplo 1: Entender a arquitetura
|
|
159
197
|
|
|
160
198
|
```text
|
|
161
|
-
$qgraphflow:q-flow Analise este projeto e crie um diagrama de arquitetura em
|
|
199
|
+
$qgraphflow:q-flow Analise este projeto e crie um diagrama de arquitetura em chinês com responsabilidades dos módulos, dependências e limites do sistema.
|
|
162
200
|
```
|
|
163
201
|
|
|
164
202
|
Útil para conhecer a estrutura geral ao entrar em um projeto.
|
|
@@ -166,13 +204,13 @@ $qgraphflow:q-flow Analise este projeto e crie um diagrama de arquitetura em por
|
|
|
166
204
|
### Exemplo 2: Acompanhar um fluxo de negócio
|
|
167
205
|
|
|
168
206
|
```text
|
|
169
|
-
$qgraphflow:q-flow Analise a criação de pedidos e gere um diagrama de sequência em
|
|
207
|
+
$qgraphflow:q-flow Analise a criação de pedidos e gere um diagrama de sequência em chinês com cálculo de preços, reserva de estoque, pagamento e persistência do pedido, incluindo os ramos de falha.
|
|
170
208
|
```
|
|
171
209
|
|
|
172
210
|
Substitua a criação de pedidos e suas etapas pelo fluxo real do projeto. Continue na mesma conversa:
|
|
173
211
|
|
|
174
212
|
```text
|
|
175
|
-
$qgraphflow:q-flow Expanda a reserva de estoque do diagrama anterior em um fluxograma separado em
|
|
213
|
+
$qgraphflow:q-flow Expanda a reserva de estoque do diagrama anterior em um fluxograma separado em chinês, mostrando o tratamento de sucesso e falha.
|
|
176
214
|
```
|
|
177
215
|
|
|
178
216
|
Os resultados ficam em `docs/qgraphflow/` por padrão. Abra `index.html` para explorar, editar e exportar; `graph.json` mantém os dados do grafo. Cada vista também é gravada como SVG (`diagram.svg`, ou `diagram-<n>-<type>.svg` quando há várias vistas), que pode ser incorporado como imagem em um README, pull request ou wiki.
|
|
@@ -180,26 +218,23 @@ Os resultados ficam em `docs/qgraphflow/` por padrão. Abra `index.html` para ex
|
|
|
180
218
|
Depois de editar na página, **Mais → Salvar alterações** no Chrome ou no Edge regrava a página, o `graph.json` e os SVG no lugar, depois que você escolhe a pasta do diagrama uma vez. Outros navegadores salvam só o `graph.json`: coloque-o na pasta e gere de novo a página e os SVG com `npx -y qgraphflow generate docs/qgraphflow/<name>/graph.json docs/qgraphflow/<name> --layout preserve --force`.
|
|
181
219
|
|
|
182
220
|
<details>
|
|
183
|
-
<summary>Executar
|
|
221
|
+
<summary>Executar o exemplo do Jeepay com onze vistas baseado em código-fonte</summary>
|
|
184
222
|
|
|
185
|
-
|
|
223
|
+
Selecione sua cópia local do código-fonte do Jeepay para verificar as evidências:
|
|
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.pt.graph.json output/ecommerce-pt
|
|
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
|
-
Abra `output/
|
|
195
|
-
|
|
196
|
-
O Viewer pré-compilado não exige instalar dependências, chave de API ou backend. A coleta de evidências e a criação de diagramas por IA usam o serviço de modelos do cliente escolhido.
|
|
231
|
+
Abra `output/jeepay/index.html`; os onze SVG estão no mesmo diretório. Consulte o [README do corpus](../../examples/jeepay) para conhecer a revisão do código-fonte e o procedimento de atualização.
|
|
197
232
|
|
|
198
233
|
</details>
|
|
199
234
|
|
|
200
235
|
## Mantenha os diagramas em sincronia com o código
|
|
201
236
|
|
|
202
|
-
Um diagrama gerado com a raiz do repositório registra onde cada componente é definido. A validação com `--repo-root` falha quando um arquivo registrado sumiu, um intervalo de linhas não cabe mais no arquivo ou um símbolo registrado saiu das suas linhas, e o erro indica as linhas em que o símbolo está agora. Adicione este job ao seu CI; ele não precisa de build, login nem token:
|
|
237
|
+
Um diagrama gerado com a raiz do repositório registra onde cada componente é definido e a linha por trás de cada relação sustentada pelo código (uma chamada, uma chave estrangeira). A validação com `--repo-root` falha quando um arquivo registrado sumiu, um intervalo de linhas não cabe mais no arquivo ou um símbolo registrado saiu das suas linhas, e o erro indica as linhas em que o símbolo está agora. Adicione este job ao seu CI; ele não precisa de build, login nem token:
|
|
203
238
|
|
|
204
239
|
```yaml
|
|
205
240
|
name: Diagrams
|
|
@@ -227,19 +262,21 @@ $qgraphflow:q-flow O CI diz que docs/qgraphflow/order-sequence está desatualiza
|
|
|
227
262
|
|
|
228
263
|
A habilidade move as âncoras cujo símbolo aparece uma única vez no arquivo, corrige apenas as âncoras que ainda falham e gera de novo a página e os SVG, mantendo as posições e os textos que você editou. Ela não redesenha o diagrama.
|
|
229
264
|
|
|
230
|
-
## O que cada
|
|
265
|
+
## O que cada um dos onze tipos de diagrama responde
|
|
231
266
|
|
|
232
267
|
| Vista · PNG | Pergunta principal | Escopo do exemplo |
|
|
233
268
|
| --- | --- | --- |
|
|
234
|
-
| Arquitetura
|
|
235
|
-
|
|
|
236
|
-
|
|
|
237
|
-
|
|
|
238
|
-
|
|
|
239
|
-
|
|
|
240
|
-
|
|
|
241
|
-
|
|
|
242
|
-
|
|
|
269
|
+
| Arquitetura de capacidades da plataforma | Quais capacidades a plataforma oferece? | Zonas de capacidades e matrizes |
|
|
270
|
+
| Arquitetura em camadas de engenharia | Como o código do projeto é organizado? | Camadas de engenharia e suporte compartilhado |
|
|
271
|
+
| Arquitetura de relações entre componentes | Quais limites de responsabilidade colaboram no sistema? | Canais, orquestração de transações, preços, risco, estoque, pagamento, pedidos, eventos e execução de pedidos |
|
|
272
|
+
| Fluxograma | Como cada decisão se ramifica e converge? | Falta de estoque, recusa de risco, compensação de falha de pagamento e confirmação bem-sucedida |
|
|
273
|
+
| Sequência | Em que ordem uma solicitação faz chamadas e recebe retornos? | Fluxo principal de compra bem-sucedida e OrderPaid assíncrono |
|
|
274
|
+
| ER | Como os dados centrais se relacionam? | Carrinho, pedidos, itens, pagamentos, reservas de estoque e pacotes |
|
|
275
|
+
| Implantação | Onde ficam as unidades de execução e como se conectam? | Borda, Kubernetes, serviços de dados, pagamento e redes de armazém e logística |
|
|
276
|
+
| Classes | Como objetos de domínio e contratos do código dependem entre si? | Serviço de aplicação Checkout, Order e quatro portas |
|
|
277
|
+
| Estados | Quais eventos e condições de guarda fazem um pedido avançar? | Pagamento, execução do pedido, cancelamento, reembolso e encerramento |
|
|
278
|
+
| Casos de uso | Quais capacidades cada ator possui? | Comprador, lojista, depósito e atendimento |
|
|
279
|
+
| Fluxo de dados | Por quais transformações e armazenamentos os ativos de dados passam? | Carrinho, decisões de transação, eventos de pedidos, armazém e logística e comprovantes de entrega |
|
|
243
280
|
|
|
244
281
|
Este modelo conceitual demonstra o QGraphFlow e não corresponde a um repositório de comércio específico. O exemplo `graph.json` não inventa caminhos de código e marca as evidências das relações como `inference`. Diagramas reais precisam de código, DDL, configuração, testes e requisitos aceitos rastreáveis.
|
|
245
282
|
|
|
@@ -253,10 +290,22 @@ node --test tests/*.test.mjs skills/q-flow/scripts/*.test.mjs
|
|
|
253
290
|
|
|
254
291
|
São necessários Node.js 22 ou posterior, npm, tar, zip e unzip. Ao relatar problemas, inclua um grafo mínimo sem informações sensíveis, versões do cliente e navegador e passos de reprodução.
|
|
255
292
|
|
|
256
|
-
Documentação de referência (em inglês): [Fontes de evidência](../../skills/q-flow/references/evidence-sources.md) · [Formato dos grafos](../../skills/q-flow/references/graph-schema.md) · [Consulta guiada](../../skills/q-flow/references/guided-intake.md) · [Desenvolvimento do Viewer](../../skills/q-flow/references/viewer-development.md) · [Composição de diagramas](../../skills/q-flow/references/visual-contract.md)
|
|
293
|
+
Documentação de referência (em inglês): [Fontes de evidência](../../skills/q-flow/references/evidence-sources.md) · [Formato dos grafos](../../skills/q-flow/references/graph-schema.md) · [Consulta guiada](../../skills/q-flow/references/guided-intake.md) · [Desenvolvimento e aceitação do Viewer](../../skills/q-flow/references/viewer-development.md) · [Composição de diagramas](../../skills/q-flow/references/visual-contract.md)
|
|
257
294
|
|
|
258
295
|
## Licença e atribuição
|
|
259
296
|
|
|
260
297
|
[MIT](../../LICENSE) · [Avisos de terceiros](../../THIRD_PARTY_NOTICES.md)
|
|
261
298
|
|
|
262
|
-
QGraphFlow é um projeto independente sob a licença MIT. Os cenários deste documento são conceituais e não representam a arquitetura de produção de nenhuma empresa
|
|
299
|
+
QGraphFlow é um projeto independente sob a licença MIT. Os cenários deste documento são exemplos conceituais e não representam a arquitetura de produção de nenhuma empresa real.
|
|
300
|
+
|
|
301
|
+
## Visões gerais de arquitetura
|
|
302
|
+
|
|
303
|
+
A arquitetura agora inclui relações entre componentes, capacidades da plataforma e camadas de engenharia. Descreva o objeto e a pergunta; a habilidade escolhe o modelo. As coleções solicitadas podem conter várias vistas de arquitetura com edições independentes.
|
|
304
|
+
|
|
305
|
+
```text
|
|
306
|
+
$qgraphflow:q-flow Analise as capacidades da plataforma e as formas de integração de negócio do projeto atual e gere uma visão geral de capacidades da plataforma em chinês.
|
|
307
|
+
$qgraphflow:q-flow Analise a organização do projeto atual e suas camadas de componentes e gere visões gerais em chinês do projeto inteiro e de uma seção de um componente.
|
|
308
|
+
$qgraphflow:q-flow Gere uma visão geral em inglês das capacidades da plataforma deste projeto e mostre como os módulos de aplicação se integram.
|
|
309
|
+
```
|
|
310
|
+
|
|
311
|
+
Consulte [examples/jeepay](../../examples/jeepay) para ver as vistas de arquitetura de plataforma, engenharia e relações entre componentes baseadas em código-fonte real. Desbloqueie uma visão geral para reordenar cartões dentro de uma camada ou editar textos. Salvar mantém todas as vistas; redefinir restaura apenas a atual.
|