@seafteam/seaf-archtool-core-plugin-suite 2026.29.0-rc-test.6
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/LICENSE +201 -0
- package/NOTICE +27 -0
- package/documentation/arch/aspects.yaml +81 -0
- package/documentation/arch/components/browser.yaml +51 -0
- package/documentation/arch/components/examples/context.yaml +37 -0
- package/documentation/arch/components/examples/order.yaml +92 -0
- package/documentation/arch/components/examples/payment.yaml +92 -0
- package/documentation/arch/components/examples/root.yaml +42 -0
- package/documentation/arch/components/front.yaml +309 -0
- package/documentation/arch/components/gitlab.yaml +81 -0
- package/documentation/arch/components/plantuml.yaml +57 -0
- package/documentation/arch/components/root.yaml +36 -0
- package/documentation/arch/components/user.yaml +41 -0
- package/documentation/arch/components/web.yaml +39 -0
- package/documentation/arch/contexts.yaml +99 -0
- package/documentation/arch/forms.yaml +36 -0
- package/documentation/arch/namespaces.yaml +43 -0
- package/documentation/arch/root.yaml +43 -0
- package/documentation/arch/rules.yaml +91 -0
- package/documentation/arch/technologies.yaml +84 -0
- package/documentation/dochub.yaml +32 -0
- package/documentation/docs/conception/archdistrib.puml +38 -0
- package/documentation/docs/conception/archeco.puml +11 -0
- package/documentation/docs/conception/archeco_proc.puml +29 -0
- package/documentation/docs/conception/archver.puml +24 -0
- package/documentation/docs/conception/facade.puml +20 -0
- package/documentation/docs/conception/introduction.md +144 -0
- package/documentation/docs/conception/mindmap.puml +55 -0
- package/documentation/docs/conception/root.yaml +66 -0
- package/documentation/docs/manual/aspects.md +37 -0
- package/documentation/docs/manual/backend/api.yaml +664 -0
- package/documentation/docs/manual/backend/search-implementation.md +190 -0
- package/documentation/docs/manual/backend/search.yaml +495 -0
- package/documentation/docs/manual/clickstream-setup.md +50 -0
- package/documentation/docs/manual/components.md +45 -0
- package/documentation/docs/manual/config/deployment.md +337 -0
- package/documentation/docs/manual/context_source.puml +17 -0
- package/documentation/docs/manual/contexts.md +200 -0
- package/documentation/docs/manual/datasets.md +120 -0
- package/documentation/docs/manual/docs/AI_TABLE_INTEGRATION.md +81 -0
- package/documentation/docs/manual/docs/asyncapi.md +63 -0
- package/documentation/docs/manual/docs/bpmn.md +122 -0
- package/documentation/docs/manual/docs/charts.md +371 -0
- package/documentation/docs/manual/docs/docs.md +76 -0
- package/documentation/docs/manual/docs/drawio_intro.md +397 -0
- package/documentation/docs/manual/docs/editable_table/menu.yaml +5 -0
- package/documentation/docs/manual/docs/editable_table/root.yaml +9 -0
- package/documentation/docs/manual/docs/editable_table/step_0_base/menu.yaml +6 -0
- package/documentation/docs/manual/docs/editable_table/step_0_base/root.yaml +3 -0
- package/documentation/docs/manual/docs/editable_table/step_0_base/table.yaml +396 -0
- package/documentation/docs/manual/docs/editable_table/step_0_base/template.md +404 -0
- package/documentation/docs/manual/docs/editable_table/step_1_acquaintance/menu.yaml +5 -0
- package/documentation/docs/manual/docs/editable_table/step_1_acquaintance/root.yaml +3 -0
- package/documentation/docs/manual/docs/editable_table/step_1_acquaintance/table.yaml +136 -0
- package/documentation/docs/manual/docs/editable_table/step_1_acquaintance/template.md +247 -0
- package/documentation/docs/manual/docs/editable_table/step_2_parameterization/data/pets.yaml +23 -0
- package/documentation/docs/manual/docs/editable_table/step_2_parameterization/data/root.yaml +2 -0
- package/documentation/docs/manual/docs/editable_table/step_2_parameterization/menu.yaml +34 -0
- package/documentation/docs/manual/docs/editable_table/step_2_parameterization/root.yaml +4 -0
- package/documentation/docs/manual/docs/editable_table/step_2_parameterization/table.yaml +36 -0
- package/documentation/docs/manual/docs/editable_table/step_2_parameterization/template_root.md +110 -0
- package/documentation/docs/manual/docs/editable_table/step_2_parameterization/template_table.md +3 -0
- package/documentation/docs/manual/docs/editable_table/step_3_headers/menu.yaml +6 -0
- package/documentation/docs/manual/docs/editable_table/step_3_headers/root.yaml +2 -0
- package/documentation/docs/manual/docs/editable_table/step_3_headers/template.md +300 -0
- package/documentation/docs/manual/docs/editable_table/step_4_editing/data/data.yaml +10 -0
- package/documentation/docs/manual/docs/editable_table/step_4_editing/data/root.yaml +2 -0
- package/documentation/docs/manual/docs/editable_table/step_4_editing/examples/auto_imports/data/data_column_1.yaml +3 -0
- package/documentation/docs/manual/docs/editable_table/step_4_editing/examples/auto_imports/data/root.yaml +2 -0
- package/documentation/docs/manual/docs/editable_table/step_4_editing/examples/auto_imports/menu.yaml +6 -0
- package/documentation/docs/manual/docs/editable_table/step_4_editing/examples/auto_imports/root.yaml +4 -0
- package/documentation/docs/manual/docs/editable_table/step_4_editing/examples/auto_imports/table.yaml +52 -0
- package/documentation/docs/manual/docs/editable_table/step_4_editing/examples/auto_imports/template.md +117 -0
- package/documentation/docs/manual/docs/editable_table/step_4_editing/examples/root.yaml +2 -0
- package/documentation/docs/manual/docs/editable_table/step_4_editing/menu.yaml +6 -0
- package/documentation/docs/manual/docs/editable_table/step_4_editing/root.yaml +5 -0
- package/documentation/docs/manual/docs/editable_table/step_4_editing/table.yaml +116 -0
- package/documentation/docs/manual/docs/editable_table/step_4_editing/template.md +231 -0
- package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/base_example/data.yaml +30 -0
- package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/base_example/menu.yaml +5 -0
- package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/base_example/root.yaml +4 -0
- package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/base_example/table.yaml +122 -0
- package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/base_example/template.md +276 -0
- package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/hiding_columns/data.yaml +11 -0
- package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/hiding_columns/menu.yaml +5 -0
- package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/hiding_columns/root.yaml +4 -0
- package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/hiding_columns/table.yaml +40 -0
- package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/hiding_columns/template.md +59 -0
- package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/root.yaml +3 -0
- package/documentation/docs/manual/docs/editable_table/step_5_styles/menu.yaml +5 -0
- package/documentation/docs/manual/docs/editable_table/step_5_styles/root.yaml +4 -0
- package/documentation/docs/manual/docs/editable_table/step_5_styles/table.yaml +35 -0
- package/documentation/docs/manual/docs/editable_table/step_5_styles/template.md +142 -0
- package/documentation/docs/manual/docs/editable_table/step_6_errors/examples/data_errors/data.yaml +40 -0
- package/documentation/docs/manual/docs/editable_table/step_6_errors/examples/data_errors/menu.yaml +5 -0
- package/documentation/docs/manual/docs/editable_table/step_6_errors/examples/data_errors/root.yaml +4 -0
- package/documentation/docs/manual/docs/editable_table/step_6_errors/examples/data_errors/table.yaml +77 -0
- package/documentation/docs/manual/docs/editable_table/step_6_errors/examples/data_errors/template.md +146 -0
- package/documentation/docs/manual/docs/editable_table/step_6_errors/examples/root.yaml +2 -0
- package/documentation/docs/manual/docs/editable_table/step_6_errors/menu.yaml +5 -0
- package/documentation/docs/manual/docs/editable_table/step_6_errors/root.yaml +3 -0
- package/documentation/docs/manual/docs/editable_table/step_6_errors/template.md +3 -0
- package/documentation/docs/manual/docs/editable_table/template.md +24 -0
- package/documentation/docs/manual/docs/examples/asyncapi.yaml +77 -0
- package/documentation/docs/manual/docs/examples/asyncapi_template.json +11 -0
- package/documentation/docs/manual/docs/examples/autors.yaml +30 -0
- package/documentation/docs/manual/docs/examples/bpmn.xml +44 -0
- package/documentation/docs/manual/docs/examples/cat.jpg +0 -0
- package/documentation/docs/manual/docs/examples/charts-bar.yaml +61 -0
- package/documentation/docs/manual/docs/examples/charts-bubble.yaml +47 -0
- package/documentation/docs/manual/docs/examples/charts-doughnut.yaml +42 -0
- package/documentation/docs/manual/docs/examples/charts-line.yaml +55 -0
- package/documentation/docs/manual/docs/examples/charts-pie.yaml +37 -0
- package/documentation/docs/manual/docs/examples/charts-polararea.yaml +54 -0
- package/documentation/docs/manual/docs/examples/charts-radar.yaml +50 -0
- package/documentation/docs/manual/docs/examples/charts-scatter.yaml +48 -0
- package/documentation/docs/manual/docs/examples/charts.yaml +91 -0
- package/documentation/docs/manual/docs/examples/contexts.jsonata +8 -0
- package/documentation/docs/manual/docs/examples/date-picker-example.md +5 -0
- package/documentation/docs/manual/docs/examples/example.html +2 -0
- package/documentation/docs/manual/docs/examples/example.puml +17 -0
- package/documentation/docs/manual/docs/examples/example.yaml +53 -0
- package/documentation/docs/manual/docs/examples/ext-schema.yaml +3 -0
- package/documentation/docs/manual/docs/examples/inlinemeta.md +25 -0
- package/documentation/docs/manual/docs/examples/markaper.yaml +225 -0
- package/documentation/docs/manual/docs/examples/mermaid.mmd +32 -0
- package/documentation/docs/manual/docs/examples/openapi_template.json +16 -0
- package/documentation/docs/manual/docs/examples/pizza-collaboration.xml +383 -0
- package/documentation/docs/manual/docs/examples/sa-anim.yaml +209 -0
- package/documentation/docs/manual/docs/examples/sa-complex-hide-boundary.yaml +94 -0
- package/documentation/docs/manual/docs/examples/sa-complex-hide-leaves.yaml +94 -0
- package/documentation/docs/manual/docs/examples/sa-complex-hide-title.yaml +98 -0
- package/documentation/docs/manual/docs/examples/sa-complex.yaml +92 -0
- package/documentation/docs/manual/docs/examples/sa-gravity.yaml +104 -0
- package/documentation/docs/manual/docs/examples/sa-group.yaml +93 -0
- package/documentation/docs/manual/docs/examples/sa-physical-connection.yaml +79 -0
- package/documentation/docs/manual/docs/examples/sa-query.jsonata +74 -0
- package/documentation/docs/manual/docs/examples/sa-symbol.yaml +72 -0
- package/documentation/docs/manual/docs/examples/sa-through-objects.yaml +46 -0
- package/documentation/docs/manual/docs/examples/sa-without-tips.yaml +43 -0
- package/documentation/docs/manual/docs/examples/showcases.jsonata +5 -0
- package/documentation/docs/manual/docs/examples/smartants_.yaml +160 -0
- package/documentation/docs/manual/docs/examples/table.yaml +341 -0
- package/documentation/docs/manual/docs/examples/template.puml +6 -0
- package/documentation/docs/manual/docs/examples/test.jsonata +3 -0
- package/documentation/docs/manual/docs/examples/toc/2header.md +8 -0
- package/documentation/docs/manual/docs/examples/toc/custom-toc-place-dup.md +37 -0
- package/documentation/docs/manual/docs/examples/toc/custom-toc-place.md +35 -0
- package/documentation/docs/manual/docs/examples/toc/root.yaml +38 -0
- package/documentation/docs/manual/docs/examples/toc/test.md +160 -0
- package/documentation/docs/manual/docs/gigachat/agents/aigena/menu.yaml +5 -0
- package/documentation/docs/manual/docs/gigachat/agents/aigena/root.yaml +2 -0
- package/documentation/docs/manual/docs/gigachat/agents/aigena/template.md +25 -0
- package/documentation/docs/manual/docs/gigachat/agents/menu.yaml +5 -0
- package/documentation/docs/manual/docs/gigachat/agents/react/gigachat.yaml +59 -0
- package/documentation/docs/manual/docs/gigachat/agents/react/menu.yaml +5 -0
- package/documentation/docs/manual/docs/gigachat/agents/react/root.yaml +3 -0
- package/documentation/docs/manual/docs/gigachat/agents/react/template.md +138 -0
- package/documentation/docs/manual/docs/gigachat/agents/root.yaml +5 -0
- package/documentation/docs/manual/docs/gigachat/agents/simple/gigachat.yaml +14 -0
- package/documentation/docs/manual/docs/gigachat/agents/simple/menu.yaml +5 -0
- package/documentation/docs/manual/docs/gigachat/agents/simple/root.yaml +3 -0
- package/documentation/docs/manual/docs/gigachat/agents/simple/template.md +113 -0
- package/documentation/docs/manual/docs/gigachat/agents/template.md +62 -0
- package/documentation/docs/manual/docs/gigachat/menu.yaml +5 -0
- package/documentation/docs/manual/docs/gigachat/root.yaml +4 -0
- package/documentation/docs/manual/docs/gigachat/settings/menu.yaml +5 -0
- package/documentation/docs/manual/docs/gigachat/settings/root.yaml +2 -0
- package/documentation/docs/manual/docs/gigachat/settings/template.md +51 -0
- package/documentation/docs/manual/docs/gigachat/template.md +38 -0
- package/documentation/docs/manual/docs/images/cloud.png +0 -0
- package/documentation/docs/manual/docs/images/component.png +0 -0
- package/documentation/docs/manual/docs/images/system.png +0 -0
- package/documentation/docs/manual/docs/images/user.png +0 -0
- package/documentation/docs/manual/docs/markaper.md +278 -0
- package/documentation/docs/manual/docs/markdown.md +148 -0
- package/documentation/docs/manual/docs/mermaid.md +43 -0
- package/documentation/docs/manual/docs/network.md +117 -0
- package/documentation/docs/manual/docs/plantuml.md +28 -0
- package/documentation/docs/manual/docs/root.yaml +736 -0
- package/documentation/docs/manual/docs/seaf2drawio/examples/basic.yaml +13 -0
- package/documentation/docs/manual/docs/seaf2drawio/examples/diff.yaml +123 -0
- package/documentation/docs/manual/docs/seaf2drawio/examples/example_seaf_data.yaml +1689 -0
- package/documentation/docs/manual/docs/seaf2drawio/examples/root.yaml +5 -0
- package/documentation/docs/manual/docs/seaf2drawio/examples/templates.yaml +55 -0
- package/documentation/docs/manual/docs/seaf2drawio/examples/transformation.yaml +19 -0
- package/documentation/docs/manual/docs/seaf2drawio/object_description.md +35 -0
- package/documentation/docs/manual/docs/seaf2drawio/root.yaml +12 -0
- package/documentation/docs/manual/docs/seaf2drawio/seaf2drawio.md +118 -0
- package/documentation/docs/manual/docs/smartants.md +583 -0
- package/documentation/docs/manual/docs/svg_inline.md +66 -0
- package/documentation/docs/manual/docs/swagger.md +52 -0
- package/documentation/docs/manual/docs/tables.md +264 -0
- package/documentation/docs/manual/docs/templates/example.drawio +43 -0
- package/documentation/docs/manual/docs/templates/test.svg +79 -0
- package/documentation/docs/manual/docs/templates.md +361 -0
- package/documentation/docs/manual/docs/toc.md +137 -0
- package/documentation/docs/manual/entities/bstages.md +43 -0
- package/documentation/docs/manual/entities/bundle.md +105 -0
- package/documentation/docs/manual/entities/entities.md +727 -0
- package/documentation/docs/manual/entities/images/id_errors.png +0 -0
- package/documentation/docs/manual/entities/images/landspace.jpeg +0 -0
- package/documentation/docs/manual/entities/images/menu-single.jpeg +0 -0
- package/documentation/docs/manual/entities/images/menu-tree.jpeg +0 -0
- package/documentation/docs/manual/entities/images/object_select.png +0 -0
- package/documentation/docs/manual/entities/images/problems.png +0 -0
- package/documentation/docs/manual/entities/images/select_inter.png +0 -0
- package/documentation/docs/manual/entities/images/stages.jpg +0 -0
- package/documentation/docs/manual/entities/images/suggests.png +0 -0
- package/documentation/docs/manual/entities/intro.md +73 -0
- package/documentation/docs/manual/entities/rules.md +35 -0
- package/documentation/docs/manual/functions/example.yaml +50 -0
- package/documentation/docs/manual/functions/functions.md +51 -0
- package/documentation/docs/manual/functions/root.yaml +39 -0
- package/documentation/docs/manual/images/jbps1.1.png +0 -0
- package/documentation/docs/manual/images/jbps1.png +0 -0
- package/documentation/docs/manual/images/jbps2.png +0 -0
- package/documentation/docs/manual/images/vsc1.png +0 -0
- package/documentation/docs/manual/imports.md +59 -0
- package/documentation/docs/manual/introduction.md +38 -0
- package/documentation/docs/manual/jsonata.md +268 -0
- package/documentation/docs/manual/plugin-settings.md +134 -0
- package/documentation/docs/manual/plugins/interface.md +226 -0
- package/documentation/docs/manual/plugins/introduction.md +256 -0
- package/documentation/docs/manual/plugins/root.yaml +51 -0
- package/documentation/docs/manual/role-model.md +80 -0
- package/documentation/docs/manual/root-cluster-import.md +82 -0
- package/documentation/docs/manual/root.yaml +199 -0
- package/documentation/docs/manual/rules/exceptions.md +20 -0
- package/documentation/docs/manual/rules/exreason.md +3 -0
- package/documentation/docs/manual/rules/root.yaml +58 -0
- package/documentation/docs/manual/rules/rules.md +8 -0
- package/documentation/docs/manual/rules/standard.md +3 -0
- package/documentation/docs/manual/rules/validators.md +109 -0
- package/documentation/docs/manual/technologies.md +49 -0
- package/documentation/docs/root.yaml +32 -0
- package/documentation/docs/sequence.puml +48 -0
- package/documentation/docs/welcome.md +3 -0
- package/documentation/entities/extentions/entity.yaml +136 -0
- package/documentation/entities/extentions/templates/people.md +4 -0
- package/documentation/entities/interactions/entity.yaml +412 -0
- package/documentation/entities/interactions/templates/blank.puml +18 -0
- package/documentation/entities/interactions/templates/bpmn.xml +59 -0
- package/documentation/entities/interactions/templates/tree.puml +11 -0
- package/documentation/entities/root.yaml +33 -0
- package/documentation/root.yaml +37 -0
- package/metamodel/dochub/entities/aspects/base.yaml +73 -0
- package/metamodel/dochub/entities/aspects/blank.yaml +65 -0
- package/metamodel/dochub/entities/aspects/components.yaml +52 -0
- package/metamodel/dochub/entities/aspects/contexts.yaml +57 -0
- package/metamodel/dochub/entities/aspects/docs.yaml +51 -0
- package/metamodel/dochub/entities/aspects/hierarchy.yaml +80 -0
- package/metamodel/dochub/entities/aspects/root.yaml +9 -0
- package/metamodel/dochub/entities/aspects/summary.yaml +64 -0
- package/metamodel/dochub/entities/aspects/templates/components.md +5 -0
- package/metamodel/dochub/entities/aspects/templates/hierarchy.puml +5 -0
- package/metamodel/dochub/entities/aspects/templates/summary.md +9 -0
- package/metamodel/dochub/entities/aspects/templates/tree.puml +5 -0
- package/metamodel/dochub/entities/aspects/tree.yaml +37 -0
- package/metamodel/dochub/entities/components/base.yaml +97 -0
- package/metamodel/dochub/entities/components/blank.yaml +64 -0
- package/metamodel/dochub/entities/components/contexts.yaml +55 -0
- package/metamodel/dochub/entities/components/docs.yaml +50 -0
- package/metamodel/dochub/entities/components/hierarchy.yaml +84 -0
- package/metamodel/dochub/entities/components/index.yaml +17 -0
- package/metamodel/dochub/entities/components/root.yaml +8 -0
- package/metamodel/dochub/entities/components/summary.yaml +58 -0
- package/metamodel/dochub/entities/components/symbol.yaml +113 -0
- package/metamodel/dochub/entities/components/templates/hierarchy.puml +5 -0
- package/metamodel/dochub/entities/components/templates/summary.md +8 -0
- package/metamodel/dochub/entities/components/templates/tree.puml +5 -0
- package/metamodel/dochub/entities/components/tree.yaml +38 -0
- package/metamodel/dochub/entities/contexts/base.yaml +197 -0
- package/metamodel/dochub/entities/contexts/plantuml.yaml +241 -0
- package/metamodel/dochub/entities/contexts/root.yaml +5 -0
- package/metamodel/dochub/entities/contexts/smartants.yaml +177 -0
- package/metamodel/dochub/entities/contexts/templates/template.puml +183 -0
- package/metamodel/dochub/entities/contexts/templates/tree.puml +5 -0
- package/metamodel/dochub/entities/contexts/tree.yaml +39 -0
- package/metamodel/dochub/entities/documents/base.yaml +73 -0
- package/metamodel/dochub/entities/documents/blank.yaml +28 -0
- package/metamodel/dochub/entities/documents/root.yaml +3 -0
- package/metamodel/dochub/entities/root.yaml +5 -0
- package/metamodel/dochub/functions/root.yaml +2 -0
- package/metamodel/dochub/functions/tools.yaml +46 -0
- package/metamodel/dochub/root.yaml +24 -0
- package/metamodel/dochub/rules/root.yaml +2 -0
- package/metamodel/dochub/rules/validators.yaml +144 -0
- package/metamodel/dochub/samples/01_components.yaml +23 -0
- package/metamodel/dochub/samples/02_contexts.yaml +23 -0
- package/metamodel/dochub/samples/03_documents.yaml +10 -0
- package/metamodel/dochub/samples/root.yaml +4 -0
- package/metamodel/dochub/samples/test.puml +17 -0
- package/metamodel/dochub.yaml +5 -0
- package/metamodel/docs/welcome.md +39 -0
- package/metamodel/root.yaml +8 -0
- package/package.json +29 -0
- package/plugin.html +1961 -0
|
@@ -0,0 +1,134 @@
|
|
|
1
|
+
# Настройки плагина
|
|
2
|
+
|
|
3
|
+
Настройки плагина - это набор параметров, которые определяют его поведение в вашей среде разработки. С их помощью вы можете включать и отключать функции и задавать пути к ресурсам. В этом разделе рассматриваются параметры плагинов для JetBrains и VSCode.
|
|
4
|
+
|
|
5
|
+
## Как попасть в настройки плагина
|
|
6
|
+
|
|
7
|
+
### JetBrains
|
|
8
|
+
|
|
9
|
+
IDE and Project Settings -> Settings -> Tools -> SEAF.ArchTool: Plugin Settings
|
|
10
|
+

