@shortlink-org/portolan 0.1.0
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 +21 -0
- package/README.md +387 -0
- package/catalog/enum_test.go +46 -0
- package/catalog/model.go +932 -0
- package/catalog/roundtrip_test.go +185 -0
- package/catalog/via_test.go +38 -0
- package/cli/portolan.mjs +368 -0
- package/go.mod +14 -0
- package/go.sum +14 -0
- package/index.html +13 -0
- package/internal/commands/cargo.go +154 -0
- package/internal/commands/commands.go +143 -0
- package/internal/commands/commands_test.go +323 -0
- package/internal/commands/gradle.go +77 -0
- package/internal/commands/justfile.go +82 -0
- package/internal/commands/makefile.go +106 -0
- package/internal/commands/maven.go +93 -0
- package/internal/commands/packagejson.go +159 -0
- package/internal/commands/pyproject.go +169 -0
- package/internal/commands/taskfile.go +101 -0
- package/internal/commands/testdata/estate/.cargo/config.toml +7 -0
- package/internal/commands/testdata/estate/Makefile +33 -0
- package/internal/commands/testdata/estate/Taskfile.yml +21 -0
- package/internal/commands/testdata/estate/build.gradle.kts +21 -0
- package/internal/commands/testdata/estate/justfile +20 -0
- package/internal/commands/testdata/estate/package.json +13 -0
- package/internal/commands/testdata/estate/pom.xml +29 -0
- package/internal/commands/testdata/estate/pyproject.toml +27 -0
- package/internal/commands/testdata/estate/xtask/src/main.rs +27 -0
- package/internal/commands/testdata/golden/commands.json +305 -0
- package/internal/gohttp/analyze.go +2500 -0
- package/internal/gohttp/endpoints.go +1067 -0
- package/internal/gohttp/roots.go +320 -0
- package/internal/gohttp/typed.go +143 -0
- package/internal/goscan/constants.go +85 -0
- package/internal/goscan/goscan_test.go +227 -0
- package/internal/goscan/names.go +52 -0
- package/internal/goscan/parse_test.go +11 -0
- package/internal/goscan/source.go +36 -0
- package/internal/goscan/tree.go +155 -0
- package/internal/goscan/types.go +99 -0
- package/internal/wsdl/ids.go +127 -0
- package/internal/wsdl/ids_test.go +21 -0
- package/internal/wsdl/model.go +62 -0
- package/internal/wsdl/parse.go +920 -0
- package/internal/wsdl/parse_test.go +133 -0
- package/package.json +117 -0
- package/plugin/describe.go +107 -0
- package/plugin/describe_test.go +114 -0
- package/plugin/protocol.go +117 -0
- package/plugin/schematest/schematest.go +126 -0
- package/plugins/README.md +1160 -0
- package/plugins/extract-adr/describe.go +19 -0
- package/plugins/extract-adr/describe_test.go +11 -0
- package/plugins/extract-adr/extract.go +153 -0
- package/plugins/extract-adr/extract_test.go +350 -0
- package/plugins/extract-adr/history.go +99 -0
- package/plugins/extract-adr/main.go +65 -0
- package/plugins/extract-adr/options.schema.json +26 -0
- package/plugins/extract-adr/parse.go +642 -0
- package/plugins/extract-adr/parse_test.go +405 -0
- package/plugins/extract-asyncapi/describe.go +19 -0
- package/plugins/extract-asyncapi/describe_test.go +11 -0
- package/plugins/extract-asyncapi/extract.go +315 -0
- package/plugins/extract-asyncapi/extract_test.go +197 -0
- package/plugins/extract-asyncapi/main.go +48 -0
- package/plugins/extract-asyncapi/options.schema.json +26 -0
- package/plugins/extract-asyncapi/spec.go +151 -0
- package/plugins/extract-celery/README.md +169 -0
- package/plugins/extract-celery/extract.py +346 -0
- package/plugins/extract-celery/extract_test.py +192 -0
- package/plugins/extract-celery/main.py +66 -0
- package/plugins/extract-celery/options.py +31 -0
- package/plugins/extract-celery/options.schema.json +31 -0
- package/plugins/extract-celery/producers.py +156 -0
- package/plugins/extract-celery/routes_test.py +106 -0
- package/plugins/extract-commands/describe.go +19 -0
- package/plugins/extract-commands/describe_test.go +11 -0
- package/plugins/extract-commands/extract.go +79 -0
- package/plugins/extract-commands/extract_test.go +92 -0
- package/plugins/extract-commands/main.go +55 -0
- package/plugins/extract-commands/options.schema.json +20 -0
- package/plugins/extract-csr/avro.go +258 -0
- package/plugins/extract-csr/describe.go +19 -0
- package/plugins/extract-csr/describe_test.go +11 -0
- package/plugins/extract-csr/extract.go +338 -0
- package/plugins/extract-csr/extract_test.go +374 -0
- package/plugins/extract-csr/jsonschema.go +343 -0
- package/plugins/extract-csr/lock.go +25 -0
- package/plugins/extract-csr/main.go +84 -0
- package/plugins/extract-csr/options.schema.json +43 -0
- package/plugins/extract-csr/subject.go +102 -0
- package/plugins/extract-django/README.md +386 -0
- package/plugins/extract-django/apps.py +100 -0
- package/plugins/extract-django/auth.py +302 -0
- package/plugins/extract-django/auth_test.py +188 -0
- package/plugins/extract-django/clients.py +121 -0
- package/plugins/extract-django/contracts.py +458 -0
- package/plugins/extract-django/database.py +119 -0
- package/plugins/extract-django/domain.py +318 -0
- package/plugins/extract-django/events.py +86 -0
- package/plugins/extract-django/extract.py +601 -0
- package/plugins/extract-django/extract_test.py +397 -0
- package/plugins/extract-django/flows.py +1278 -0
- package/plugins/extract-django/flows_test.py +338 -0
- package/plugins/extract-django/ids.py +42 -0
- package/plugins/extract-django/ids_test.py +30 -0
- package/plugins/extract-django/lifecycle.py +222 -0
- package/plugins/extract-django/lifecycle_test.py +76 -0
- package/plugins/extract-django/main.py +66 -0
- package/plugins/extract-django/openapi.py +229 -0
- package/plugins/extract-django/openapi_test.py +60 -0
- package/plugins/extract-django/operations.py +96 -0
- package/plugins/extract-django/options.py +61 -0
- package/plugins/extract-django/options.schema.json +126 -0
- package/plugins/extract-django/routing.py +214 -0
- package/plugins/extract-django/routing_test.py +198 -0
- package/plugins/extract-django/serializers.py +558 -0
- package/plugins/extract-django/store.py +434 -0
- package/plugins/extract-django/transport.py +242 -0
- package/plugins/extract-flows/describe.go +19 -0
- package/plugins/extract-flows/describe_test.go +11 -0
- package/plugins/extract-flows/extract.go +91 -0
- package/plugins/extract-flows/main.go +45 -0
- package/plugins/extract-flows/options.schema.json +16 -0
- package/plugins/extract-flows/parse.go +593 -0
- package/plugins/extract-flows/parse_test.go +204 -0
- package/plugins/extract-glossary/describe.go +19 -0
- package/plugins/extract-glossary/describe_test.go +11 -0
- package/plugins/extract-glossary/extract.go +115 -0
- package/plugins/extract-glossary/extract_test.go +220 -0
- package/plugins/extract-glossary/main.go +59 -0
- package/plugins/extract-glossary/options.schema.json +21 -0
- package/plugins/extract-glossary/parse.go +214 -0
- package/plugins/extract-glossary/parse_test.go +203 -0
- package/plugins/extract-go/aggregate.go +214 -0
- package/plugins/extract-go/client.go +409 -0
- package/plugins/extract-go/client_test.go +266 -0
- package/plugins/extract-go/describe.go +19 -0
- package/plugins/extract-go/describe_test.go +11 -0
- package/plugins/extract-go/enum.go +195 -0
- package/plugins/extract-go/enum_test.go +82 -0
- package/plugins/extract-go/event.go +99 -0
- package/plugins/extract-go/extract.go +191 -0
- package/plugins/extract-go/extract_test.go +261 -0
- package/plugins/extract-go/flow.go +1441 -0
- package/plugins/extract-go/flow_test.go +609 -0
- package/plugins/extract-go/httpclient.go +174 -0
- package/plugins/extract-go/httpclient_test.go +296 -0
- package/plugins/extract-go/ids.go +92 -0
- package/plugins/extract-go/layout.go +225 -0
- package/plugins/extract-go/layout_test.go +125 -0
- package/plugins/extract-go/lifecycle.go +324 -0
- package/plugins/extract-go/lifecycle_test.go +108 -0
- package/plugins/extract-go/main.go +79 -0
- package/plugins/extract-go/operation.go +157 -0
- package/plugins/extract-go/options.schema.json +66 -0
- package/plugins/extract-go/source.go +316 -0
- package/plugins/extract-go/transport.go +321 -0
- package/plugins/extract-go/transport_test.go +145 -0
- package/plugins/extract-go/wiring.go +434 -0
- package/plugins/extract-go-nats/describe.go +19 -0
- package/plugins/extract-go-nats/describe_test.go +11 -0
- package/plugins/extract-go-nats/extract.go +177 -0
- package/plugins/extract-go-nats/extract_test.go +389 -0
- package/plugins/extract-go-nats/index.go +379 -0
- package/plugins/extract-go-nats/main.go +42 -0
- package/plugins/extract-go-nats/options.schema.json +21 -0
- package/plugins/extract-go-nats/resolve.go +161 -0
- package/plugins/extract-go-nats/sites.go +224 -0
- package/plugins/extract-graphql/describe.go +19 -0
- package/plugins/extract-graphql/describe_test.go +11 -0
- package/plugins/extract-graphql/extract.go +433 -0
- package/plugins/extract-graphql/extract_test.go +256 -0
- package/plugins/extract-graphql/ids.go +49 -0
- package/plugins/extract-graphql/lex.go +237 -0
- package/plugins/extract-graphql/main.go +51 -0
- package/plugins/extract-graphql/options.schema.json +31 -0
- package/plugins/extract-graphql/parse.go +621 -0
- package/plugins/extract-graphql/parse_test.go +122 -0
- package/plugins/extract-http-clients/describe.go +19 -0
- package/plugins/extract-http-clients/describe_test.go +11 -0
- package/plugins/extract-http-clients/extract.go +705 -0
- package/plugins/extract-http-clients/extract_test.go +1263 -0
- package/plugins/extract-http-clients/main.go +42 -0
- package/plugins/extract-http-clients/options.schema.json +33 -0
- package/plugins/extract-java/README.md +190 -0
- package/plugins/extract-java/build/org/portolan/extract/Catalog.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Clients$1.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Clients$2.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Clients$Call.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Clients$Client.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Clients$Route.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Clients.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Domain$Aggregate.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Domain.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Events$Found.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Events.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Extract.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Flows$1.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Flows$Binding.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Flows$Draft.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Flows$Frame.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Flows$Options.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Flows.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Ids.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Json$Reader.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Json.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Lifecycle$1.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Lifecycle$Move.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Lifecycle.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Main.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/OpenApi$Operation.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/OpenApi$Spec.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/OpenApi.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Operations$1.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Operations$UseCase.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Operations.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Proto$Rpc.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Proto$Service.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Proto.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Protocol$Builder.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Protocol$Input.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Protocol$Options.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Protocol.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Source$Project.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Source$Unit.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Source.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Transport$Endpoint.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Transport.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Yaml$Line.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Yaml$Reader.class +0 -0
- package/plugins/extract-java/build/org/portolan/extract/Yaml.class +0 -0
- package/plugins/extract-java/options.schema.json +70 -0
- package/plugins/extract-openapi/describe.go +19 -0
- package/plugins/extract-openapi/describe_test.go +11 -0
- package/plugins/extract-openapi/discover.go +243 -0
- package/plugins/extract-openapi/extract.go +526 -0
- package/plugins/extract-openapi/extract_test.go +545 -0
- package/plugins/extract-openapi/main.go +75 -0
- package/plugins/extract-openapi/options.schema.json +62 -0
- package/plugins/extract-openapi/spec.go +350 -0
- package/plugins/extract-project/README.md +22 -0
- package/plugins/extract-project/describe.go +19 -0
- package/plugins/extract-project/describe_test.go +11 -0
- package/plugins/extract-project/extract.go +221 -0
- package/plugins/extract-project/extract_test.go +109 -0
- package/plugins/extract-project/main.go +41 -0
- package/plugins/extract-project/options.schema.json +48 -0
- package/plugins/extract-proto/ast.go +125 -0
- package/plugins/extract-proto/consumes.go +77 -0
- package/plugins/extract-proto/describe.go +19 -0
- package/plugins/extract-proto/extract.go +293 -0
- package/plugins/extract-proto/extract_test.go +459 -0
- package/plugins/extract-proto/ids.go +89 -0
- package/plugins/extract-proto/ids_test.go +57 -0
- package/plugins/extract-proto/lex.go +285 -0
- package/plugins/extract-proto/main.go +100 -0
- package/plugins/extract-proto/module.go +120 -0
- package/plugins/extract-proto/options.schema.json +51 -0
- package/plugins/extract-proto/parse.go +720 -0
- package/plugins/extract-proto/parse_test.go +307 -0
- package/plugins/extract-proto/provides.go +236 -0
- package/plugins/extract-proto/resolve.go +222 -0
- package/plugins/extract-proto/resolve_test.go +119 -0
- package/plugins/extract-python-kafka/README.md +36 -0
- package/plugins/extract-python-kafka/extract.py +211 -0
- package/plugins/extract-python-kafka/extract_test.py +68 -0
- package/plugins/extract-python-kafka/main.py +59 -0
- package/plugins/extract-python-kafka/options.py +29 -0
- package/plugins/extract-python-kafka/options.schema.json +31 -0
- package/plugins/extract-redis/README.md +11 -0
- package/plugins/extract-redis/describe.go +19 -0
- package/plugins/extract-redis/describe_test.go +11 -0
- package/plugins/extract-redis/extract.go +183 -0
- package/plugins/extract-redis/extract_test.go +168 -0
- package/plugins/extract-redis/keyspaces.go +469 -0
- package/plugins/extract-redis/main.go +44 -0
- package/plugins/extract-redis/options.schema.json +30 -0
- package/plugins/extract-river/describe.go +19 -0
- package/plugins/extract-river/describe_test.go +11 -0
- package/plugins/extract-river/extract.go +507 -0
- package/plugins/extract-river/extract_test.go +132 -0
- package/plugins/extract-river/main.go +42 -0
- package/plugins/extract-river/options.schema.json +21 -0
- package/plugins/extract-rust/Cargo.lock +133 -0
- package/plugins/extract-rust/Cargo.toml +23 -0
- package/plugins/extract-rust/README.md +204 -0
- package/plugins/extract-rust/options.schema.json +65 -0
- package/plugins/extract-rust/rustfmt.toml +1 -0
- package/plugins/extract-sql/ddl.go +893 -0
- package/plugins/extract-sql/ddl_test.go +401 -0
- package/plugins/extract-sql/describe.go +19 -0
- package/plugins/extract-sql/describe_test.go +11 -0
- package/plugins/extract-sql/layout.go +221 -0
- package/plugins/extract-sql/layout_test.go +55 -0
- package/plugins/extract-sql/lineage.go +107 -0
- package/plugins/extract-sql/main.go +141 -0
- package/plugins/extract-sql/maps.go +564 -0
- package/plugins/extract-sql/maps_java.go +117 -0
- package/plugins/extract-sql/maps_rust.go +333 -0
- package/plugins/extract-sql/maps_rust_test.go +70 -0
- package/plugins/extract-sql/maps_test.go +204 -0
- package/plugins/extract-sql/maps_ts.go +398 -0
- package/plugins/extract-sql/maps_ts_test.go +136 -0
- package/plugins/extract-sql/options.schema.json +53 -0
- package/plugins/extract-sql/projection.go +70 -0
- package/plugins/extract-sql/projection_test.go +50 -0
- package/plugins/extract-sql/store.go +420 -0
- package/plugins/extract-sql/store_test.go +233 -0
- package/plugins/extract-sql/view.go +295 -0
- package/plugins/extract-ts/README.md +306 -0
- package/plugins/extract-ts/ast.test.ts +178 -0
- package/plugins/extract-ts/ast.ts +648 -0
- package/plugins/extract-ts/clients.ts +185 -0
- package/plugins/extract-ts/domain.ts +164 -0
- package/plugins/extract-ts/extract.test.ts +208 -0
- package/plugins/extract-ts/extract.ts +200 -0
- package/plugins/extract-ts/flows.ts +783 -0
- package/plugins/extract-ts/graphql.test.ts +73 -0
- package/plugins/extract-ts/graphql.ts +181 -0
- package/plugins/extract-ts/ids.test.ts +21 -0
- package/plugins/extract-ts/ids.ts +52 -0
- package/plugins/extract-ts/lifecycle.ts +138 -0
- package/plugins/extract-ts/main.ts +48 -0
- package/plugins/extract-ts/openapi.test.ts +64 -0
- package/plugins/extract-ts/openapi.ts +99 -0
- package/plugins/extract-ts/operations.ts +93 -0
- package/plugins/extract-ts/options.schema.json +96 -0
- package/plugins/extract-ts/source.test.ts +174 -0
- package/plugins/extract-ts/source.ts +465 -0
- package/plugins/extract-ts/transport.ts +147 -0
- package/plugins/extract-ts/tsconfig.json +13 -0
- package/plugins/extract-ts/wiring.ts +190 -0
- package/plugins/extract-watermill/describe.go +19 -0
- package/plugins/extract-watermill/describe_test.go +11 -0
- package/plugins/extract-watermill/extract.go +1228 -0
- package/plugins/extract-watermill/extract_test.go +234 -0
- package/plugins/extract-watermill/main.go +41 -0
- package/plugins/extract-watermill/options.schema.json +21 -0
- package/plugins/extract-wsdl/describe.go +19 -0
- package/plugins/extract-wsdl/describe_test.go +11 -0
- package/plugins/extract-wsdl/extract.go +148 -0
- package/plugins/extract-wsdl/extract_test.go +45 -0
- package/plugins/extract-wsdl/main.go +53 -0
- package/plugins/extract-wsdl/options.schema.json +59 -0
- package/plugins/fetch-bsr/auth.go +114 -0
- package/plugins/fetch-bsr/bsr.go +240 -0
- package/plugins/fetch-bsr/cache.go +66 -0
- package/plugins/fetch-bsr/describe.go +19 -0
- package/plugins/fetch-bsr/fetch.go +192 -0
- package/plugins/fetch-bsr/fetch_test.go +465 -0
- package/plugins/fetch-bsr/lock.go +71 -0
- package/plugins/fetch-bsr/main.go +117 -0
- package/plugins/fetch-bsr/options.schema.json +42 -0
- package/plugins/fetch-csr/auth.go +95 -0
- package/plugins/fetch-csr/cache.go +69 -0
- package/plugins/fetch-csr/describe.go +19 -0
- package/plugins/fetch-csr/describe_test.go +11 -0
- package/plugins/fetch-csr/fetch.go +254 -0
- package/plugins/fetch-csr/fetch_test.go +494 -0
- package/plugins/fetch-csr/lock.go +95 -0
- package/plugins/fetch-csr/main.go +122 -0
- package/plugins/fetch-csr/options.schema.json +42 -0
- package/plugins/fetch-csr/registry.go +209 -0
- package/plugins/fetch-git/cache.go +65 -0
- package/plugins/fetch-git/describe.go +19 -0
- package/plugins/fetch-git/describe_test.go +11 -0
- package/plugins/fetch-git/fetch.go +181 -0
- package/plugins/fetch-git/fetch_test.go +332 -0
- package/plugins/fetch-git/git.go +169 -0
- package/plugins/fetch-git/lock.go +72 -0
- package/plugins/fetch-git/main.go +127 -0
- package/plugins/fetch-git/offline.go +39 -0
- package/plugins/fetch-git/options.schema.json +42 -0
- package/plugins/fetch-git/pin.go +90 -0
- package/plugins/fetch-git/pin_test.go +74 -0
- package/plugins/gen-backstage/describe.go +17 -0
- package/plugins/gen-backstage/main.go +22 -0
- package/plugins/gen-backstage/options.schema.json +30 -0
- package/plugins/gen-backstage/plugin.go +473 -0
- package/plugins/gen-backstage/plugin_test.go +145 -0
- package/plugins/gen-backstage.wasm +0 -0
- package/plugins/gen-markdown/adr.go +162 -0
- package/plugins/gen-markdown/aggregate.go +362 -0
- package/plugins/gen-markdown/canonical.go +93 -0
- package/plugins/gen-markdown/context.go +90 -0
- package/plugins/gen-markdown/coverage_test.go +89 -0
- package/plugins/gen-markdown/describe.go +19 -0
- package/plugins/gen-markdown/describe_test.go +11 -0
- package/plugins/gen-markdown/external.go +71 -0
- package/plugins/gen-markdown/flow.go +277 -0
- package/plugins/gen-markdown/glossary.go +76 -0
- package/plugins/gen-markdown/glossary_test.go +148 -0
- package/plugins/gen-markdown/llms.go +302 -0
- package/plugins/gen-markdown/main.go +22 -0
- package/plugins/gen-markdown/markdown.go +254 -0
- package/plugins/gen-markdown/markdown_test.go +100 -0
- package/plugins/gen-markdown/module.go +107 -0
- package/plugins/gen-markdown/options.schema.json +16 -0
- package/plugins/gen-markdown/plugin.go +39 -0
- package/plugins/gen-markdown/quality_test.go +176 -0
- package/plugins/gen-markdown/redis_test.go +38 -0
- package/plugins/gen-markdown/render.go +344 -0
- package/plugins/gen-markdown/render_test.go +186 -0
- package/plugins/gen-markdown/service.go +456 -0
- package/plugins/gen-markdown/source.go +177 -0
- package/plugins/gen-markdown/store.go +201 -0
- package/plugins/gen-markdown.wasm +0 -0
- package/plugins/gen-mermaid/describe.go +17 -0
- package/plugins/gen-mermaid/main.go +22 -0
- package/plugins/gen-mermaid/options.schema.json +10 -0
- package/plugins/gen-mermaid/plugin.go +104 -0
- package/plugins/gen-mermaid/plugin_test.go +33 -0
- package/plugins/gen-mermaid.wasm +0 -0
- package/plugins/openapi/ids.go +261 -0
- package/plugins/openapi/ids_test.go +98 -0
- package/plugins/pyplugin/catalog.py +209 -0
- package/plugins/pyplugin/celery_conf.py +436 -0
- package/plugins/pyplugin/celery_tasks.py +76 -0
- package/plugins/pyplugin/kafka.py +570 -0
- package/plugins/pyplugin/names.py +38 -0
- package/plugins/pyplugin/protocol.py +79 -0
- package/plugins/pyplugin/source.py +285 -0
- package/plugins/verify-codeowners/describe.go +19 -0
- package/plugins/verify-codeowners/describe_test.go +11 -0
- package/plugins/verify-codeowners/main.go +75 -0
- package/plugins/verify-codeowners/match.go +85 -0
- package/plugins/verify-codeowners/match_test.go +47 -0
- package/plugins/verify-codeowners/options.schema.json +15 -0
- package/plugins/verify-codeowners/owners.go +164 -0
- package/plugins/verify-codeowners/owners_test.go +225 -0
- package/plugins/verify-codeowners/parse.go +90 -0
- package/plugins/verify-codeowners/parse_test.go +62 -0
- package/plugins/verify-otel/describe.go +19 -0
- package/plugins/verify-otel/describe_test.go +11 -0
- package/plugins/verify-otel/main.go +53 -0
- package/plugins/verify-otel/match.go +336 -0
- package/plugins/verify-otel/options.schema.json +30 -0
- package/plugins/verify-otel/otlp.go +200 -0
- package/plugins/verify-otel/verify.go +734 -0
- package/plugins/verify-otel/verify_test.go +460 -0
- package/portolan.json +1073 -0
- package/public/favicon.svg +12 -0
- package/schema/portolan.schema.json +2558 -0
- package/scripts/README.md +53 -0
- package/scripts/build-report.mjs +60 -0
- package/scripts/build-report.test.mjs +44 -0
- package/scripts/builtin-plugins.mjs +49 -0
- package/scripts/catalog-sources.mjs +67 -0
- package/scripts/diff.mjs +315 -0
- package/scripts/diff.test.mjs +151 -0
- package/scripts/forge-comment.mjs +144 -0
- package/scripts/forge-comment.test.mjs +151 -0
- package/scripts/forge-release.mjs +138 -0
- package/scripts/forge-release.test.mjs +106 -0
- package/scripts/forge.mjs +61 -0
- package/scripts/gen-likec4.mjs +854 -0
- package/scripts/gen-likec4.test.mjs +258 -0
- package/scripts/gen.mjs +603 -0
- package/scripts/generated-docs.test.mjs +66 -0
- package/scripts/local-api.mjs +1192 -0
- package/scripts/local-api.test.mjs +387 -0
- package/scripts/manifest.mjs +214 -0
- package/scripts/manifest.test.mjs +148 -0
- package/scripts/output-path.mjs +79 -0
- package/scripts/output-path.test.mjs +45 -0
- package/scripts/package-smoke.mjs +37 -0
- package/scripts/plugin-host.mjs +419 -0
- package/scripts/plugin-host.test.mjs +109 -0
- package/scripts/plugin-wasm-worker.mjs +34 -0
- package/scripts/run-builtin.mjs +81 -0
- package/scripts/schema.mjs +357 -0
- package/scripts/site-docs.mjs +295 -0
- package/scripts/site-docs.test.mjs +181 -0
- package/scripts/vendor-lock.mjs +58 -0
- package/scripts/vendor-lock.test.mjs +69 -0
- package/src/README.md +38 -0
- package/src/app/App.tsx +448 -0
- package/src/app/BranchPicker.test.ts +46 -0
- package/src/app/BranchPicker.tsx +153 -0
- package/src/app/Breadcrumbs.test.ts +38 -0
- package/src/app/Breadcrumbs.tsx +223 -0
- package/src/app/BuildStamp.tsx +146 -0
- package/src/app/CommandPalette.tsx +292 -0
- package/src/app/HashScroll.tsx +45 -0
- package/src/app/Sidebar.tsx +1742 -0
- package/src/app/TopBar.tsx +393 -0
- package/src/app/density.tsx +64 -0
- package/src/app/forge-access.test.ts +27 -0
- package/src/app/forge-access.tsx +80 -0
- package/src/app/panels.tsx +141 -0
- package/src/app/pins.tsx +242 -0
- package/src/app/query-client.ts +24 -0
- package/src/app/responsive.ts +55 -0
- package/src/app/shortcuts.test.ts +39 -0
- package/src/app/shortcuts.tsx +282 -0
- package/src/app/theme.tsx +51 -0
- package/src/app/title.test.ts +14 -0
- package/src/app/title.ts +30 -0
- package/src/app/toast.tsx +59 -0
- package/src/app/tree-keys.test.ts +80 -0
- package/src/app/tree-keys.ts +87 -0
- package/src/app/ui-store.ts +52 -0
- package/src/catalog-error.test.ts +105 -0
- package/src/catalog-profile.test.ts +59 -0
- package/src/catalog-profile.ts +101 -0
- package/src/catalog-stores.test.ts +431 -0
- package/src/catalog.test.ts +1215 -0
- package/src/catalog.ts +3125 -0
- package/src/chat/Cards.tsx +408 -0
- package/src/chat/ChatPanel.tsx +79 -0
- package/src/chat/ChatSettings.tsx +219 -0
- package/src/chat/Composer.tsx +99 -0
- package/src/chat/Conversation.tsx +281 -0
- package/src/chat/Header.tsx +46 -0
- package/src/chat/Message.tsx +49 -0
- package/src/chat/Notice.tsx +195 -0
- package/src/chat/Starter.tsx +67 -0
- package/src/chat/Steps.tsx +45 -0
- package/src/chat/Waiting.tsx +87 -0
- package/src/chat/flags.test.ts +59 -0
- package/src/chat/flags.ts +155 -0
- package/src/chat/linkify.test.ts +30 -0
- package/src/chat/linkify.ts +45 -0
- package/src/chat/prefs.ts +56 -0
- package/src/chat/prompt.test.ts +43 -0
- package/src/chat/prompt.ts +157 -0
- package/src/chat/store.ts +35 -0
- package/src/chat/tools.ts +58 -0
- package/src/chat/transport.ts +70 -0
- package/src/components/AdrRow.tsx +29 -0
- package/src/components/AnchorLink.tsx +67 -0
- package/src/components/ApiReference.tsx +134 -0
- package/src/components/AsyncApiReference.tsx +120 -0
- package/src/components/CatalogStamp.tsx +155 -0
- package/src/components/ChannelRows.tsx +132 -0
- package/src/components/CommandRows.tsx +139 -0
- package/src/components/DiagramSkeleton.tsx +71 -0
- package/src/components/EditorLink.tsx +85 -0
- package/src/components/FieldTree.tsx +305 -0
- package/src/components/FlowTrigger.tsx +34 -0
- package/src/components/Ident.tsx +89 -0
- package/src/components/Integrations.tsx +243 -0
- package/src/components/LifecycleDiagram.tsx +110 -0
- package/src/components/MachineDocs.tsx +42 -0
- package/src/components/Markdown.tsx +173 -0
- package/src/components/MarkdownTable.tsx +206 -0
- package/src/components/Mermaid.tsx +211 -0
- package/src/components/MethodRows.tsx +309 -0
- package/src/components/Overlay.tsx +125 -0
- package/src/components/PageHeader.tsx +189 -0
- package/src/components/RowActions.tsx +97 -0
- package/src/components/SchemaDocument.tsx +89 -0
- package/src/components/Select.tsx +126 -0
- package/src/components/ShapeRows.tsx +118 -0
- package/src/components/SourceDoc.tsx +82 -0
- package/src/components/SourcePreview.tsx +441 -0
- package/src/components/TabRow.tsx +182 -0
- package/src/components/TechIcon.tsx +34 -0
- package/src/components/Toc.tsx +132 -0
- package/src/components/WhatLinksHere.tsx +273 -0
- package/src/components/WsdlReference.tsx +84 -0
- package/src/components/ddd-icons.tsx +107 -0
- package/src/components/kind.tsx +157 -0
- package/src/components/logo.tsx +61 -0
- package/src/components/primitives.tsx +264 -0
- package/src/data.test.ts +18 -0
- package/src/data.ts +202 -0
- package/src/enrich.test.ts +1150 -0
- package/src/enrich.ts +672 -0
- package/src/er/ErCanvas.tsx +533 -0
- package/src/er/RedisSchema.tsx +74 -0
- package/src/er/RelationCard.tsx +267 -0
- package/src/er/StoreHeader.tsx +155 -0
- package/src/er/TableNode.tsx +84 -0
- package/src/er/ViewNode.tsx +83 -0
- package/src/er/layout.test.ts +115 -0
- package/src/er/layout.ts +77 -0
- package/src/er/lineage.test.ts +140 -0
- package/src/er/lineage.ts +107 -0
- package/src/er/markers.tsx +79 -0
- package/src/er/spec.test.ts +344 -0
- package/src/er/spec.ts +426 -0
- package/src/flow/ChainList.tsx +162 -0
- package/src/flow/FlowTable.tsx +123 -0
- package/src/flow/FlowToolbar.tsx +372 -0
- package/src/flow/StepDetail.tsx +380 -0
- package/src/flow/StepRail.tsx +428 -0
- package/src/flow/answers.test.ts +50 -0
- package/src/flow/answers.ts +58 -0
- package/src/flow/chain.test.ts +383 -0
- package/src/flow/chain.ts +353 -0
- package/src/flow/chapters.test.ts +185 -0
- package/src/flow/chapters.ts +225 -0
- package/src/flow/continues.test.ts +102 -0
- package/src/flow/continues.ts +65 -0
- package/src/flow/cross-context.test.ts +97 -0
- package/src/flow/cross-context.ts +35 -0
- package/src/flow/mermaid.test.ts +22 -0
- package/src/flow/mermaid.ts +141 -0
- package/src/flow/outline.test.ts +212 -0
- package/src/flow/outline.ts +170 -0
- package/src/flow/paths.test.ts +129 -0
- package/src/flow/paths.ts +147 -0
- package/src/flow/prefs.test.ts +80 -0
- package/src/flow/prefs.ts +104 -0
- package/src/graph/DependencyGraph.tsx +283 -0
- package/src/graph/DependencyNodes.tsx +162 -0
- package/src/graph/EdgeLabel.tsx +61 -0
- package/src/graph/FocusedEventGraph.tsx +211 -0
- package/src/graph/GraphToolbar.tsx +187 -0
- package/src/graph/RoutedEdge.tsx +80 -0
- package/src/graph/dependency-layout.test.ts +360 -0
- package/src/graph/dependency-layout.ts +444 -0
- package/src/graph/elk.test.ts +70 -0
- package/src/graph/elk.ts +287 -0
- package/src/graph/nodes.tsx +97 -0
- package/src/graph/theme.ts +81 -0
- package/src/graph/useElkFlow.ts +125 -0
- package/src/index.css +1547 -0
- package/src/language/InLanguage.tsx +40 -0
- package/src/language/TermCard.tsx +132 -0
- package/src/language/cards.test.ts +114 -0
- package/src/language/cards.ts +111 -0
- package/src/lib/admonition.test.ts +49 -0
- package/src/lib/admonition.ts +48 -0
- package/src/lib/adr.test.ts +131 -0
- package/src/lib/adr.ts +68 -0
- package/src/lib/api.test.ts +122 -0
- package/src/lib/api.ts +135 -0
- package/src/lib/backlinks.test.ts +330 -0
- package/src/lib/backlinks.ts +567 -0
- package/src/lib/branch-compare.ts +16 -0
- package/src/lib/build-info.test.ts +76 -0
- package/src/lib/build-info.ts +80 -0
- package/src/lib/catalog-diff.test.ts +275 -0
- package/src/lib/catalog-diff.ts +655 -0
- package/src/lib/clipboard.ts +43 -0
- package/src/lib/comparison-memory.test.ts +40 -0
- package/src/lib/comparison-memory.ts +39 -0
- package/src/lib/context-color.ts +27 -0
- package/src/lib/context-map.test.ts +148 -0
- package/src/lib/context-map.ts +399 -0
- package/src/lib/data-model.test.ts +245 -0
- package/src/lib/data-model.ts +399 -0
- package/src/lib/data-problems.test.ts +178 -0
- package/src/lib/data-problems.ts +314 -0
- package/src/lib/derive.test.ts +251 -0
- package/src/lib/derive.ts +515 -0
- package/src/lib/editor-link.test.ts +125 -0
- package/src/lib/editor-link.ts +96 -0
- package/src/lib/editor-prefs.ts +27 -0
- package/src/lib/event-graph.test.ts +237 -0
- package/src/lib/event-graph.ts +327 -0
- package/src/lib/export-canvas.ts +37 -0
- package/src/lib/export-file.test.ts +30 -0
- package/src/lib/export-file.ts +20 -0
- package/src/lib/flow-tree.test.ts +177 -0
- package/src/lib/flow-tree.ts +160 -0
- package/src/lib/forge-refs.test.ts +50 -0
- package/src/lib/forge-refs.ts +60 -0
- package/src/lib/format.test.ts +35 -0
- package/src/lib/format.ts +64 -0
- package/src/lib/github-catalog.test.ts +301 -0
- package/src/lib/github-catalog.ts +610 -0
- package/src/lib/integrations.test.ts +119 -0
- package/src/lib/integrations.ts +133 -0
- package/src/lib/kinds.test.ts +91 -0
- package/src/lib/kinds.ts +204 -0
- package/src/lib/lifecycle.test.ts +93 -0
- package/src/lib/lifecycle.ts +165 -0
- package/src/lib/local-api.ts +194 -0
- package/src/lib/motion-features.ts +11 -0
- package/src/lib/motion.test.ts +120 -0
- package/src/lib/motion.tsx +269 -0
- package/src/lib/palette-recent.test.ts +80 -0
- package/src/lib/palette-recent.ts +90 -0
- package/src/lib/palette.test.ts +365 -0
- package/src/lib/palette.ts +593 -0
- package/src/lib/pins.test.ts +139 -0
- package/src/lib/pins.ts +130 -0
- package/src/lib/problems.test.ts +112 -0
- package/src/lib/project-preview.ts +5 -0
- package/src/lib/proto-problems.test.ts +121 -0
- package/src/lib/proto-problems.ts +65 -0
- package/src/lib/queries.test.ts +113 -0
- package/src/lib/queries.ts +131 -0
- package/src/lib/registry.test.ts +219 -0
- package/src/lib/registry.ts +208 -0
- package/src/lib/scenarios.ts +547 -0
- package/src/lib/setup-info.test.ts +199 -0
- package/src/lib/setup-info.ts +415 -0
- package/src/lib/shape.test.ts +289 -0
- package/src/lib/shape.ts +454 -0
- package/src/lib/sidebar-prefs.test.ts +32 -0
- package/src/lib/sidebar-prefs.ts +75 -0
- package/src/lib/source-code.test.ts +159 -0
- package/src/lib/source-code.ts +286 -0
- package/src/lib/source-doc.test.ts +131 -0
- package/src/lib/source-doc.ts +103 -0
- package/src/lib/source-highlight.test.ts +29 -0
- package/src/lib/source-highlight.ts +24 -0
- package/src/lib/source-link.test.ts +153 -0
- package/src/lib/source-link.ts +201 -0
- package/src/lib/spec-files.test.ts +24 -0
- package/src/lib/spec-files.ts +23 -0
- package/src/lib/table-directive.test.ts +139 -0
- package/src/lib/table-directive.ts +106 -0
- package/src/lib/tech.test.ts +120 -0
- package/src/lib/tech.ts +421 -0
- package/src/lib/terms.test.ts +67 -0
- package/src/lib/terms.ts +179 -0
- package/src/lib/wire-problems.test.ts +263 -0
- package/src/lib/wire-problems.ts +281 -0
- package/src/likec4/C4View.tsx +55 -0
- package/src/likec4/CanvasBridge.tsx +187 -0
- package/src/likec4/FlowView.tsx +235 -0
- package/src/likec4/InteractiveView.tsx +144 -0
- package/src/likec4/canvas-viewport.test.ts +149 -0
- package/src/likec4/canvas-viewport.ts +135 -0
- package/src/likec4/flow-edges.test.ts +51 -0
- package/src/likec4/flow-edges.ts +89 -0
- package/src/likec4/frame-theme.test.ts +76 -0
- package/src/likec4/frame-theme.ts +101 -0
- package/src/likec4/highlight-css.test.ts +49 -0
- package/src/likec4/highlight-css.ts +52 -0
- package/src/likec4/ids.test.ts +151 -0
- package/src/likec4/ids.ts +115 -0
- package/src/likec4/levels.tsx +70 -0
- package/src/likec4/mapping.test.ts +66 -0
- package/src/likec4/mapping.ts +54 -0
- package/src/likec4/reserved.json +141 -0
- package/src/likec4/view-index.ts +78 -0
- package/src/main.tsx +13 -0
- package/src/map/ContextMapGraph.tsx +274 -0
- package/src/map/ContextNode.tsx +70 -0
- package/src/map/FloatingEdge.tsx +86 -0
- package/src/merge.test.ts +1038 -0
- package/src/merge.ts +1004 -0
- package/src/pages/AdrDetail.tsx +242 -0
- package/src/pages/AdrIndex.tsx +114 -0
- package/src/pages/AggregatePage.tsx +727 -0
- package/src/pages/BlockPage.tsx +478 -0
- package/src/pages/CatalogFailure.tsx +111 -0
- package/src/pages/Changes.tsx +313 -0
- package/src/pages/ContextMap.tsx +534 -0
- package/src/pages/ContextPage.tsx +346 -0
- package/src/pages/EnumPage.tsx +282 -0
- package/src/pages/EventPage.tsx +686 -0
- package/src/pages/ExternalPage.tsx +204 -0
- package/src/pages/FlowDetail.tsx +663 -0
- package/src/pages/FlowIndex.tsx +303 -0
- package/src/pages/GraphPage.tsx +217 -0
- package/src/pages/Language.tsx +257 -0
- package/src/pages/ModulePage.tsx +366 -0
- package/src/pages/NotFound.tsx +54 -0
- package/src/pages/Overview.tsx +344 -0
- package/src/pages/Problems.tsx +360 -0
- package/src/pages/RegistryIndex.tsx +118 -0
- package/src/pages/ServicePage.tsx +746 -0
- package/src/pages/Settings.tsx +975 -0
- package/src/pages/StorePage.tsx +114 -0
- package/src/peek/PeekCard.test.ts +35 -0
- package/src/peek/PeekCard.tsx +118 -0
- package/src/peek/PeekLayer.tsx +147 -0
- package/src/peek/model.test.ts +156 -0
- package/src/peek/model.ts +253 -0
- package/src/routes.test.ts +222 -0
- package/src/routes.ts +449 -0
- package/src/selection/DetailPanel.tsx +1407 -0
- package/src/selection/hash.test.ts +73 -0
- package/src/selection/hash.ts +58 -0
- package/src/selection/model.test.ts +199 -0
- package/src/selection/model.ts +473 -0
- package/src/selection/pages.test.ts +115 -0
- package/src/selection/pages.ts +268 -0
- package/src/selection/store.test.ts +62 -0
- package/src/selection/store.ts +46 -0
- package/src/selection/sync.tsx +99 -0
- package/src/table/ColumnsMenu.tsx +72 -0
- package/src/table/DataTable.tsx +780 -0
- package/src/table/Facets.tsx +54 -0
- package/src/table/GroupMenu.tsx +69 -0
- package/src/table/Toolbar.tsx +190 -0
- package/src/table/cells.tsx +117 -0
- package/src/table/compare.test.ts +117 -0
- package/src/table/compare.ts +196 -0
- package/src/table/export.test.ts +88 -0
- package/src/table/export.ts +66 -0
- package/src/table/facet-groups.test.ts +74 -0
- package/src/table/facet-groups.ts +56 -0
- package/src/table/grouping.test.ts +84 -0
- package/src/table/grouping.ts +82 -0
- package/src/table/infer.test.ts +57 -0
- package/src/table/infer.ts +50 -0
- package/src/table/persist.test.ts +76 -0
- package/src/table/persist.ts +112 -0
- package/src/table/sort-url.test.ts +75 -0
- package/src/table/sort-url.ts +52 -0
- package/src/table/types.ts +80 -0
- package/src/table/useTableState.ts +220 -0
- package/src/test-catalog.ts +7 -0
- package/src/testing/estate/data__catalog.json +2847 -0
- package/src/testing/estate/data__flows.json +1724 -0
- package/src/testing/estate/examples__auth__portolan__api.json +212 -0
- package/src/testing/estate/examples__auth__portolan__domain.json +1204 -0
- package/src/testing/estate/examples__auth__portolan__glossary.json +226 -0
- package/src/testing/estate/examples__auth__portolan__observed.json +757 -0
- package/src/testing/estate/examples__auth__portolan__stores.json +195 -0
- package/src/testing/estate/examples__shop__cart__portolan__api.json +234 -0
- package/src/testing/estate/examples__shop__cart__portolan__commands.json +86 -0
- package/src/testing/estate/examples__shop__cart__portolan__domain.json +966 -0
- package/src/testing/estate/examples__shop__cart__portolan__observed.json +498 -0
- package/src/testing/estate/examples__shop__cart__portolan__stores.json +208 -0
- package/src/testing/estate/examples__shop__oms__portolan__glossary.json +98 -0
- package/src/testing/estate/examples__shop__oms__portolan__proto.json +186 -0
- package/src/testing/estate.ts +49 -0
- package/src/trail/Trail.tsx +81 -0
- package/src/trail/model.test.ts +157 -0
- package/src/trail/model.ts +189 -0
- package/src/trail/record.tsx +32 -0
- package/src/trail/store.test.ts +66 -0
- package/src/trail/store.ts +102 -0
- package/tsconfig.json +35 -0
- package/vite.config.ts +171 -0
|
@@ -0,0 +1,162 @@
|
|
|
1
|
+
package main
|
|
2
|
+
|
|
3
|
+
import (
|
|
4
|
+
"strings"
|
|
5
|
+
|
|
6
|
+
"github.com/shortlink-org/portolan/catalog"
|
|
7
|
+
)
|
|
8
|
+
|
|
9
|
+
func (s *site) renderAdrs() {
|
|
10
|
+
if len(s.cat.Adrs) == 0 {
|
|
11
|
+
return
|
|
12
|
+
}
|
|
13
|
+
|
|
14
|
+
const self = "adr/README.md"
|
|
15
|
+
|
|
16
|
+
var b strings.Builder
|
|
17
|
+
b.WriteString("# Decision records\n\n")
|
|
18
|
+
b.WriteString(s.stamp() + "\n")
|
|
19
|
+
|
|
20
|
+
rows := make([][]string, 0, len(s.cat.Adrs))
|
|
21
|
+
for i := range s.cat.Adrs {
|
|
22
|
+
adr := &s.cat.Adrs[i]
|
|
23
|
+
rows = append(rows, []string{
|
|
24
|
+
s.ref(self, adr.ID, adr.ID),
|
|
25
|
+
adr.Title,
|
|
26
|
+
string(adr.Status),
|
|
27
|
+
adr.Date,
|
|
28
|
+
s.scopeRef(self, adr.Scope),
|
|
29
|
+
})
|
|
30
|
+
}
|
|
31
|
+
b.WriteString(table([]string{"ADR", "Title", "Status", "Date", "Scope"}, rows))
|
|
32
|
+
|
|
33
|
+
s.b.file(self, b.String())
|
|
34
|
+
|
|
35
|
+
for i := range s.cat.Adrs {
|
|
36
|
+
s.renderAdr(&s.cat.Adrs[i])
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
func (s *site) renderAdr(adr *catalog.Adr) {
|
|
41
|
+
self := s.pathOf[adr.ID]
|
|
42
|
+
|
|
43
|
+
var b strings.Builder
|
|
44
|
+
b.WriteString("# " + adr.ID + " — " + adr.Title + "\n\n")
|
|
45
|
+
b.WriteString(s.stamp() + "\n")
|
|
46
|
+
|
|
47
|
+
meta := [][]string{
|
|
48
|
+
{"Status", string(adr.Status)},
|
|
49
|
+
{"Date", adr.Date},
|
|
50
|
+
{"Scope", s.scopeRef(self, adr.Scope)},
|
|
51
|
+
{"Source", s.source(self, adr.Source, s.adrOwner(adr))},
|
|
52
|
+
}
|
|
53
|
+
if adr.Created != nil {
|
|
54
|
+
meta = append(meta, []string{"Committed", commitLine(adr.Created)})
|
|
55
|
+
}
|
|
56
|
+
if adr.Revised != nil {
|
|
57
|
+
meta = append(meta, []string{"Revised", commitLine(adr.Revised)})
|
|
58
|
+
}
|
|
59
|
+
if adr.Note != "" {
|
|
60
|
+
meta = append(meta, []string{"Note", adr.Note})
|
|
61
|
+
}
|
|
62
|
+
if adr.SupersededBy != "" {
|
|
63
|
+
// Worth putting in the header rather than at the bottom: everything
|
|
64
|
+
// below it is history the moment this is set.
|
|
65
|
+
meta = append(meta, []string{"Superseded by", s.ref(self, adr.SupersededBy, adr.SupersededBy)})
|
|
66
|
+
}
|
|
67
|
+
if len(adr.Supersedes) > 0 {
|
|
68
|
+
refs := make([]string, 0, len(adr.Supersedes))
|
|
69
|
+
for _, id := range adr.Supersedes {
|
|
70
|
+
refs = append(refs, s.ref(self, id, id))
|
|
71
|
+
}
|
|
72
|
+
meta = append(meta, []string{"Supersedes", strings.Join(refs, ", ")})
|
|
73
|
+
}
|
|
74
|
+
b.WriteString(defList(meta))
|
|
75
|
+
|
|
76
|
+
// The body is the record. It is frozen history and is never regenerated
|
|
77
|
+
// from the current catalog, so it goes in whole, one level down.
|
|
78
|
+
if rendered := body(adr.Body, adr.Title); rendered != "" {
|
|
79
|
+
b.WriteString("\n" + rendered + "\n")
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
section(&b, "Relates to", s.relatesList(self, adr.Relates))
|
|
83
|
+
|
|
84
|
+
s.b.file(self, b.String())
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
func (s *site) adrOwner(adr *catalog.Adr) *catalog.Service {
|
|
88
|
+
if adr.Scope.Kind == "service" {
|
|
89
|
+
return s.services[adr.Scope.Service]
|
|
90
|
+
}
|
|
91
|
+
return s.serviceForSource(adr.Source)
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
func (s *site) relatesList(from string, relates catalog.AdrRelates) string {
|
|
95
|
+
var b strings.Builder
|
|
96
|
+
|
|
97
|
+
groups := []struct {
|
|
98
|
+
label string
|
|
99
|
+
ids []string
|
|
100
|
+
}{
|
|
101
|
+
{"Services", relates.Services},
|
|
102
|
+
{"Events", relates.Events},
|
|
103
|
+
{"Flows", relates.Flows},
|
|
104
|
+
}
|
|
105
|
+
|
|
106
|
+
for _, group := range groups {
|
|
107
|
+
if len(group.ids) == 0 {
|
|
108
|
+
continue
|
|
109
|
+
}
|
|
110
|
+
|
|
111
|
+
refs := make([]string, 0, len(group.ids))
|
|
112
|
+
for _, id := range group.ids {
|
|
113
|
+
// An event id belongs to the aggregate page that publishes it, so
|
|
114
|
+
// it is resolved through its owner rather than looked up directly.
|
|
115
|
+
if _, ok := s.eventPage[id]; ok {
|
|
116
|
+
refs = append(refs, s.eventRef(from, id, id))
|
|
117
|
+
|
|
118
|
+
continue
|
|
119
|
+
}
|
|
120
|
+
refs = append(refs, s.ref(from, id, id))
|
|
121
|
+
}
|
|
122
|
+
b.WriteString("- **" + group.label + ":** " + strings.Join(refs, ", ") + "\n")
|
|
123
|
+
}
|
|
124
|
+
|
|
125
|
+
return b.String()
|
|
126
|
+
}
|
|
127
|
+
|
|
128
|
+
func (s *site) scopeRef(from string, scope catalog.AdrScope) string {
|
|
129
|
+
switch scope.Kind {
|
|
130
|
+
case "context":
|
|
131
|
+
return s.ref(from, scope.Context, scope.Context)
|
|
132
|
+
case "service":
|
|
133
|
+
return s.ref(from, scope.Service, scope.Service)
|
|
134
|
+
default:
|
|
135
|
+
return "org"
|
|
136
|
+
}
|
|
137
|
+
}
|
|
138
|
+
|
|
139
|
+
// commitLine is who and when, and the commit itself short enough to read:
|
|
140
|
+
// "Viktor Login, 2024-09-10 (`a6181fe`)".
|
|
141
|
+
func commitLine(c *catalog.AdrCommit) string {
|
|
142
|
+
date := c.Date
|
|
143
|
+
if len(date) >= 10 {
|
|
144
|
+
date = date[:10]
|
|
145
|
+
}
|
|
146
|
+
sha := c.Commit
|
|
147
|
+
if len(sha) > 7 {
|
|
148
|
+
sha = sha[:7]
|
|
149
|
+
}
|
|
150
|
+
parts := []string{}
|
|
151
|
+
if c.Author != "" {
|
|
152
|
+
parts = append(parts, c.Author)
|
|
153
|
+
}
|
|
154
|
+
if date != "" {
|
|
155
|
+
parts = append(parts, date)
|
|
156
|
+
}
|
|
157
|
+
line := strings.Join(parts, ", ")
|
|
158
|
+
if sha != "" {
|
|
159
|
+
line += " (`" + sha + "`)"
|
|
160
|
+
}
|
|
161
|
+
return strings.TrimSpace(line)
|
|
162
|
+
}
|
|
@@ -0,0 +1,362 @@
|
|
|
1
|
+
package main
|
|
2
|
+
|
|
3
|
+
import (
|
|
4
|
+
"strconv"
|
|
5
|
+
"strings"
|
|
6
|
+
|
|
7
|
+
"github.com/shortlink-org/portolan/catalog"
|
|
8
|
+
)
|
|
9
|
+
|
|
10
|
+
func (s *site) renderAggregate(svc *catalog.Service, agg *catalog.Aggregate) {
|
|
11
|
+
self := s.pathOf[agg.ID]
|
|
12
|
+
|
|
13
|
+
var b strings.Builder
|
|
14
|
+
b.WriteString("# " + agg.Name + "\n\n")
|
|
15
|
+
b.WriteString(s.stamp() + "\n")
|
|
16
|
+
|
|
17
|
+
b.WriteString(defList([][]string{
|
|
18
|
+
{"Id", code(agg.ID)},
|
|
19
|
+
{"Service", s.ref(self, svc.ID, svc.Name)},
|
|
20
|
+
{"Root", code(agg.Root)},
|
|
21
|
+
}))
|
|
22
|
+
|
|
23
|
+
if readme := body(agg.Readme, agg.Name); readme != "" {
|
|
24
|
+
b.WriteString("\n" + readme + "\n")
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
if !hasBlock(agg.Entities, agg.Root) {
|
|
28
|
+
s.b.warn(agg.ID, "aggregate %q names %q as its root, which is not one of its entities", agg.ID, agg.Root)
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
section(&b, "Entities", s.blocks(self, agg.Entities, agg.Root))
|
|
32
|
+
section(&b, "Value objects", s.blocks(self, agg.ValueObjects, ""))
|
|
33
|
+
section(&b, "Enums", s.enums(agg.Enums))
|
|
34
|
+
section(&b, "Lifecycle", s.lifecycle(self, svc, agg))
|
|
35
|
+
section(&b, "Operations", s.operationsTable(agg))
|
|
36
|
+
section(&b, "Events", s.eventsBlock(self, svc, agg))
|
|
37
|
+
|
|
38
|
+
s.b.file(self, b.String())
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
// lifecycle draws the root's state machine as the code wrote it down, and
|
|
42
|
+
// lists the moves under it with the event each one publishes. The first
|
|
43
|
+
// state is where a new root starts; a state nothing leads out of ends.
|
|
44
|
+
func (s *site) lifecycle(from string, svc *catalog.Service, agg *catalog.Aggregate) string {
|
|
45
|
+
lc := agg.Lifecycle
|
|
46
|
+
if lc == nil || len(lc.States) == 0 {
|
|
47
|
+
return ""
|
|
48
|
+
}
|
|
49
|
+
alias := func(state string) string {
|
|
50
|
+
var b strings.Builder
|
|
51
|
+
for _, r := range state {
|
|
52
|
+
if r >= 'a' && r <= 'z' || r >= 'A' && r <= 'Z' || r >= '0' && r <= '9' {
|
|
53
|
+
b.WriteRune(r)
|
|
54
|
+
} else {
|
|
55
|
+
b.WriteByte('_')
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
return b.String()
|
|
59
|
+
}
|
|
60
|
+
leads := map[string]bool{}
|
|
61
|
+
for _, t := range lc.Transitions {
|
|
62
|
+
if t.From != t.To {
|
|
63
|
+
leads[t.From] = true
|
|
64
|
+
}
|
|
65
|
+
}
|
|
66
|
+
eventName := func(id string) string {
|
|
67
|
+
for i := range agg.Events {
|
|
68
|
+
if agg.Events[i].ID == id {
|
|
69
|
+
return agg.Events[i].Name
|
|
70
|
+
}
|
|
71
|
+
}
|
|
72
|
+
return id
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
var d strings.Builder
|
|
76
|
+
d.WriteString("stateDiagram-v2\n")
|
|
77
|
+
for _, state := range lc.States {
|
|
78
|
+
if alias(state) != state {
|
|
79
|
+
d.WriteString(" state \"" + mermaidText(state) + "\" as " + alias(state) + "\n")
|
|
80
|
+
}
|
|
81
|
+
}
|
|
82
|
+
d.WriteString(" [*] --> " + alias(lc.States[0]) + "\n")
|
|
83
|
+
for _, t := range lc.Transitions {
|
|
84
|
+
label := t.On
|
|
85
|
+
if t.Emits != "" {
|
|
86
|
+
label += " · " + eventName(t.Emits)
|
|
87
|
+
}
|
|
88
|
+
d.WriteString(" " + alias(t.From) + " --> " + alias(t.To) + ": " + mermaidText(label) + "\n")
|
|
89
|
+
}
|
|
90
|
+
for _, state := range lc.States {
|
|
91
|
+
if !leads[state] {
|
|
92
|
+
d.WriteString(" " + alias(state) + " --> [*]\n")
|
|
93
|
+
}
|
|
94
|
+
}
|
|
95
|
+
|
|
96
|
+
rows := make([][]string, 0, len(lc.Transitions))
|
|
97
|
+
for _, t := range lc.Transitions {
|
|
98
|
+
emits := ""
|
|
99
|
+
if t.Emits != "" {
|
|
100
|
+
emits = s.ref(from, t.Emits, eventName(t.Emits))
|
|
101
|
+
}
|
|
102
|
+
rows = append(rows, []string{code(t.From), code(t.To), code(t.On), emits, s.source(from, t.Source, svc)})
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
return fence("mermaid", d.String()) + "\n" + table([]string{"From", "To", "On", "Emits", "Source"}, rows)
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
func hasBlock(blocks []catalog.Block, name string) bool {
|
|
109
|
+
for i := range blocks {
|
|
110
|
+
if blocks[i].Name == name {
|
|
111
|
+
return true
|
|
112
|
+
}
|
|
113
|
+
}
|
|
114
|
+
|
|
115
|
+
return false
|
|
116
|
+
}
|
|
117
|
+
|
|
118
|
+
// blocks renders entities or value objects. A block is either a shape of its
|
|
119
|
+
// own or a name for a shared one; both are shown with their fields, because a
|
|
120
|
+
// reader asking what a value object holds should not have to follow a link to
|
|
121
|
+
// find out.
|
|
122
|
+
// enums lists each closed set with its values in declaration order: what a
|
|
123
|
+
// consumer has to handle, next to the doc that says when each one comes.
|
|
124
|
+
func (s *site) enums(enums []catalog.Enum) string {
|
|
125
|
+
var b strings.Builder
|
|
126
|
+
|
|
127
|
+
for i := range enums {
|
|
128
|
+
set := &enums[i]
|
|
129
|
+
|
|
130
|
+
heading := set.Name
|
|
131
|
+
if set.Deprecated {
|
|
132
|
+
heading += " — deprecated"
|
|
133
|
+
}
|
|
134
|
+
b.WriteString("### " + heading + "\n\n")
|
|
135
|
+
|
|
136
|
+
if set.Doc != "" {
|
|
137
|
+
b.WriteString(set.Doc + "\n\n")
|
|
138
|
+
}
|
|
139
|
+
|
|
140
|
+
rows := make([][]string, 0, len(set.Values))
|
|
141
|
+
for _, value := range set.Values {
|
|
142
|
+
name := code(value.Name)
|
|
143
|
+
if value.Deprecated {
|
|
144
|
+
name += " (deprecated)"
|
|
145
|
+
}
|
|
146
|
+
rows = append(rows, []string{name, value.Doc})
|
|
147
|
+
}
|
|
148
|
+
if rendered := table([]string{"Value", "Doc"}, rows); rendered != "" {
|
|
149
|
+
b.WriteString(rendered + "\n")
|
|
150
|
+
}
|
|
151
|
+
}
|
|
152
|
+
|
|
153
|
+
return b.String()
|
|
154
|
+
}
|
|
155
|
+
|
|
156
|
+
func (s *site) blocks(from string, blocks []catalog.Block, root string) string {
|
|
157
|
+
var b strings.Builder
|
|
158
|
+
|
|
159
|
+
for i := range blocks {
|
|
160
|
+
block := &blocks[i]
|
|
161
|
+
|
|
162
|
+
heading := block.Name
|
|
163
|
+
if block.Name == root {
|
|
164
|
+
heading += " — aggregate root"
|
|
165
|
+
}
|
|
166
|
+
b.WriteString("### " + heading + "\n\n")
|
|
167
|
+
|
|
168
|
+
if block.Doc != "" {
|
|
169
|
+
b.WriteString(block.Doc + "\n\n")
|
|
170
|
+
}
|
|
171
|
+
|
|
172
|
+
fields := block.Fields
|
|
173
|
+
if block.Ref != "" {
|
|
174
|
+
def, ok := s.cat.Defs[block.Ref]
|
|
175
|
+
if !ok {
|
|
176
|
+
s.b.warn(block.ID, "%q refers to shared type %q, which this catalog does not define", block.ID, block.Ref)
|
|
177
|
+
} else {
|
|
178
|
+
fields = def.Fields
|
|
179
|
+
}
|
|
180
|
+
b.WriteString("Shared type " + s.defRef(from, block.Ref) + ".\n\n")
|
|
181
|
+
}
|
|
182
|
+
|
|
183
|
+
if rendered := s.fieldTable(from, fields); rendered != "" {
|
|
184
|
+
b.WriteString(rendered + "\n")
|
|
185
|
+
}
|
|
186
|
+
}
|
|
187
|
+
|
|
188
|
+
return b.String()
|
|
189
|
+
}
|
|
190
|
+
|
|
191
|
+
func (s *site) operationsTable(agg *catalog.Aggregate) string {
|
|
192
|
+
// Whether this service records what exposes an operation at all. A catalog
|
|
193
|
+
// written before anything read a transport layer says nothing either way,
|
|
194
|
+
// and printing "internal" from that silence would be inventing.
|
|
195
|
+
recorded := false
|
|
196
|
+
for i := range agg.Operations {
|
|
197
|
+
if len(agg.Operations[i].ExposedBy) > 0 {
|
|
198
|
+
recorded = true
|
|
199
|
+
|
|
200
|
+
break
|
|
201
|
+
}
|
|
202
|
+
}
|
|
203
|
+
|
|
204
|
+
rows := make([][]string, 0, len(agg.Operations))
|
|
205
|
+
for i := range agg.Operations {
|
|
206
|
+
op := &agg.Operations[i]
|
|
207
|
+
|
|
208
|
+
exposed := ""
|
|
209
|
+
switch {
|
|
210
|
+
case len(op.ExposedBy) > 0:
|
|
211
|
+
methods := make([]string, 0, len(op.ExposedBy))
|
|
212
|
+
for _, method := range op.ExposedBy {
|
|
213
|
+
methods = append(methods, code(method))
|
|
214
|
+
}
|
|
215
|
+
exposed = strings.Join(methods, ", ")
|
|
216
|
+
case recorded:
|
|
217
|
+
exposed = "*internal*"
|
|
218
|
+
}
|
|
219
|
+
|
|
220
|
+
rows = append(rows, []string{code(op.ID), string(op.Kind), exposed, op.Doc})
|
|
221
|
+
}
|
|
222
|
+
|
|
223
|
+
return table([]string{"Operation", "Kind", "Exposed by", "Doc"}, rows)
|
|
224
|
+
}
|
|
225
|
+
|
|
226
|
+
// eventsBlock renders every version of every event, oldest first.
|
|
227
|
+
//
|
|
228
|
+
// Older versions are kept rather than collapsed into the latest: a consumer
|
|
229
|
+
// reading this page is very often the one still on v1, and a page that shows
|
|
230
|
+
// only what the publisher sends today cannot answer their question.
|
|
231
|
+
func (s *site) eventsBlock(from string, svc *catalog.Service, agg *catalog.Aggregate) string {
|
|
232
|
+
var b strings.Builder
|
|
233
|
+
|
|
234
|
+
for i := range agg.Events {
|
|
235
|
+
event := &agg.Events[i]
|
|
236
|
+
b.WriteString("<a id=\"event-" + anchorID(event.ID) + "\"></a>\n")
|
|
237
|
+
b.WriteString("### " + event.Name + "\n\n")
|
|
238
|
+
b.WriteString(code(event.ID) + "\n")
|
|
239
|
+
|
|
240
|
+
if event.Wire != nil {
|
|
241
|
+
line := "On the wire as " + code(event.Wire.Name)
|
|
242
|
+
if event.Wire.Channel != "" {
|
|
243
|
+
line += ", on " + code(event.Wire.Channel)
|
|
244
|
+
}
|
|
245
|
+
b.WriteString("\n" + line + ".\n")
|
|
246
|
+
}
|
|
247
|
+
|
|
248
|
+
if len(event.Versions) == 0 {
|
|
249
|
+
s.b.warn(event.ID, "event %q has no versions", event.ID)
|
|
250
|
+
}
|
|
251
|
+
|
|
252
|
+
consumers := make([][]string, 0, len(event.Consumers))
|
|
253
|
+
for _, consumer := range event.Consumers {
|
|
254
|
+
consumers = append(consumers, []string{
|
|
255
|
+
s.ref(from, consumer.Service, consumer.Service),
|
|
256
|
+
string(consumer.Status),
|
|
257
|
+
s.viaRef(from, consumer.Via),
|
|
258
|
+
consumer.Note,
|
|
259
|
+
})
|
|
260
|
+
}
|
|
261
|
+
if rendered := table([]string{"Consumer", "Status", "Via", "Note"}, consumers); rendered != "" {
|
|
262
|
+
b.WriteString("\n" + rendered)
|
|
263
|
+
}
|
|
264
|
+
|
|
265
|
+
for j := range event.Versions {
|
|
266
|
+
version := &event.Versions[j]
|
|
267
|
+
|
|
268
|
+
label := version.Version
|
|
269
|
+
if j == len(event.Versions)-1 {
|
|
270
|
+
label += " — current"
|
|
271
|
+
}
|
|
272
|
+
b.WriteString("\n#### " + label + "\n\n")
|
|
273
|
+
|
|
274
|
+
if version.Doc != "" {
|
|
275
|
+
b.WriteString(version.Doc + "\n\n")
|
|
276
|
+
}
|
|
277
|
+
if version.Source != "" {
|
|
278
|
+
b.WriteString("Source: " + s.source(from, version.Source, svc) + "\n\n")
|
|
279
|
+
}
|
|
280
|
+
b.WriteString(s.fieldTable(from, version.Fields))
|
|
281
|
+
}
|
|
282
|
+
b.WriteString("\n")
|
|
283
|
+
}
|
|
284
|
+
|
|
285
|
+
return b.String()
|
|
286
|
+
}
|
|
287
|
+
|
|
288
|
+
func (s *site) fieldTable(from string, fields []catalog.Field) string {
|
|
289
|
+
rows := make([][]string, 0, len(fields))
|
|
290
|
+
for i := range fields {
|
|
291
|
+
field := &fields[i]
|
|
292
|
+
|
|
293
|
+
typ := code(field.Type)
|
|
294
|
+
if field.Ref != "" {
|
|
295
|
+
typ = s.defRef(from, field.Ref)
|
|
296
|
+
}
|
|
297
|
+
rows = append(rows, []string{code(field.Name), typ, field.Doc})
|
|
298
|
+
}
|
|
299
|
+
|
|
300
|
+
return table([]string{"Field", "Type", "Doc"}, rows)
|
|
301
|
+
}
|
|
302
|
+
|
|
303
|
+
// defRef links a shared type to its entry on the types page. Shared types have
|
|
304
|
+
// no page of their own: what a reader wants from `Money` is the same six lines
|
|
305
|
+
// wherever it is mentioned, and six lines do not deserve twenty files.
|
|
306
|
+
func (s *site) defRef(from, key string) string {
|
|
307
|
+
if _, ok := s.cat.Defs[key]; !ok {
|
|
308
|
+
return code(key)
|
|
309
|
+
}
|
|
310
|
+
|
|
311
|
+
return "[" + code(key) + "](" + rel(from, typesPage) + "#type-" + anchorID(key) + ")"
|
|
312
|
+
}
|
|
313
|
+
|
|
314
|
+
const typesPage = "types.md"
|
|
315
|
+
|
|
316
|
+
// anchor is a GitHub-flavoured heading anchor: lowercased, spaces to dashes,
|
|
317
|
+
// everything else dropped.
|
|
318
|
+
func anchor(heading string) string {
|
|
319
|
+
var b strings.Builder
|
|
320
|
+
for _, r := range strings.ToLower(heading) {
|
|
321
|
+
switch {
|
|
322
|
+
case r >= 'a' && r <= 'z', r >= '0' && r <= '9', r == '-', r == '_':
|
|
323
|
+
b.WriteRune(r)
|
|
324
|
+
case r == ' ':
|
|
325
|
+
b.WriteRune('-')
|
|
326
|
+
}
|
|
327
|
+
}
|
|
328
|
+
|
|
329
|
+
return b.String()
|
|
330
|
+
}
|
|
331
|
+
|
|
332
|
+
func (s *site) renderTypes() {
|
|
333
|
+
if len(s.cat.Defs) == 0 {
|
|
334
|
+
return
|
|
335
|
+
}
|
|
336
|
+
|
|
337
|
+
var b strings.Builder
|
|
338
|
+
b.WriteString("# Shared types\n\n")
|
|
339
|
+
b.WriteString(s.stamp() + "\n")
|
|
340
|
+
b.WriteString("Types named by more than one aggregate, event or message. A field that\n")
|
|
341
|
+
b.WriteString("refers to one of these is knowably the same shape everywhere it appears.\n")
|
|
342
|
+
|
|
343
|
+
for _, key := range sortedDefKeys(s.cat.Defs) {
|
|
344
|
+
def := s.cat.Defs[key]
|
|
345
|
+
b.WriteString("\n<a id=\"type-" + anchorID(key) + "\"></a>\n")
|
|
346
|
+
b.WriteString("\n## " + key + "\n\n")
|
|
347
|
+
b.WriteString(s.fieldTable(typesPage, def.Fields))
|
|
348
|
+
}
|
|
349
|
+
|
|
350
|
+
s.b.file(typesPage, b.String())
|
|
351
|
+
}
|
|
352
|
+
|
|
353
|
+
func plural(n int, word string, irregular ...string) string {
|
|
354
|
+
if n == 1 {
|
|
355
|
+
return "1 " + word
|
|
356
|
+
}
|
|
357
|
+
if len(irregular) > 0 {
|
|
358
|
+
return strconv.Itoa(n) + " " + irregular[0]
|
|
359
|
+
}
|
|
360
|
+
|
|
361
|
+
return strconv.Itoa(n) + " " + word + "s"
|
|
362
|
+
}
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
package main
|
|
2
|
+
|
|
3
|
+
import (
|
|
4
|
+
"slices"
|
|
5
|
+
"strings"
|
|
6
|
+
|
|
7
|
+
"github.com/shortlink-org/portolan/catalog"
|
|
8
|
+
)
|
|
9
|
+
|
|
10
|
+
// canonicalCatalog sorts only collections whose order carries no meaning.
|
|
11
|
+
// Fields, event versions, lifecycle transitions, flow participants and flow
|
|
12
|
+
// nodes deliberately keep their declared order.
|
|
13
|
+
func canonicalCatalog(cat catalog.Catalog) catalog.Catalog {
|
|
14
|
+
out := cat
|
|
15
|
+
out.Contexts = slices.Clone(cat.Contexts)
|
|
16
|
+
slices.SortFunc(out.Contexts, func(a, b catalog.BoundedContext) int { return strings.Compare(a.ID, b.ID) })
|
|
17
|
+
for i := range out.Contexts {
|
|
18
|
+
ctx := &out.Contexts[i]
|
|
19
|
+
ctx.Services = slices.Clone(ctx.Services)
|
|
20
|
+
slices.SortFunc(ctx.Services, func(a, b catalog.Service) int { return strings.Compare(a.ID, b.ID) })
|
|
21
|
+
for j := range ctx.Services {
|
|
22
|
+
svc := &ctx.Services[j]
|
|
23
|
+
svc.Aggregates = slices.Clone(svc.Aggregates)
|
|
24
|
+
slices.SortFunc(svc.Aggregates, func(a, b catalog.Aggregate) int { return strings.Compare(a.ID, b.ID) })
|
|
25
|
+
for k := range svc.Aggregates {
|
|
26
|
+
agg := &svc.Aggregates[k]
|
|
27
|
+
agg.Entities = slices.Clone(agg.Entities)
|
|
28
|
+
slices.SortFunc(agg.Entities, func(a, b catalog.Block) int { return strings.Compare(a.ID, b.ID) })
|
|
29
|
+
agg.ValueObjects = slices.Clone(agg.ValueObjects)
|
|
30
|
+
slices.SortFunc(agg.ValueObjects, func(a, b catalog.Block) int { return strings.Compare(a.ID, b.ID) })
|
|
31
|
+
agg.Operations = slices.Clone(agg.Operations)
|
|
32
|
+
slices.SortFunc(agg.Operations, func(a, b catalog.Operation) int { return strings.Compare(a.ID, b.ID) })
|
|
33
|
+
agg.Events = slices.Clone(agg.Events)
|
|
34
|
+
slices.SortFunc(agg.Events, func(a, b catalog.Event) int { return strings.Compare(a.ID, b.ID) })
|
|
35
|
+
agg.Enums = slices.Clone(agg.Enums)
|
|
36
|
+
slices.SortFunc(agg.Enums, func(a, b catalog.Enum) int { return strings.Compare(a.ID, b.ID) })
|
|
37
|
+
}
|
|
38
|
+
svc.Provides = canonicalProvides(svc.Provides)
|
|
39
|
+
svc.Consumes = slices.Clone(svc.Consumes)
|
|
40
|
+
slices.SortFunc(svc.Consumes, func(a, b catalog.RpcCall) int { return strings.Compare(a.ID, b.ID) })
|
|
41
|
+
svc.Stores = sortedStrings(svc.Stores)
|
|
42
|
+
svc.Modules = sortedStrings(svc.Modules)
|
|
43
|
+
svc.Channels = slices.Clone(svc.Channels)
|
|
44
|
+
slices.SortFunc(svc.Channels, func(a, b catalog.Channel) int { return strings.Compare(a.Address, b.Address) })
|
|
45
|
+
}
|
|
46
|
+
}
|
|
47
|
+
out.Stores = slices.Clone(cat.Stores)
|
|
48
|
+
slices.SortFunc(out.Stores, func(a, b catalog.Store) int { return strings.Compare(a.ID, b.ID) })
|
|
49
|
+
out.Flows = slices.Clone(cat.Flows)
|
|
50
|
+
slices.SortFunc(out.Flows, func(a, b catalog.Flow) int { return strings.Compare(a.ID, b.ID) })
|
|
51
|
+
out.Adrs = slices.Clone(cat.Adrs)
|
|
52
|
+
slices.SortFunc(out.Adrs, func(a, b catalog.Adr) int { return strings.Compare(a.ID, b.ID) })
|
|
53
|
+
out.Modules = slices.Clone(cat.Modules)
|
|
54
|
+
slices.SortFunc(out.Modules, func(a, b catalog.ProtoModule) int { return strings.Compare(a.ID, b.ID) })
|
|
55
|
+
for i := range out.Modules {
|
|
56
|
+
out.Modules[i].Packages = sortedStrings(out.Modules[i].Packages)
|
|
57
|
+
out.Modules[i].Files = sortedStrings(out.Modules[i].Files)
|
|
58
|
+
out.Modules[i].Deps = sortedStrings(out.Modules[i].Deps)
|
|
59
|
+
}
|
|
60
|
+
out.Terms = slices.Clone(cat.Terms)
|
|
61
|
+
slices.SortFunc(out.Terms, func(a, b catalog.Term) int {
|
|
62
|
+
if a.Context != b.Context {
|
|
63
|
+
return strings.Compare(a.Context, b.Context)
|
|
64
|
+
}
|
|
65
|
+
return strings.Compare(strings.ToLower(a.Name), strings.ToLower(b.Name))
|
|
66
|
+
})
|
|
67
|
+
out.Externals = slices.Clone(cat.Externals)
|
|
68
|
+
slices.SortFunc(out.Externals, func(a, b catalog.External) int { return strings.Compare(a.ID, b.ID) })
|
|
69
|
+
for i := range out.Externals {
|
|
70
|
+
out.Externals[i].Provides = canonicalProvides(out.Externals[i].Provides)
|
|
71
|
+
}
|
|
72
|
+
return out
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
func canonicalProvides(input []catalog.RpcService) []catalog.RpcService {
|
|
76
|
+
out := slices.Clone(input)
|
|
77
|
+
slices.SortFunc(out, func(a, b catalog.RpcService) int { return strings.Compare(a.ID, b.ID) })
|
|
78
|
+
for i := range out {
|
|
79
|
+
out[i].Methods = slices.Clone(out[i].Methods)
|
|
80
|
+
slices.SortFunc(out[i].Methods, func(a, b catalog.RpcMethod) int { return strings.Compare(a.Name, b.Name) })
|
|
81
|
+
out[i].Messages = slices.Clone(out[i].Messages)
|
|
82
|
+
slices.SortFunc(out[i].Messages, func(a, b catalog.RpcMessage) int { return strings.Compare(a.Name, b.Name) })
|
|
83
|
+
out[i].Enums = slices.Clone(out[i].Enums)
|
|
84
|
+
slices.SortFunc(out[i].Enums, func(a, b catalog.RpcEnum) int { return strings.Compare(a.Name, b.Name) })
|
|
85
|
+
}
|
|
86
|
+
return out
|
|
87
|
+
}
|
|
88
|
+
|
|
89
|
+
func sortedStrings(input []string) []string {
|
|
90
|
+
out := slices.Clone(input)
|
|
91
|
+
slices.Sort(out)
|
|
92
|
+
return out
|
|
93
|
+
}
|
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
package main
|
|
2
|
+
|
|
3
|
+
import (
|
|
4
|
+
"strings"
|
|
5
|
+
|
|
6
|
+
"github.com/shortlink-org/portolan/catalog"
|
|
7
|
+
)
|
|
8
|
+
|
|
9
|
+
func (s *site) renderContext(ctx *catalog.BoundedContext) {
|
|
10
|
+
self := s.pathOf[ctx.ID]
|
|
11
|
+
|
|
12
|
+
var b strings.Builder
|
|
13
|
+
b.WriteString("# " + ctx.Name + "\n\n")
|
|
14
|
+
b.WriteString(s.stamp() + "\n")
|
|
15
|
+
|
|
16
|
+
meta := [][]string{{"Id", code(ctx.ID)}}
|
|
17
|
+
if ctx.Kind != "" {
|
|
18
|
+
meta = append(meta, []string{"Kind", string(ctx.Kind)})
|
|
19
|
+
}
|
|
20
|
+
if ctx.Classification != "" {
|
|
21
|
+
meta = append(meta, []string{"Classification", string(ctx.Classification)})
|
|
22
|
+
}
|
|
23
|
+
b.WriteString(defList(meta))
|
|
24
|
+
|
|
25
|
+
if ctx.Summary != "" {
|
|
26
|
+
b.WriteString("\n" + ctx.Summary + "\n")
|
|
27
|
+
}
|
|
28
|
+
|
|
29
|
+
neutral := ctx.Kind != "" && ctx.Kind != catalog.GroupKindBoundedContext
|
|
30
|
+
rows := make([][]string, 0, len(ctx.Services))
|
|
31
|
+
for i := range ctx.Services {
|
|
32
|
+
svc := &ctx.Services[i]
|
|
33
|
+
if neutral {
|
|
34
|
+
rows = append(rows, []string{
|
|
35
|
+
s.ref(self, svc.ID, svc.Name),
|
|
36
|
+
string(svc.Kind),
|
|
37
|
+
strings.Join(svc.Technologies, ", "),
|
|
38
|
+
code(svc.Path),
|
|
39
|
+
})
|
|
40
|
+
continue
|
|
41
|
+
}
|
|
42
|
+
aggregates := make([]string, 0, len(svc.Aggregates))
|
|
43
|
+
for j := range svc.Aggregates {
|
|
44
|
+
aggregates = append(aggregates, svc.Aggregates[j].Name)
|
|
45
|
+
}
|
|
46
|
+
rows = append(rows, []string{
|
|
47
|
+
s.ref(self, svc.ID, svc.Name),
|
|
48
|
+
code(svc.Path),
|
|
49
|
+
strings.Join(aggregates, ", "),
|
|
50
|
+
})
|
|
51
|
+
}
|
|
52
|
+
title := "Services"
|
|
53
|
+
firstColumn := "Service"
|
|
54
|
+
headings := []string{firstColumn, "Path", "Aggregates"}
|
|
55
|
+
if neutral {
|
|
56
|
+
title = "Components"
|
|
57
|
+
firstColumn = "Component"
|
|
58
|
+
headings = []string{firstColumn, "Kind", "Technologies", "Path"}
|
|
59
|
+
}
|
|
60
|
+
section(&b, title, table(headings, rows))
|
|
61
|
+
|
|
62
|
+
// Before the decisions, because the decisions are written in these words.
|
|
63
|
+
if terms := s.termsOf[ctx.ID]; len(terms) > 0 {
|
|
64
|
+
section(&b, "Language", "- "+link("Glossary", self, s.glossaryPath(ctx))+
|
|
65
|
+
" — "+plural(len(terms), "term")+" this context spells one way\n")
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
section(&b, "Decisions", s.adrTable(self, s.adrsFor[ctx.ID]))
|
|
69
|
+
|
|
70
|
+
s.b.file(self, b.String())
|
|
71
|
+
s.renderGlossary(ctx)
|
|
72
|
+
|
|
73
|
+
for i := range ctx.Services {
|
|
74
|
+
s.renderService(ctx, &ctx.Services[i])
|
|
75
|
+
}
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
func (s *site) adrTable(from string, adrs []*catalog.Adr) string {
|
|
79
|
+
rows := make([][]string, 0, len(adrs))
|
|
80
|
+
for _, adr := range adrs {
|
|
81
|
+
rows = append(rows, []string{
|
|
82
|
+
s.ref(from, adr.ID, adr.ID),
|
|
83
|
+
adr.Title,
|
|
84
|
+
string(adr.Status),
|
|
85
|
+
adr.Date,
|
|
86
|
+
})
|
|
87
|
+
}
|
|
88
|
+
|
|
89
|
+
return table([]string{"ADR", "Title", "Status", "Date"}, rows)
|
|
90
|
+
}
|