feat: aact v2 — CLI, auto-fix, Structurizr, новые правила

.github/workflows/main.yml

@@ -4,17 +4,18 @@ on:
   push:
     branches-ignore:
       - master
+      - main
 
 jobs:
   plantuml:
     name: plantuml
     runs-on: ubuntu-latest
     steps:
       - name: checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: install java
-        uses: actions/setup-java@v2
+        uses: actions/setup-java@v4
         with:
           java-version: "17"
           distribution: temurin
@@ -31,9 +32,9 @@ jobs:
         run: java -jar /opt/plantuml.jar -tsvg "./resources/architecture/*.puml"
 
       - name: push svg diagrams
-        uses: stefanzweifel/git-auto-commit-action@v4
+        uses: stefanzweifel/git-auto-commit-action@v5
         with:
           commit_message: "docs: render PlantUML files"
           file_pattern: ./resources/architecture/*.svg
           commit_user_name: github-actions[bot]
-          commit_user_email: 41898282+github-actions[bot]@users.noreply.github.com
+          commit_user_email: 41898282+github-actions[bot]@users.noreply.github.com

.github/workflows/test.yaml

@@ -9,15 +9,18 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [16.x]
+        node-version: [20.x, 22.x]
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
+      - uses: pnpm/action-setup@v4
       - name: Node.js
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
-      - run: npm install -g yarn    
-      - name: yarn install, build and test
-        run: | 
-          yarn 
-          yarn test
+          cache: pnpm
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+      - name: Lint
+        run: pnpm lint
+      - name: Test
+        run: pnpm test

.gitignore

@@ -70,9 +70,6 @@ web_modules/
 # Optional npm cache directory
 .npm
 
-# npmrc config
-.npmrc
-
 # Optional eslint cache
 .eslintcache
 
@@ -88,9 +85,6 @@ web_modules/
 # Output of 'npm pack'
 *.tgz
 
-# Yarn Integrity file
-.yarn-integrity
-
 # dotenv environment variables file
 .env
 .env.test
@@ -131,13 +125,6 @@ dist
 # Stores VSCode versions used for testing VSCode extensions
 .vscode-test
 
-# yarn v2
-.yarn/cache
-.yarn/unplugged
-.yarn/build-state.yml
-.yarn/install-state.gz
-.pnp.*
-
 ### https://github.com/github/gitignore/blob/master/Global/Linux.gitignore
 
 *~
@@ -215,4 +202,5 @@ package-lock.json
 **/.vs/*
 **/bin/*
 **/obj/*
-**/nppBackup/*
+**/nppBackup/*
+.claude/

.husky/commit-msg

@@ -1,4 +1 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
-yarn commitlint --edit "$1"
+pnpm commitlint --edit "$1"

.husky/pre-commit

@@ -1,4 +1 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
-yarn lint-staged
+pnpm lint-staged

.markdownlintignore

@@ -0,0 +1,7 @@
+node_modules/
+dist/
+ADRs/
+ModularMonolith/
+patterns.md
+roadmap.md
+README.md

.npmrc

@@ -0,0 +1,2 @@
+public-hoist-pattern[]=@commitlint*
+public-hoist-pattern[]=commitlint*

.prettierrc.yaml

@@ -1,2 +1 @@
-trailingComma: all
 endOfLine: auto

ADRs/ADR template.md

@@ -1,14 +1,27 @@
 # <Название>
+
 ## Контекст
+
 <описание контекста, в рамках которого применяется решение>
+
 ## Краткое описание решения и его обоснование
+
 ### Схема
+
 <архитектурная схема решения>
+
 ### Решение
+
 <описание решения>
+
 ### Обоснование
+
 <обоснование решения>
+
 ## Как покрыть тестами
+
 <описание механизма тестирования>
+
 ### Примеры тестов
+
 <ссылки на тесты>

ADRs/Anti-corruption Layer.md

@@ -5,7 +5,9 @@
 Микросервисная архитектура с выделенным периметром продукта, имеющим ряд интеграций с внешними системами (другими системами предприятия и/или внешними решениями)
 
 ## Краткое описание решения и его обоснование
+
 ### Схема
+
 ![image](https://github.com/Byndyusoft/aact/assets/1096954/970dcf43-d347-4294-9be0-03f042b85f8b)
 
 ### Решение
@@ -19,11 +21,14 @@
 ## Как покрыть тестами
 
 1. Помечаем на архитектуре соответствующие микросервисы признаком "Adapter"
+
 ```
 Container(goods_adapter, “Goods ACL", "NestJS", $tags="adapter")
 ```
+
 2. Проверяем, что связи с внешними системами имеют только сервисы с таким признаком
 
 ### Примеры тестов
 
-[only acl can depence from external systems](https://github.com/Byndyusoft/aact/blob/721edde3767dc0e51d19c80c3b6adba9fbf7b007/test/architecture.test.ts#L111C7-L111C49)
+- [unit-тест правила ACL](../test/rules/acl.test.ts)
+- [пример на banking-plantuml](../examples/banking-plantuml/rules.test.ts) — `ACL — only acl-tagged containers depend on externals`

ADRs/Common Reuse Principle.md

@@ -0,0 +1,51 @@
+# Common Reuse Principle
+
+## Контекст
+
+Микросервисная архитектура с несколькими ограниченными контекстами (bounded contexts), микросервисы которых взаимодействуют между контекстами через API.
+
+## Краткое описание решения и его обоснование
+
+### Схема
+
+#### Без нарушений
+
+| Все публичные используются (C и D)                                                                      | D приватный — нарушения нет                                                                             |
+| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
+| <img src="https://github.com/user-attachments/assets/c8b44494-5ce1-4f23-a7c4-840c72fbdfad" width="300"> | <img src="https://github.com/user-attachments/assets/4322cff5-43af-4739-a2f5-27f7bd2a15e4" width="300"> |
+
+Три контекста. Z использует только C, но D приватный — нарушения нет:
+
+<img src="https://github.com/user-attachments/assets/6b8dd2cb-31a1-4aa9-8eea-6cc082d217d6" width="500">
+
+#### С нарушениями
+
+| Контекст 3 использует D, но не C                                                                        | Контекст 1 использует C, но не D                                                                        |
+| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
+| <img src="https://github.com/user-attachments/assets/1ac522ab-d1fd-4ee0-be41-b96e01d87c09" width="400"> | <img src="https://github.com/user-attachments/assets/1f323601-9d3a-4949-b217-e48ebe515776" width="400"> |
+
+### Решение
+
+Если контекст зависит хотя бы от одного публичного микросервиса другого контекста — он должен использовать все публичные микросервисы этого контекста.
+
+Публичный микросервис — тот, чей API вызывается извне контекста. Приватный — используется только внутри, при проверке не учитывается.
+
+### Обоснование
+
+Адаптация принципа Common Reuse (Роберт Мартин) к микросервисам. Частичное использование публичного API контекста — сигнал, что граница проведена неудачно или зависимость лишняя. На уровне инфраструктуры рекомендуется ограничивать сетевой доступ извне контекста только до публичных микросервисов.
+
+## Как покрыть тестами
+
+1. Определяем публичные микросервисы каждого контекста — те, у которых есть входящие связи от микросервисов из других контекстов
+
+2. Для каждой пары контекстов (потребитель → поставщик): если потребитель использует хотя бы один публичный микросервис поставщика — проверяем, что использует все
+
+```
+Контекст 2: публичные [C, D]
+Контекст 1 → использует C, D — ✅ все публичные
+Контекст 3 → использует D    — ❎ не использует C
+```
+
+### Примеры тестов
+
+- [unit-тест правила Common Reuse](../test/rules/commonReuse.test.ts)

ADRs/Database per CRUD-service.md

@@ -5,7 +5,9 @@
 Микросервисная архитектура с выделенными [мастер-системами](https://byndyusoft.com/blogs/masterdata), данные каждой из которых хранятся в отдельной БД
 
 ## Краткое описание решения и его обоснование
+
 ### Схема
+
 ![image](https://github.com/Byndyusoft/aact/assets/1096954/70b0a5e2-e78c-41c3-bd3c-7d12303ca31a)
 
 ### Решение
@@ -20,21 +22,28 @@
 ## Как покрыть тестами
 
 1. Помечаем на архитектуре соответствующие микросервисы признаком "CRUD" (или Repository)
+
 ```
 Container(task_repository, “Task Repository", "NestJS", $tags="crud")
 ```
+
 2. Проверяем, что у таких сервисов нет исходящих связей, кроме единственной БД
+
 ```
 Rel(task_repository, task_db, "") — ✅ т.к. исходящая связь в БД
 Rel(camunda, task_repository, "") — ✅ т.к. входящая связь
 Rel(task_repository, invoice_acl, "") — ❎ т.к. исходящая связь не в БД
 ```
+
 3. Проверяем, что у БД нет никаких связей помимо единственной с crud-микросервисом
+
 ```
 Rel(task_repository, task_db, "") — ✅ т.к. микросервис task_repository помечен тэгом "crud"
 Rel(invoice_acl, task_db, "") — ❎ т.к. микросервис invoice_acl непомечен тэгом "crud"
 Rel(invoice_repository, task_db, "") — ❎ т.к. выше уже есть одна связь у данной БД, хоть и invoice_repository помечен тэгом "crud"
 ```
 
 ### Примеры тестов
-TBD
+
+- [unit-тест правила CRUD](../test/rules/crud.test.ts)
+- [пример на banking-plantuml](../examples/banking-plantuml/rules.test.ts) — `CRUD — only repo-tagged containers access databases`