|
|
11
|
+

|
|
12
|
+
|
|
13
|
+
или
|
|
14
|
+
|
|
15
|
+
Plugin Tools -> Plugin Settings
|
|
16
|
+

|
|
17
|
+
|
|
18
|
+
### VSCode
|
|
19
|
+
|
|
20
|
+
Extensions -> SEAF.ArchTool -> Manage -> Settings
|
|
21
|
+

|
|
22
|
+
|
|
23
|
+
## Параметры
|
|
24
|
+
|
|
25
|
+
### Enterprise mode
|
|
26
|
+
|
|
27
|
+
Enterprise mode позволяет плагину автоматически подгружать ядро инструмента и метамодель с портала. Достаточно указать ссылку на портал - и все необходимые параметры будут применены без дополнительной ручной настройки. При этом часть настроек становится недоступной в настройках плагина, так как их конфигурация централизована через портал.
|
|
28
|
+
|
|
29
|
+
Названия параметров в плагине:
|
|
30
|
+
|
|
31
|
+
JetBrains
|
|
32
|
+
* Using mode - включение / выключение Enterprise mode
|
|
33
|
+
* Enterprise portal - ссылка на портал, данный параметр появляется после выбора Enterprise в Using mode
|
|
34
|
+
|
|
35
|
+
VSCode
|
|
36
|
+
* Is Enterprise Mode - включение / выключение Enterprise mode
|
|
37
|
+
* Enterprise Server - ссылка на портал
|
|
38
|
+
|
|
39
|
+
⚠️ На данный момент Enterprise mode присутствует в плагинах, но официально не поддерживается и не тестируется.
|
|
40
|
+
|
|
41
|
+
### External rendering
|
|
42
|
+
|
|
43
|
+
External rendering позволяет использовать внешний сервер для рендеринга диаграмм PlantUML. В этом режиме плагин отправляет запросы на указанный сервер вместо выполнения рендеринга локально.
|
|
44
|
+
|
|
45
|
+
Названия параметров в плагине:
|
|
46
|
+
|
|
47
|
+
JetBrains
|
|
48
|
+
* External rendering - включение / выключение External rendering
|
|
49
|
+
* Render server - ссылка на сервер рендеринга, данный параметр появляется после включения External rendering
|
|
50
|
+
* Request type - тип запроса, используемый для отправки задачи на рендеринг, данный параметр появляется после включения External rendering
|
|
51
|
+
|
|
52
|
+
VSCode
|
|
53
|
+
* Plantuml Render server - ссылка на сервер рендеринга
|
|
54
|
+
* Plantuml Request type - тип запроса, используемый для отправки задачи на рендеринг
|
|
55
|
+
* Plantuml Mode - выбор библиотеки, которая будет использована для рендеринга (⚠️ На данный момент эта настройка не работает)
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
### Git
|
|
59
|
+
|
|
60
|
+
Плагин поддерживает импорт данных из удаленных репозиториев непосредственно в коде. При импорте указывается тип системы контроля версий и путь к ресурсу (bitbucket:arch:berezka:root.yaml).
|
|
61
|
+
Для работы таких импортов необходимо настроить параметры подключения в разделе Git.
|
|
62
|
+
Плагин обрабатывает импорты только для той системы контроля версий, которая указана в этих настройках.
|
|
63
|
+
Плагин JetBrains поддерживает работу с Bitbucket (API v1, v2) и Gitlab.
|
|
64
|
+
⚠️ На данный момент настройки Git присутствуют в плагине VSCode, но этот функционал не работает.
|
|
65
|
+
|
|
66
|
+
Названия параметров в плагине:
|
|
67
|
+
|
|
68
|
+
JetBrains
|
|
69
|
+
* Git server vendor (Bitbucket / Gitlab) - тип системы контроля версий
|
|
70
|
+
* Git server - адрес сервера системы контроля версий, на котором размещены репозитории
|
|
71
|
+
* Git personal token - персональный токен доступа, используемый для аутентификации при обращении к серверу СКВ
|
|
72
|
+
* Bitbucket mode - версия API Bitbucket, данный параметр отображается при выборе значения Bitbucket в параметре Git server vendor
|
|
73
|
+
|
|
74
|
+
### GigaChat
|
|
75
|
+
|
|
76
|
+
Эта группа параметров позволяет переопределить значения соответствующих переменных окружения для интеграции с GigaChat.
|
|
77
|
+
Подробнее про GigaChat и его настройку можно прочитать в разделе [GigaChat](/entities/docs/blank?dh-doc-id=archtool.plugins.gigachat.menu).
|
|
78
|
+
|
|
79
|
+
* GIGACHAT token - токен доступа для авторизации запросов к API
|
|
80
|
+
* GIGACHAT scope - версия API GigaChat
|
|
81
|
+
* GIGACHAT mode - режим работы GigaChat (Bank network - работа осуществляется в сети Банка / External network - работа осуществляется во внешней сети)
|
|
82
|
+
* GIGACHAT auth url - URL для получения токена доступа для авторизации запросов к API
|
|
83
|
+
|
|
84
|
+
_Данная группа параметров доступна только для плагина JetBrains_
|
|
85
|
+
|
|
86
|
+
### S3
|
|
87
|
+
|
|
88
|
+
Параметр S3 service url предназначен для указания адреса сервиса, который используется для работы с файловым хранилищем.
|
|
89
|
+
|
|
90
|
+
_Данный параметр доступен только для плагина JetBrains_
|
|
91
|
+
|
|
92
|
+
### ENV
|
|
93
|
+
|
|
94
|
+
Параметр ENV предназначен для переопределения значения переменных окружения. На текущий момент поддерживает только переопределение конфигурации ClickStream.
|
|
95
|
+
|
|
96
|
+
_Данный параметр доступен только для плагина JetBrains_
|
|
97
|
+
|
|
98
|
+
### Logging
|
|
99
|
+
|
|
100
|
+
Эта группа параметров управляет поведением логирования в плагине.
|
|
101
|
+
|
|
102
|
+
* Logging level - позволяет настроить уровень логирования. По умолчанию INFO
|
|
103
|
+
* Log dir in project - позволяет разместить директорию с файлами логов в проекте. Важно: в случае размещения директории в проекте не забудьте включить ее в gitignore
|
|
104
|
+
* Enable jsonata $log func - позволяет включить запись логов выполнения JSONata запросов ($log)
|
|
105
|
+
|
|
106
|
+
_Данная группа параметров доступна только для плагина JetBrains_
|
|
107
|
+
|
|
108
|
+
### Meta
|
|
109
|
+
|
|
110
|
+
Параметр Using meta позволяет включить интеграцию с Meta (только для сотрудников Банка).
|
|
111
|
+
|
|
112
|
+
_Данный параметр доступен только для плагина JetBrains_
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
### Cache mode
|
|
116
|
+
|
|
117
|
+
Параметр Cache mode включает или отключает использование кеширования при работе плагина. Кеш позволяет повторно использовать ранее полученные данные и может применяться для оптимизации работы в зависимости от сценария использования.
|
|
118
|
+
|
|
119
|
+
Названия параметра в плагине:
|
|
120
|
+
|
|
121
|
+
JetBrains
|
|
122
|
+
* Cache mode
|
|
123
|
+
|
|
124
|
+
VSCode
|
|
125
|
+
* Is Cache Mode
|
|
126
|
+
|
|
127
|
+
### Plugin Version
|
|
128
|
+
|
|
129
|
+
Параметр Plugin Version содержит информацию о версии установленного плагина
|
|
130
|
+
|
|
131
|
+
_Данный параметр доступен только для плагина VSCode_
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
|
|
@@ -0,0 +1,226 @@
|
|
|
1
|
+
# Интерфейсы ядра
|
|
2
|
+
|
|
3
|
+
Ядро SEAF.ArchTool предоставляет два интерфейса для взаимодействия плагинов с ним:
|
|
4
|
+
|
|
5
|
+
## 1. Глобальная переменная DocHub
|
|
6
|
+
|
|
7
|
+
window.DocHub - глобальная переменная содержащая коллекцию менеджеров, управляющих базовыми сущностями DocHub.
|
|
8
|
+
|
|
9
|
+
### DocHub.documents.register(type: String, component: Component)
|
|
10
|
+
|
|
11
|
+
Регистрирует новый тип документов. Принимает параметры:
|
|
12
|
+
|
|
13
|
+
* **type** - Название типа документа;
|
|
14
|
+
* **component** - Vue 3 компонент, который будет использован для рендеринга документов указанного типа.
|
|
15
|
+
|
|
16
|
+
Пример использования:
|
|
17
|
+
|
|
18
|
+
```JavaScript
|
|
19
|
+
import doc from './components/HTMLDocument.vue';
|
|
20
|
+
|
|
21
|
+
DocHub.documents.register('html', doc);
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
## 2. Параметры компонентов documents
|
|
25
|
+
|
|
26
|
+
### profile: Object
|
|
27
|
+
|
|
28
|
+
В параметре передается объект, содержащий данные участка архитектурного кода, конфигурирующего представление
|
|
29
|
+
документа. Например, код:
|
|
30
|
+
|
|
31
|
+
```yaml
|
|
32
|
+
docs:
|
|
33
|
+
...
|
|
34
|
+
arcthool.plugins.example:
|
|
35
|
+
location: SEAF.ArchTool/Руководство/Документы/HTML
|
|
36
|
+
type: html
|
|
37
|
+
source: examples/example.html
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
вызовет компонент плагина, зарегистрированного для типа документа "html", которому будет передана
|
|
41
|
+
в параметре "manifest" структура:
|
|
42
|
+
|
|
43
|
+
```json
|
|
44
|
+
{
|
|
45
|
+
"location": "SEAF.ArchTool/Руководство/Документы/HTML",
|
|
46
|
+
"type": "html",
|
|
47
|
+
"source": "examples/example.html"
|
|
48
|
+
}
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
Пример использования:
|
|
52
|
+
```JavaScript
|
|
53
|
+
props: {
|
|
54
|
+
...
|
|
55
|
+
profile: {
|
|
56
|
+
type: Object,
|
|
57
|
+
required: true
|
|
58
|
+
},
|
|
59
|
+
...
|
|
60
|
+
}
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
### params: Object
|
|
64
|
+
|
|
65
|
+
Содержит параметры переданные в документ.
|
|
66
|
+
|
|
67
|
+
Пример встраивания документа в [markdown](/docs/archtool.markdown):
|
|
68
|
+
|
|
69
|
+
```
|
|
70
|
+

|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
В этом случае свойство будет содержать структуру:
|
|
74
|
+
```json
|
|
75
|
+
{
|
|
76
|
+
"param1": "foo1",
|
|
77
|
+
"param2": "foo2"
|
|
78
|
+
}
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
Параметры также могут быть переданы в ссылке, например:
|
|
82
|
+
|
|
83
|
+
[/docs/archtool.plugins.example?param1=foo1¶m2=foo2](/docs/archtool.plugins.example?param1=foo1¶m2=foo2)
|
|
84
|
+
|
|
85
|
+
Свойство params будет иметь значение идентичное первому случаю.
|
|
86
|
+
|
|
87
|
+
### path: String
|
|
88
|
+
|
|
89
|
+
Содержит путь к объекту документа.
|
|
90
|
+
|
|
91
|
+
Код:
|
|
92
|
+
|
|
93
|
+
```yaml
|
|
94
|
+
docs:
|
|
95
|
+
...
|
|
96
|
+
archtool.plugins.example:
|
|
97
|
+
location: SEAF.ArchTool/Руководство/Документы/HTML
|
|
98
|
+
type: html
|
|
99
|
+
headers:
|
|
100
|
+
head1:
|
|
101
|
+
type: test
|
|
102
|
+
source: examples/example.html
|
|
103
|
+
...
|
|
104
|
+
```
|
|
105
|
+
Вызовет компонент плагина с параметром path содержащим строку "/docs/archtool.plugins.example".
|
|
106
|
+
|
|
107
|
+
### getContent: function(URL: String)
|
|
108
|
+
|
|
109
|
+
В архитектурной кодовой базе указываются относительные пути к файлам.
|
|
110
|
+
Для успешного получения контента этих файлов необходимо использовать функцию getContent передающуюся
|
|
111
|
+
в качестве параметра компонента.
|
|
112
|
+
|
|
113
|
+
Функция принимает в качестве параметра URL и возвращает Promise.
|
|
114
|
+
|
|
115
|
+
Рекомендуется также использовать эту функцию для доступа к любым иным ресурсам по http/https.
|
|
116
|
+
|
|
117
|
+
Пример использования:
|
|
118
|
+
```JavaScript
|
|
119
|
+
props: {
|
|
120
|
+
...
|
|
121
|
+
getContent: {
|
|
122
|
+
type: Function,
|
|
123
|
+
required: true
|
|
124
|
+
},
|
|
125
|
+
profile: {
|
|
126
|
+
type: Object,
|
|
127
|
+
required: true
|
|
128
|
+
}
|
|
129
|
+
...
|
|
130
|
+
},
|
|
131
|
+
methods: {
|
|
132
|
+
...
|
|
133
|
+
refresh() {
|
|
134
|
+
...
|
|
135
|
+
this.getContent(this.profile.source)
|
|
136
|
+
.then((response) => {
|
|
137
|
+
console.info(`Успешный успех!`, response.data);
|
|
138
|
+
})
|
|
139
|
+
.catch((error) => {
|
|
140
|
+
console.error(`Ошибка выполнения запроса [${this.profile.source}]`, error);
|
|
141
|
+
});
|
|
142
|
+
...
|
|
143
|
+
}
|
|
144
|
+
...
|
|
145
|
+
}
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
### pullData: function(expression: String, self: Object, params: Object, context: Any)
|
|
149
|
+
|
|
150
|
+
Функция позволяет выполнить запрос к архитектуре для получения необходимых данных.
|
|
151
|
+
Все параметры являются опциональными. При их отсутствии используются дефолтные
|
|
152
|
+
значения.
|
|
153
|
+
|
|
154
|
+
* **expression** - [JSONata](https://jsonata.org/) запрос к архитектуре или идентификатор [DataSet](/docs/archtool.datasets).
|
|
155
|
+
По умолчанию содержит значение из this.profile.source.
|
|
156
|
+
* **self** - Передает в запрос объект для переменной $self. По умолчанию содержит объект this.profile.
|
|
157
|
+
* **params** - Передает в запрос объект для переменной $params. По умолчанию заполняется параметрами переданными в документ this.params.
|
|
158
|
+
* **context** - Контекст для выполнения запроса. По умолчанию контекстом являются данные архитектуры.
|
|
159
|
+
|
|
160
|
+
**ВАЖНО:** Необходимо использовать только эту функцию для доступа к данным архитектуры. Иной путь получения
|
|
161
|
+
данных может приводить к неожиданным результатам.
|
|
162
|
+
|
|
163
|
+
Пример простейшего использования:
|
|
164
|
+
```JavaScript
|
|
165
|
+
props: {
|
|
166
|
+
...
|
|
167
|
+
params: {
|
|
168
|
+
type: Object,
|
|
169
|
+
default: null
|
|
170
|
+
},
|
|
171
|
+
profile: {
|
|
172
|
+
type: Object,
|
|
173
|
+
required: true
|
|
174
|
+
},
|
|
175
|
+
pullData: {
|
|
176
|
+
type: Function,
|
|
177
|
+
required: true
|
|
178
|
+
}
|
|
179
|
+
...
|
|
180
|
+
},
|
|
181
|
+
data() {
|
|
182
|
+
return {
|
|
183
|
+
data: []
|
|
184
|
+
};
|
|
185
|
+
},
|
|
186
|
+
methods: {
|
|
187
|
+
...
|
|
188
|
+
refresh() {
|
|
189
|
+
...
|
|
190
|
+
this.pullData()
|
|
191
|
+
.then((data) => this.data = data)
|
|
192
|
+
.catch((error) => console.error(`Ошибка получения данных`, error));
|
|
193
|
+
...
|
|
194
|
+
}
|
|
195
|
+
...
|
|
196
|
+
}
|
|
197
|
+
```
|
|
198
|
+
|
|
199
|
+
В примере функция выполнит запрос содержащийся в поле this.profile.source к данным архитектуры,
|
|
200
|
+
с параметром $self равным this.profile и $params равным this.params.
|
|
201
|
+
|
|
202
|
+
Пример кастомного запроса к данным архитектуры:
|
|
203
|
+
|
|
204
|
+
Пример простейшего использования:
|
|
205
|
+
```JavaScript
|
|
206
|
+
data() {
|
|
207
|
+
return {
|
|
208
|
+
componentsCount: []
|
|
209
|
+
};
|
|
210
|
+
},
|
|
211
|
+
methods: {
|
|
212
|
+
...
|
|
213
|
+
refresh() {
|
|
214
|
+
...
|
|
215
|
+
this.pullData("($count(components.*))")
|
|
216
|
+
.then((data) => this.componentsCount = data)
|
|
217
|
+
.catch((error) => console.error(`Ошибка получения данных`, error));
|
|
218
|
+
...
|
|
219
|
+
}
|
|
220
|
+
...
|
|
221
|
+
}
|
|
222
|
+
```
|
|
223
|
+
|
|
224
|
+
В данном случае функция выполнит JSONata запрос, который вернет количество описанных компонентов.
|
|
225
|
+
Обратите внимание, что запрос должен всегда обрамляться круглыми скобками.
|
|
226
|
+
|
|
@@ -0,0 +1,256 @@
|
|
|
1
|
+
# Плагины
|
|
2
|
+
|
|
3
|
+
**ВНИМАНИЕ:** Данный функционал находится на этапе beta-тестирования. С высокой вероятностью он будет модифицироваться.
|
|
4
|
+
Мы будем стараться сохранять совместимость при его развитии, но следует учитывать эту информацию
|
|
5
|
+
при принятии решения об его использовании.
|
|
6
|
+
|
|
7
|
+
**ВНИМАНИЕ:** Плагины в настоящий момент поддерживаются только при развертывании SEAF.ArchTool в режиме портала. В плагинах IDE
|
|
8
|
+
данный функционал пока не поддерживается. Но обязательно будет.
|
|
9
|
+
|
|
10
|
+
## Введение
|
|
11
|
+
|
|
12
|
+
Плагины это специально оформленные программные модули на JavaScript, с использованием фреймворка [VUEJS 2](https://v2.vuejs.org/v2/guide/index.html),
|
|
13
|
+
расширяющие функциональные возможности SEAF.ArchTool.
|
|
14
|
+
|
|
15
|
+
С их помощью можно создать:
|
|
16
|
+
|
|
17
|
+
1. Новый [тип документа](/docs/archtool.docs) - реализовано (beta);
|
|
18
|
+
2. [Источник данных](/docs/archtool.datasets) - запланировано.
|
|
19
|
+
|
|
20
|
+
## Создание простого плагина
|
|
21
|
+
|
|
22
|
+
В этом примере показано, как создать плагин, который расширит набор встроенных типов документов новым - "html".
|
|
23
|
+
|
|
24
|
+
Клонируйте репозиторий SEAF.ArchTool.
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
git clone https://gitverse.ru/seafteam/seaf-archtool-core.git
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
Установите все зависимости.
|
|
31
|
+
|
|
32
|
+
```bash
|
|
33
|
+
cd seaf-archtool-core
|
|
34
|
+
npm install
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
Создайте каталог, в котором вы будете разрабатывать свой код в специальной области проекта - ./plugins.
|
|
38
|
+
Например, каталог с именем "html".
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
cd plugins
|
|
42
|
+
mkdir html
|
|
43
|
+
cd html
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
В этом каталоге создайте следующие файлы:
|
|
47
|
+
|
|
48
|
+
* **components/HTMLDocument.vue** - VUE компонент, который будет визуализировать документ;
|
|
49
|
+
* **package.json** - Файл-манифест плагина;
|
|
50
|
+
* **index.js** - Точка входа плагина.
|
|
51
|
+
|
|
52
|
+
### package.json
|
|
53
|
+
|
|
54
|
+
Это стандартный файл, используемый Node.js для описания содержимого проекта.
|
|
55
|
+
|
|
56
|
+
Чтобы сгенерировать стандартный файл package.json, вы можете использовать команду:
|
|
57
|
+
|
|
58
|
+
```bash
|
|
59
|
+
npm init
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
При запуске этой команды вам будет задан ряд вопросов, чтобы помочь создать начальный контент для проекта.
|
|
63
|
+
Многие вопросы имеют ответы по умолчанию. Используйте их там, где это возможно.
|
|
64
|
+
|
|
65
|
+
При появлении запроса дать имя проекту, введите - "dochub-plugin-html".
|
|
66
|
+
|
|
67
|
+
Пример сформированного файла:
|
|
68
|
+
```json
|
|
69
|
+
{
|
|
70
|
+
"name": "dochub-plugin-html",
|
|
71
|
+
"version": "1.0.0",
|
|
72
|
+
"description": "HTML document",
|
|
73
|
+
"main": "index.js",
|
|
74
|
+
"scripts": {
|
|
75
|
+
"test": "echo \"Error: no test specified\" && exit 1"
|
|
76
|
+
},
|
|
77
|
+
"author": "R.Piontik",
|
|
78
|
+
"license": "MIT"
|
|
79
|
+
}
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
### index.js
|
|
83
|
+
|
|
84
|
+
```JavaScript
|
|
85
|
+
import doc from './components/HTMLDocument.vue';
|
|
86
|
+
|
|
87
|
+
DocHub.documents.register('html', doc);
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
Точка входа это JavaScript модуль. Он запускается сразу при подключении.
|
|
91
|
+
|
|
92
|
+
Задачей точки входа является регистрация предоставляемых плагином функциональных возможностей.
|
|
93
|
+
|
|
94
|
+
В примере, для регистрации нового типа документа, используется специальный интерфейс [SEAF.ArchTool](/docs/archtool.plugins.interface).
|
|
95
|
+
|
|
96
|
+
После выполнения описанного в примере кода, в SEAF.ArchTool будет зарегистрирован новый тип документа "html".
|
|
97
|
+
При указании этого типа документа, управление его рендерингом будет передаваться компоненту плагина.
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
### HTMLDocument.vue
|
|
101
|
+
|
|
102
|
+
Файл содержит [Vue 3 компонент](https://ru.vuejs.org/api/built-in-directives.html#v-html). Его задачей является
|
|
103
|
+
рендеринг данных архитектуры в соответствии с переданными ему параметрами в "profile".
|
|
104
|
+
|
|
105
|
+
```JavaScript
|
|
106
|
+
<template>
|
|
107
|
+
<div v-html="content" />
|
|
108
|
+
</template>
|
|
109
|
+
|
|
110
|
+
<script>
|
|
111
|
+
|
|
112
|
+
export default {
|
|
113
|
+
name: 'HTMLDocument',
|
|
114
|
+
props: {
|
|
115
|
+
// Требуем обязательно передавать профайл документа
|
|
116
|
+
profile: {
|
|
117
|
+
type: Object,
|
|
118
|
+
required: true
|
|
119
|
+
},
|
|
120
|
+
// Требуем обязательно передавать функцию получения контента
|
|
121
|
+
getContent: {
|
|
122
|
+
type: Function,
|
|
123
|
+
required: true
|
|
124
|
+
}
|
|
125
|
+
},
|
|
126
|
+
data() {
|
|
127
|
+
return {
|
|
128
|
+
content: ''
|
|
129
|
+
};
|
|
130
|
+
},
|
|
131
|
+
|
|
132
|
+
watch: {
|
|
133
|
+
profile() {
|
|
134
|
+
// При изменении параметров, перезагружаем контент документа с их учетом
|
|
135
|
+
this.refresh();
|
|
136
|
+
}
|
|
137
|
+
},
|
|
138
|
+
mounted() {
|
|
139
|
+
// При монтировании компонента в DOM загружаем контент документа
|
|
140
|
+
this.refresh();
|
|
141
|
+
},
|
|
142
|
+
methods: {
|
|
143
|
+
// Функция обновления контента документа с учетом параметров содержащихся в "this.profile"
|
|
144
|
+
refresh() {
|
|
145
|
+
if (this.profile) {
|
|
146
|
+
// В архитектурной кодовой базе указываются относительные пути к файлам при описании документа.
|
|
147
|
+
// Для успешного получения контента этих файлов необходимо использовать функцию getContent.
|
|
148
|
+
// Рекомендуется также использовать эту функцию для доступа к любым иным ресурсам по http/https.
|
|
149
|
+
this.getContent(this.profile.source)
|
|
150
|
+
// Если все хорошо, рендерим HTML "как есть"
|
|
151
|
+
.then((response) => {
|
|
152
|
+
this.content = response.data;
|
|
153
|
+
})
|
|
154
|
+
// Если что-то пошло не так, генерируем HTML с ошибкой
|
|
155
|
+
.catch((error) => {
|
|
156
|
+
this.content = `<div style="color:#fff; background-color: #f00">Ошибка выполнения запроса [${this.profile.source}]: <br> ${error}</div>`;
|
|
157
|
+
});
|
|
158
|
+
} else this.content = '';
|
|
159
|
+
}
|
|
160
|
+
}
|
|
161
|
+
};
|
|
162
|
+
</script>
|
|
163
|
+
```
|
|
164
|
+
|
|
165
|
+
Параметры "profile" и "getContent" является частью контракта [интерфейса ядра SEAF.ArchTool](/docs/archtool.plugins.interface).
|
|
166
|
+
|
|
167
|
+
## Сборка
|
|
168
|
+
|
|
169
|
+
Плагин должен собираться в контексте проекта SEAF.ArchTool. Для этого, необходимо в файле ./plugins.json указать ссылку на его проект.
|
|
170
|
+
|
|
171
|
+
```json
|
|
172
|
+
{
|
|
173
|
+
"inbuilt": [
|
|
174
|
+
"plugins/html"
|
|
175
|
+
]
|
|
176
|
+
}
|
|
177
|
+
```
|
|
178
|
+
|
|
179
|
+
Обратите внимание, что путь указывается **к папке** с проектом плагина. Сама папка должна располагаться **внутри** проекта SEAF.ArchTool.
|
|
180
|
+
Рекомендуется использовать для этого папку ./plugins.
|
|
181
|
+
|
|
182
|
+
Теперь можно собрать проект SEAF.ArchTool в нескольких режимах:
|
|
183
|
+
|
|
184
|
+
### developing
|
|
185
|
+
|
|
186
|
+
Сборка осуществляется командой:
|
|
187
|
+
```bash
|
|
188
|
+
npm run serve
|
|
189
|
+
```
|
|
190
|
+
|
|
191
|
+
В результате сборки будет локально запущен dev сервер Node.js, который позволит отлаживать ваш проект.
|
|
192
|
+
После сборки информация о доступе к нему будет выведена в консоль и иметь вид:
|
|
193
|
+
|
|
194
|
+
```
|
|
195
|
+
App running at:
|
|
196
|
+
- Local: http://localhost:8080/
|
|
197
|
+
- Network: http://192.168.8.104:8080/
|
|
198
|
+
```
|
|
199
|
+
|
|
200
|
+
Данный режим предназначен для разработки плагинов. Он позволяет вносить изменения в кодовую базу и в режиме
|
|
201
|
+
реального времени (без пересборки) наблюдать результат изменений.
|
|
202
|
+
|
|
203
|
+
### production
|
|
204
|
+
|
|
205
|
+
Сборка осуществляется командой:
|
|
206
|
+
```bash
|
|
207
|
+
npm run build
|
|
208
|
+
```
|
|
209
|
+
|
|
210
|
+
В результате сборки, плагин будет встроен в поставку. Располагаться скомпилированный плагин будет в папке ./dist/plugins.
|
|
211
|
+
|
|
212
|
+
## Использование
|
|
213
|
+
|
|
214
|
+
После сборки проекта SEAF.ArchTool с плагином, достаточно указать необходимый тип документа в коде архитектуры и передать
|
|
215
|
+
плагину информацию о файле контекста. Сделать это можно так:
|
|
216
|
+
|
|
217
|
+
```
|
|
218
|
+
docs:
|
|
219
|
+
...
|
|
220
|
+
archtool.plugins.example:
|
|
221
|
+
location: SEAF.ArchTool/Руководство/Документы/HTML
|
|
222
|
+
type: html
|
|
223
|
+
source: examples/example.html
|
|
224
|
+
```
|
|
225
|
+
|
|
226
|
+
В поле "type" указывается новый тип документа "html" зарегистрированный плагином.
|
|
227
|
+
В поле "source" указывается относительный путь к файлу, содержащему HTML код.
|
|
228
|
+
|
|
229
|
+
Содержимое файла "examples/example.html":
|
|
230
|
+
|
|
231
|
+
```
|
|
232
|
+
|
|
233
|
+
<H1>Привет!</H1>
|
|
234
|
+
<P>Это простейший пример HTML-документа, который выводится с использованием плагина SEAF.ArchTool.</P>
|
|
235
|
+
```
|
|
236
|
+
|
|
237
|
+
Работу примера можно посмотреть [здесь](http://localhost:8080/docs/archtool.plugins.example).
|
|
238
|
+
|
|
239
|
+
Полный исходный код примера можно найти [тут](https://gitverse.ru/seafteam/seaf-archtool-core/content/master/plugins/html).
|
|
240
|
+
|
|
241
|
+
## Встраивание объектов SEAF.ArchTool в представления плагина
|
|
242
|
+
|
|
243
|
+
Для встраивания объектов SEAF.ArchTool в представления используйте специальный VUE компонент "dochub-object":
|
|
244
|
+
|
|
245
|
+
```
|
|
246
|
+
<dochub-object src="@document/archtool.example.swgr" />
|
|
247
|
+
```
|
|
248
|
+
|
|
249
|
+
Параметры для встраиваемого объекта передаются как GET параметры URL в поле "src". Например:
|
|
250
|
+
|
|
251
|
+
```
|
|
252
|
+
<dochub-object src="@entity/interactions/blank?id=archtool.user.research" />
|
|
253
|
+
```
|
|
254
|
+
|
|
255
|
+
В данном примере в представление плагина встраивается сущность "interactions" с использованием
|
|
256
|
+
презентации "blank" и параметром "id" со значением "archtool.user.research".
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# Copyright (C) 2022 owner Roman Piontik R.Piontik@mail.ru
|
|
2
|
+
#
|
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
# you may not use this file except in compliance with the License.
|
|
5
|
+
# You may obtain a copy of the License at
|
|
6
|
+
#
|
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
#
|
|
9
|
+
# In any derivative products, you must retain the information of
|
|
10
|
+
# owner of the original code and provide clear attribution to the project
|
|
11
|
+
#
|
|
12
|
+
# https://dochub.info
|
|
13
|
+
#
|
|
14
|
+
# The use of this product or its derivatives for any purpose cannot be a secret.
|
|
15
|
+
#
|
|
16
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
17
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
18
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
19
|
+
# See the License for the specific language governing permissions and
|
|
20
|
+
# limitations under the License.
|
|
21
|
+
#
|
|
22
|
+
# Maintainers:
|
|
23
|
+
# R.Piontik <r.piontik@mail.ru>
|
|
24
|
+
#
|
|
25
|
+
# Contributors:
|
|
26
|
+
# R.Piontik <r.piontik@mail.ru> - 2022
|
|
27
|
+
# R.Piontik <r.piontik@mail.ru> - 2023
|
|
28
|
+
# Александр Трубников <a.trubnikov@samolet.ru> - 2023
|
|
29
|
+
# ilya.ermolin <ilya.ermolin@rtlabs.ru> - 2024
|
|
30
|
+
# R.Piontik <r.piontik@mail.ru> - 2024
|
|
31
|
+
|
|
32
|
+
# Источник - https://gitlab.smoletgroup.ru/branch/blob/root.yaml
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
datasets:
|
|
36
|
+
archtool.plugins.example:
|
|
37
|
+
origin: archtool.components
|
|
38
|
+
source: ../docs/examples/test.jsonata
|
|
39
|
+
docs:
|
|
40
|
+
archtool.plugins.intro:
|
|
41
|
+
location: SEAF.ArchTool/Руководство/Плагины
|
|
42
|
+
type: markdown
|
|
43
|
+
source: introduction.md
|
|
44
|
+
archtool.plugins.interface:
|
|
45
|
+
location: SEAF.ArchTool/Руководство/Плагины/Интерфейсы ядра
|
|
46
|
+
type: markdown
|
|
47
|
+
source: interface.md
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
|