@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,151 @@
|
|
|
1
|
+
import { describe, expect, it } from "vitest";
|
|
2
|
+
|
|
3
|
+
import { changesHref, globToRegExp, locate, parseArgs, render, renderJson, renderSarif } from "./diff.mjs";
|
|
4
|
+
|
|
5
|
+
describe("globToRegExp", () => {
|
|
6
|
+
// The manifest's own patterns, which is the whole reason this exists: the
|
|
7
|
+
// working tree's side is globbed by `fs.glob` and the ref's side by this, so
|
|
8
|
+
// the two must agree about which files are sources.
|
|
9
|
+
it("matches what the manifest means by one star", () => {
|
|
10
|
+
const re = globToRegExp("examples/*/portolan/*.json");
|
|
11
|
+
|
|
12
|
+
expect(re.test("examples/auth/portolan/domain.json")).toBe(true);
|
|
13
|
+
expect(re.test("examples/shop/oms/portolan/domain.json")).toBe(false);
|
|
14
|
+
expect(re.test("examples/auth/portolan/domain.json.bak")).toBe(false);
|
|
15
|
+
});
|
|
16
|
+
|
|
17
|
+
it("lets two stars cross a slash", () => {
|
|
18
|
+
const re = globToRegExp("examples/**/portolan/*.json");
|
|
19
|
+
|
|
20
|
+
expect(re.test("examples/shop/oms/portolan/domain.json")).toBe(true);
|
|
21
|
+
expect(re.test("examples/auth/portolan/domain.json")).toBe(true);
|
|
22
|
+
});
|
|
23
|
+
|
|
24
|
+
it("anchors at both ends", () => {
|
|
25
|
+
const re = globToRegExp("data/*.json");
|
|
26
|
+
|
|
27
|
+
expect(re.test("data/adr.json")).toBe(true);
|
|
28
|
+
expect(re.test("vendor/data/adr.json")).toBe(false);
|
|
29
|
+
expect(re.test("data/adr/0001.md")).toBe(false);
|
|
30
|
+
});
|
|
31
|
+
|
|
32
|
+
// A dot is a dot. Left unescaped, `data/*.json` would also match a file
|
|
33
|
+
// called `data/adrxjson`, which is not a thing anybody has but is exactly
|
|
34
|
+
// the kind of quiet wrongness a source list should not have.
|
|
35
|
+
it("takes a dot literally", () => {
|
|
36
|
+
expect(globToRegExp("data/*.json").test("data/adrxjson")).toBe(false);
|
|
37
|
+
});
|
|
38
|
+
});
|
|
39
|
+
|
|
40
|
+
describe("render", () => {
|
|
41
|
+
it("says so plainly when nothing moved", () => {
|
|
42
|
+
expect(render("main", [])).toBe("No architectural change against `main`.\n");
|
|
43
|
+
});
|
|
44
|
+
|
|
45
|
+
it("groups by severity, breaking first", () => {
|
|
46
|
+
const out = render("main", [
|
|
47
|
+
{ kind: "event.removed", severity: "breaking", where: "a", summary: "A is gone" },
|
|
48
|
+
{ kind: "event.added", severity: "addition", where: "b", summary: "B is new" },
|
|
49
|
+
{ kind: "owner.added", severity: "change", where: "c", summary: "C changed hands" },
|
|
50
|
+
]);
|
|
51
|
+
|
|
52
|
+
expect(out).toContain("3 changes.");
|
|
53
|
+
expect(out.indexOf("Breaking")).toBeLessThan(out.indexOf("Added"));
|
|
54
|
+
expect(out.indexOf("Added")).toBeLessThan(out.indexOf("Changed"));
|
|
55
|
+
expect(out).toContain("- A is gone");
|
|
56
|
+
});
|
|
57
|
+
|
|
58
|
+
it("leaves out a severity nothing landed in", () => {
|
|
59
|
+
const out = render("main", [
|
|
60
|
+
{ kind: "event.added", severity: "addition", where: "b", summary: "B is new" },
|
|
61
|
+
]);
|
|
62
|
+
|
|
63
|
+
expect(out).toContain("1 change.");
|
|
64
|
+
expect(out).not.toContain("Breaking");
|
|
65
|
+
});
|
|
66
|
+
|
|
67
|
+
// The list is for the review; the page is for understanding it. The link
|
|
68
|
+
// is the last line, only when there is a site to link to, and only when
|
|
69
|
+
// there is something to look at.
|
|
70
|
+
it("ends with a link into the Changes page when it knows the site", () => {
|
|
71
|
+
const changes = [{ kind: "event.added", severity: "addition", where: "b", summary: "B is new" }];
|
|
72
|
+
|
|
73
|
+
expect(render("origin/main", changes, { site: "https://acme.github.io/shop/", head: "feat/x" }))
|
|
74
|
+
.toMatch(/\[Open in Changes\]\(https:\/\/acme\.github\.io\/shop\/changes\?base=main&head=feat%2Fx\)\n$/);
|
|
75
|
+
expect(render("origin/main", changes)).not.toContain("Open in Changes");
|
|
76
|
+
expect(render("origin/main", [], { site: "https://acme.github.io/shop" })).not.toContain("Open in Changes");
|
|
77
|
+
});
|
|
78
|
+
});
|
|
79
|
+
|
|
80
|
+
describe("changesHref", () => {
|
|
81
|
+
it("spells the base the way the site names a branch, and leaves out an unknown head", () => {
|
|
82
|
+
expect(changesHref("https://acme.github.io/shop", "origin/main", "")).toBe("https://acme.github.io/shop/changes?base=main");
|
|
83
|
+
expect(changesHref("", "main", "x")).toBe("");
|
|
84
|
+
});
|
|
85
|
+
});
|
|
86
|
+
|
|
87
|
+
describe("locate", () => {
|
|
88
|
+
const files = [
|
|
89
|
+
{ path: "data/adr.json", text: '{\n "adrs": [\n { "id": "portolan.0001" }\n ]\n}\n' },
|
|
90
|
+
{ path: "examples/shop/portolan/domain.json", text: '{"contexts":[{"id":"shop","services":[{"id":"shop.order"}]}]}' },
|
|
91
|
+
];
|
|
92
|
+
|
|
93
|
+
it("finds the fragment and line that declares the id", () => {
|
|
94
|
+
expect(locate("shop.order", files)).toEqual({ uri: "examples/shop/portolan/domain.json", line: 1 });
|
|
95
|
+
expect(locate("portolan.0001", files)).toEqual({ uri: "data/adr.json", line: 3 });
|
|
96
|
+
});
|
|
97
|
+
|
|
98
|
+
// `shop.order` must not match `shop-order` or `shop.orders`: the id is a
|
|
99
|
+
// whole string, and its dots are dots.
|
|
100
|
+
it("takes the id whole", () => {
|
|
101
|
+
expect(locate("shop.orde", files)).toEqual({ uri: "portolan.json", line: 1 });
|
|
102
|
+
expect(locate("shop_order", files)).toEqual({ uri: "portolan.json", line: 1 });
|
|
103
|
+
});
|
|
104
|
+
|
|
105
|
+
it("falls back to the manifest for what no working-tree source declares", () => {
|
|
106
|
+
expect(locate("gone.service", files)).toEqual({ uri: "portolan.json", line: 1 });
|
|
107
|
+
});
|
|
108
|
+
});
|
|
109
|
+
|
|
110
|
+
describe("machine formats", () => {
|
|
111
|
+
const changes = [
|
|
112
|
+
{ kind: "event.removed", severity: "breaking", where: "shop.order", summary: "event is gone" },
|
|
113
|
+
{ kind: "owner.added", severity: "change", where: "shop.cart", summary: "owner changed" },
|
|
114
|
+
];
|
|
115
|
+
|
|
116
|
+
it("parses a ref, format and output in either option spelling", () => {
|
|
117
|
+
expect(parseArgs(["main", "--format=json", "--output", "report.json"])).toEqual({
|
|
118
|
+
ref: "main", format: "json", output: "report.json", site: "", head: "",
|
|
119
|
+
});
|
|
120
|
+
expect(parseArgs(["--site", "https://acme.github.io/shop", "--head=feat/x"])).toMatchObject({
|
|
121
|
+
site: "https://acme.github.io/shop", head: "feat/x",
|
|
122
|
+
});
|
|
123
|
+
expect(() => parseArgs(["--site"])).toThrow("--site needs a value");
|
|
124
|
+
});
|
|
125
|
+
|
|
126
|
+
it("anchors every SARIF result at the fragment that declares it", () => {
|
|
127
|
+
const files = [{ path: "examples/shop/portolan/domain.json", text: '{\n "id": "shop.cart"\n}' }];
|
|
128
|
+
const report = JSON.parse(renderSarif("main", changes, files));
|
|
129
|
+
const [gone, owned] = report.runs[0].results;
|
|
130
|
+
|
|
131
|
+
expect(gone.locations[0].physicalLocation).toEqual({
|
|
132
|
+
artifactLocation: { uri: "portolan.json", uriBaseId: "%SRCROOT%" },
|
|
133
|
+
region: { startLine: 1, startColumn: 1 },
|
|
134
|
+
});
|
|
135
|
+
expect(owned.locations[0].physicalLocation.artifactLocation.uri).toBe("examples/shop/portolan/domain.json");
|
|
136
|
+
expect(owned.locations[0].physicalLocation.region.startLine).toBe(2);
|
|
137
|
+
});
|
|
138
|
+
|
|
139
|
+
it("exports a versioned JSON report with counts", () => {
|
|
140
|
+
const report = JSON.parse(renderJson("main", changes));
|
|
141
|
+
expect(report).toMatchObject({ version: 1, base: "main", counts: { breaking: 1, change: 1, addition: 0 } });
|
|
142
|
+
expect(report.changes).toEqual(changes);
|
|
143
|
+
});
|
|
144
|
+
|
|
145
|
+
it("maps breaking changes to SARIF errors", () => {
|
|
146
|
+
const report = JSON.parse(renderSarif("main", changes));
|
|
147
|
+
expect(report.version).toBe("2.1.0");
|
|
148
|
+
expect(report.runs[0].results[0]).toMatchObject({ ruleId: "event.removed", level: "error" });
|
|
149
|
+
expect(report.runs[0].results[0].properties.where).toBe("shop.order");
|
|
150
|
+
});
|
|
151
|
+
});
|
|
@@ -0,0 +1,144 @@
|
|
|
1
|
+
// Puts the architecture diff on the pull request it describes.
|
|
2
|
+
//
|
|
3
|
+
// node scripts/forge-comment.mjs <markdown file>
|
|
4
|
+
//
|
|
5
|
+
// One comment per pull request, updated in place: the body starts with a
|
|
6
|
+
// marker only this script writes, and the next run finds that comment and
|
|
7
|
+
// replaces it rather than adding another, so a PR pushed to twenty times has
|
|
8
|
+
// one report and it is the current one.
|
|
9
|
+
//
|
|
10
|
+
// Which forge and with what token is `forge.mjs`'s to say. GitHub Actions
|
|
11
|
+
// hands over the event (GITHUB_EVENT_PATH) that names the pull request;
|
|
12
|
+
// GitLab CI hands over the merge request's iid. Anything else, or no pull
|
|
13
|
+
// request at all, and this says so on stderr and exits 0: the diff describes
|
|
14
|
+
// a change and never fails one, and neither does the step that posts it. A
|
|
15
|
+
// refusal by the forge (a fork's read-only token) is the same silence; any
|
|
16
|
+
// other failed request is an error, because a broken configuration should be
|
|
17
|
+
// seen once, by whoever set it up.
|
|
18
|
+
|
|
19
|
+
import { readFileSync } from "node:fs";
|
|
20
|
+
|
|
21
|
+
import { detectForge, failure, headers, projectUrl, refused } from "./forge.mjs";
|
|
22
|
+
|
|
23
|
+
export const MARKER = "<!-- portolan:architecture-diff -->";
|
|
24
|
+
|
|
25
|
+
const PAGE = 100;
|
|
26
|
+
|
|
27
|
+
/**
|
|
28
|
+
* Which forge, which pull request, and with what - or the reason there is
|
|
29
|
+
* none. `event` is the parsed GitHub event payload when there is one.
|
|
30
|
+
*/
|
|
31
|
+
export function forgeFromEnv(env, event = null) {
|
|
32
|
+
const forge = detectForge(env);
|
|
33
|
+
if (!forge.provider) return forge;
|
|
34
|
+
|
|
35
|
+
if (forge.provider === "github") {
|
|
36
|
+
const number =
|
|
37
|
+
event?.pull_request?.number ??
|
|
38
|
+
Number(/^refs\/pull\/(\d+)\//.exec(env.GITHUB_REF ?? "")?.[1]);
|
|
39
|
+
if (!number) return { reason: "not a pull request" };
|
|
40
|
+
if (!forge.token) return { reason: "GITHUB_TOKEN is not set" };
|
|
41
|
+
|
|
42
|
+
return { ...forge, number };
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
if (!env.CI_MERGE_REQUEST_IID) return { reason: "not a merge request pipeline" };
|
|
46
|
+
if (!forge.token) return { reason: "PORTOLAN_TOKEN is not set" };
|
|
47
|
+
|
|
48
|
+
return { ...forge, number: Number(env.CI_MERGE_REQUEST_IID) };
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
/** The comment's body: the marker first, so the next run can find it. */
|
|
52
|
+
export function body(markdown) {
|
|
53
|
+
return MARKER + "\n" + markdown.trimEnd() + "\n";
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
/** The comment this script wrote last time, if any. */
|
|
57
|
+
export function findOwn(comments) {
|
|
58
|
+
return comments.find((comment) => (comment.body ?? "").startsWith(MARKER)) ?? null;
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
/** The requests each forge answers: list, create, update. */
|
|
62
|
+
function routes(forge) {
|
|
63
|
+
const project = projectUrl(forge);
|
|
64
|
+
if (forge.provider === "github") {
|
|
65
|
+
const base = `${project}/issues/${forge.number}/comments`;
|
|
66
|
+
|
|
67
|
+
return {
|
|
68
|
+
list: (page) => `${base}?per_page=${PAGE}&page=${page}`,
|
|
69
|
+
create: { method: "POST", url: base },
|
|
70
|
+
update: (id) => ({ method: "PATCH", url: `${project}/issues/comments/${id}` }),
|
|
71
|
+
};
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
const base = `${project}/merge_requests/${forge.number}/notes`;
|
|
75
|
+
|
|
76
|
+
return {
|
|
77
|
+
list: (page) => `${base}?per_page=${PAGE}&page=${page}`,
|
|
78
|
+
create: { method: "POST", url: base },
|
|
79
|
+
update: (id) => ({ method: "PUT", url: `${base}/${id}` }),
|
|
80
|
+
};
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
/**
|
|
84
|
+
* Writes the comment, updating the one from last time when there is one.
|
|
85
|
+
* Answers what it did: `created`, `updated`, or `refused` with the status
|
|
86
|
+
* when the forge would not let this token write here.
|
|
87
|
+
*/
|
|
88
|
+
export async function upsert(forge, markdown, fetchImpl = fetch) {
|
|
89
|
+
const auth = headers(forge);
|
|
90
|
+
const { list, create, update } = routes(forge);
|
|
91
|
+
|
|
92
|
+
const own = await (async () => {
|
|
93
|
+
for (let page = 1; ; page++) {
|
|
94
|
+
const res = await fetchImpl(list(page), { headers: auth });
|
|
95
|
+
if (!res.ok) throw await failure("list comments", res);
|
|
96
|
+
const comments = await res.json();
|
|
97
|
+
const found = findOwn(comments);
|
|
98
|
+
if (found) return found;
|
|
99
|
+
if (comments.length < PAGE) return null;
|
|
100
|
+
}
|
|
101
|
+
})();
|
|
102
|
+
|
|
103
|
+
const { method, url } = own ? update(own.id) : create;
|
|
104
|
+
const res = await fetchImpl(url, {
|
|
105
|
+
method,
|
|
106
|
+
headers: { ...auth, "content-type": "application/json" },
|
|
107
|
+
body: JSON.stringify({ body: body(markdown) }),
|
|
108
|
+
});
|
|
109
|
+
if (refused(res)) return { outcome: "refused", status: res.status };
|
|
110
|
+
if (!res.ok) throw await failure(own ? "update comment" : "create comment", res);
|
|
111
|
+
|
|
112
|
+
return { outcome: own ? "updated" : "created", url: (await res.json()).html_url ?? url };
|
|
113
|
+
}
|
|
114
|
+
|
|
115
|
+
async function main() {
|
|
116
|
+
const file = process.argv[2];
|
|
117
|
+
if (!file) throw new Error("usage: forge-comment.mjs <markdown file>");
|
|
118
|
+
const markdown = readFileSync(file, "utf8");
|
|
119
|
+
|
|
120
|
+
const event = process.env.GITHUB_EVENT_PATH
|
|
121
|
+
? JSON.parse(readFileSync(process.env.GITHUB_EVENT_PATH, "utf8"))
|
|
122
|
+
: null;
|
|
123
|
+
const forge = forgeFromEnv(process.env, event);
|
|
124
|
+
if (!forge.provider) {
|
|
125
|
+
console.error(`forge-comment: nothing to post to (${forge.reason})`);
|
|
126
|
+
|
|
127
|
+
return;
|
|
128
|
+
}
|
|
129
|
+
|
|
130
|
+
const done = await upsert(forge, markdown);
|
|
131
|
+
if (done.outcome === "refused") {
|
|
132
|
+
console.error(`forge-comment: the forge refused (${done.status}); a fork's token cannot write comments`);
|
|
133
|
+
|
|
134
|
+
return;
|
|
135
|
+
}
|
|
136
|
+
console.log(`forge-comment: ${done.outcome} ${done.url}`);
|
|
137
|
+
}
|
|
138
|
+
|
|
139
|
+
if (import.meta.main) {
|
|
140
|
+
main().catch((cause) => {
|
|
141
|
+
console.error("forge-comment: " + cause.message);
|
|
142
|
+
process.exit(1);
|
|
143
|
+
});
|
|
144
|
+
}
|
|
@@ -0,0 +1,151 @@
|
|
|
1
|
+
import { describe, expect, it } from "vitest";
|
|
2
|
+
|
|
3
|
+
import { MARKER, body, findOwn, forgeFromEnv, upsert } from "./forge-comment.mjs";
|
|
4
|
+
|
|
5
|
+
describe("forgeFromEnv", () => {
|
|
6
|
+
it("reads a GitHub pull request off the event payload", () => {
|
|
7
|
+
const forge = forgeFromEnv(
|
|
8
|
+
{ GITHUB_ACTIONS: "true", GITHUB_REPOSITORY: "acme/shop", GITHUB_TOKEN: "t" },
|
|
9
|
+
{ pull_request: { number: 42 } },
|
|
10
|
+
);
|
|
11
|
+
|
|
12
|
+
expect(forge).toEqual({
|
|
13
|
+
provider: "github", api: "https://api.github.com", repo: "acme/shop", number: 42, token: "t",
|
|
14
|
+
});
|
|
15
|
+
});
|
|
16
|
+
|
|
17
|
+
// A workflow_run or a re-run has no event body worth reading, but the ref
|
|
18
|
+
// of a pull request checkout still names it.
|
|
19
|
+
it("falls back to the merge ref when there is no event", () => {
|
|
20
|
+
const forge = forgeFromEnv({
|
|
21
|
+
GITHUB_REPOSITORY: "acme/shop", GITHUB_TOKEN: "t", GITHUB_REF: "refs/pull/7/merge",
|
|
22
|
+
GITHUB_API_URL: "https://ghe.example.com/api/v3/",
|
|
23
|
+
});
|
|
24
|
+
|
|
25
|
+
expect(forge).toMatchObject({ provider: "github", number: 7, api: "https://ghe.example.com/api/v3" });
|
|
26
|
+
});
|
|
27
|
+
|
|
28
|
+
it("says why when a push is not a pull request, or the token is missing", () => {
|
|
29
|
+
expect(forgeFromEnv({ GITHUB_ACTIONS: "true", GITHUB_REF: "refs/heads/main" })).toEqual({ reason: "not a pull request" });
|
|
30
|
+
expect(forgeFromEnv({ GITHUB_ACTIONS: "true" }, { pull_request: { number: 1 } })).toEqual({ reason: "GITHUB_TOKEN is not set" });
|
|
31
|
+
});
|
|
32
|
+
|
|
33
|
+
it("reads a GitLab merge request, with the project token rather than the job's", () => {
|
|
34
|
+
const forge = forgeFromEnv({
|
|
35
|
+
GITLAB_CI: "true", CI_API_V4_URL: "https://gitlab.example.com/api/v4", CI_PROJECT_ID: "12",
|
|
36
|
+
CI_MERGE_REQUEST_IID: "9", CI_JOB_TOKEN: "job", PORTOLAN_TOKEN: "p",
|
|
37
|
+
});
|
|
38
|
+
|
|
39
|
+
expect(forge).toEqual({
|
|
40
|
+
provider: "gitlab", api: "https://gitlab.example.com/api/v4", project: "12", number: 9, token: "p",
|
|
41
|
+
});
|
|
42
|
+
expect(forgeFromEnv({ GITLAB_CI: "true", CI_API_V4_URL: "x", CI_MERGE_REQUEST_IID: "9" })).toEqual({ reason: "PORTOLAN_TOKEN is not set" });
|
|
43
|
+
expect(forgeFromEnv({ GITLAB_CI: "true", CI_API_V4_URL: "x" })).toEqual({ reason: "not a merge request pipeline" });
|
|
44
|
+
});
|
|
45
|
+
|
|
46
|
+
it("has nothing to say on a laptop", () => {
|
|
47
|
+
expect(forgeFromEnv({})).toEqual({ reason: "not running under GitHub Actions or GitLab CI" });
|
|
48
|
+
});
|
|
49
|
+
});
|
|
50
|
+
|
|
51
|
+
describe("the comment", () => {
|
|
52
|
+
it("starts with the marker and is found by it", () => {
|
|
53
|
+
const text = body("### Architecture\n\n1 change.\n");
|
|
54
|
+
|
|
55
|
+
expect(text.startsWith(MARKER + "\n")).toBe(true);
|
|
56
|
+
expect(findOwn([{ id: 1, body: "lgtm" }, { id: 2, body: text }])).toMatchObject({ id: 2 });
|
|
57
|
+
expect(findOwn([{ id: 1, body: "lgtm" }])).toBeNull();
|
|
58
|
+
});
|
|
59
|
+
});
|
|
60
|
+
|
|
61
|
+
describe("upsert", () => {
|
|
62
|
+
const github = { provider: "github", api: "https://api.github.com", repo: "acme/shop", number: 42, token: "t" };
|
|
63
|
+
const gitlab = { provider: "gitlab", api: "https://gitlab.example.com/api/v4", project: "grp/shop", number: 9, token: "p" };
|
|
64
|
+
|
|
65
|
+
/** A fetch that answers from a script and records what it was asked. */
|
|
66
|
+
function fake(answers) {
|
|
67
|
+
const calls = [];
|
|
68
|
+
const fetchImpl = async (url, init = {}) => {
|
|
69
|
+
calls.push({ url, method: init.method ?? "GET", body: init.body ? JSON.parse(init.body) : undefined, headers: init.headers });
|
|
70
|
+
const answer = answers.shift();
|
|
71
|
+
|
|
72
|
+
return {
|
|
73
|
+
ok: answer.status < 400, status: answer.status, statusText: "",
|
|
74
|
+
json: async () => answer.json, text: async () => "",
|
|
75
|
+
};
|
|
76
|
+
};
|
|
77
|
+
|
|
78
|
+
return { fetchImpl, calls };
|
|
79
|
+
}
|
|
80
|
+
|
|
81
|
+
it("creates a comment when it has not written one", async () => {
|
|
82
|
+
const { fetchImpl, calls } = fake([
|
|
83
|
+
{ status: 200, json: [{ id: 1, body: "lgtm" }] },
|
|
84
|
+
{ status: 201, json: { html_url: "https://github.com/acme/shop/pull/42#issuecomment-5" } },
|
|
85
|
+
]);
|
|
86
|
+
|
|
87
|
+
const done = await upsert(github, "report", fetchImpl);
|
|
88
|
+
|
|
89
|
+
expect(done).toEqual({ outcome: "created", url: "https://github.com/acme/shop/pull/42#issuecomment-5" });
|
|
90
|
+
expect(calls[1]).toMatchObject({
|
|
91
|
+
method: "POST",
|
|
92
|
+
url: "https://api.github.com/repos/acme/shop/issues/42/comments",
|
|
93
|
+
body: { body: MARKER + "\nreport\n" },
|
|
94
|
+
});
|
|
95
|
+
expect(calls[1].headers.authorization).toBe("Bearer t");
|
|
96
|
+
});
|
|
97
|
+
|
|
98
|
+
it("updates the comment it wrote last time, on the comment's own route", async () => {
|
|
99
|
+
const { fetchImpl, calls } = fake([
|
|
100
|
+
{ status: 200, json: [{ id: 3, body: MARKER + "\nold\n" }] },
|
|
101
|
+
{ status: 200, json: { html_url: "u" } },
|
|
102
|
+
]);
|
|
103
|
+
|
|
104
|
+
const done = await upsert(github, "new", fetchImpl);
|
|
105
|
+
|
|
106
|
+
expect(done.outcome).toBe("updated");
|
|
107
|
+
expect(calls[1]).toMatchObject({ method: "PATCH", url: "https://api.github.com/repos/acme/shop/issues/comments/3" });
|
|
108
|
+
});
|
|
109
|
+
|
|
110
|
+
it("keeps listing past a full page before deciding there is none", async () => {
|
|
111
|
+
const page = Array.from({ length: 100 }, (_, i) => ({ id: i, body: "x" }));
|
|
112
|
+
const { fetchImpl, calls } = fake([
|
|
113
|
+
{ status: 200, json: page },
|
|
114
|
+
{ status: 200, json: [{ id: 200, body: MARKER + "\nold\n" }] },
|
|
115
|
+
{ status: 200, json: {} },
|
|
116
|
+
]);
|
|
117
|
+
|
|
118
|
+
await upsert(github, "new", fetchImpl);
|
|
119
|
+
|
|
120
|
+
expect(calls[0].url).toContain("page=1");
|
|
121
|
+
expect(calls[1].url).toContain("page=2");
|
|
122
|
+
expect(calls[2]).toMatchObject({ method: "PATCH" });
|
|
123
|
+
});
|
|
124
|
+
|
|
125
|
+
it("speaks GitLab notes with the project path encoded", async () => {
|
|
126
|
+
const { fetchImpl, calls } = fake([
|
|
127
|
+
{ status: 200, json: [{ id: 8, body: MARKER + "\nold\n" }] },
|
|
128
|
+
{ status: 200, json: {} },
|
|
129
|
+
]);
|
|
130
|
+
|
|
131
|
+
await upsert(gitlab, "new", fetchImpl);
|
|
132
|
+
|
|
133
|
+
expect(calls[0].url).toBe("https://gitlab.example.com/api/v4/projects/grp%2Fshop/merge_requests/9/notes?per_page=100&page=1");
|
|
134
|
+
expect(calls[0].headers["private-token"]).toBe("p");
|
|
135
|
+
expect(calls[1]).toMatchObject({ method: "PUT", url: "https://gitlab.example.com/api/v4/projects/grp%2Fshop/merge_requests/9/notes/8" });
|
|
136
|
+
});
|
|
137
|
+
|
|
138
|
+
// A fork's GITHUB_TOKEN can read the comments and not write one. That is
|
|
139
|
+
// the forge's policy, not a broken setup, and the step stays green.
|
|
140
|
+
it("reports a refusal rather than throwing", async () => {
|
|
141
|
+
const { fetchImpl } = fake([{ status: 200, json: [] }, { status: 403, json: {} }]);
|
|
142
|
+
|
|
143
|
+
expect(await upsert(github, "r", fetchImpl)).toEqual({ outcome: "refused", status: 403 });
|
|
144
|
+
});
|
|
145
|
+
|
|
146
|
+
it("throws on any other failure", async () => {
|
|
147
|
+
const { fetchImpl } = fake([{ status: 500, json: {} }]);
|
|
148
|
+
|
|
149
|
+
await expect(upsert(github, "r", fetchImpl)).rejects.toThrow("list comments: 500");
|
|
150
|
+
});
|
|
151
|
+
});
|
|
@@ -0,0 +1,138 @@
|
|
|
1
|
+
// Puts the architecture diff into the release it describes.
|
|
2
|
+
//
|
|
3
|
+
// node scripts/forge-release.mjs <markdown file> [tag]
|
|
4
|
+
//
|
|
5
|
+
// A release body is somebody's text - a changelog, the forge's generated
|
|
6
|
+
// notes - and this owns one section of it: what sits between two markers only
|
|
7
|
+
// this script writes. The section is replaced when it is there and appended
|
|
8
|
+
// when it is not, so the rest of the body is left as it was, and a second run
|
|
9
|
+
// for the same tag changes nothing but the section.
|
|
10
|
+
//
|
|
11
|
+
// A tag with no release yet gets one, named after the tag, with the section
|
|
12
|
+
// as its whole body; a release already drafted keeps its draft status.
|
|
13
|
+
// Without a tag, or a token, this says so on stderr and exits 0, the way the
|
|
14
|
+
// diff never fails what it describes. A refusal by the forge is the same
|
|
15
|
+
// silence; any other failed request is an error.
|
|
16
|
+
|
|
17
|
+
import { readFileSync } from "node:fs";
|
|
18
|
+
|
|
19
|
+
import { detectForge, failure, headers, projectUrl, refused } from "./forge.mjs";
|
|
20
|
+
|
|
21
|
+
export const OPEN = "<!-- portolan:architecture -->";
|
|
22
|
+
export const CLOSE = "<!-- /portolan:architecture -->";
|
|
23
|
+
|
|
24
|
+
/** The forge, the tag, and the token - or why there is nothing to write to. */
|
|
25
|
+
export function forgeFromEnv(env, tag = "") {
|
|
26
|
+
const forge = detectForge(env);
|
|
27
|
+
if (!forge.provider) return forge;
|
|
28
|
+
|
|
29
|
+
const name = tag || (forge.provider === "github"
|
|
30
|
+
? (env.GITHUB_REF_TYPE === "tag" ? env.GITHUB_REF_NAME : /^refs\/tags\/(.+)$/.exec(env.GITHUB_REF ?? "")?.[1])
|
|
31
|
+
: env.CI_COMMIT_TAG);
|
|
32
|
+
if (!name) return { reason: "not a tag" };
|
|
33
|
+
if (!forge.token) return { reason: forge.provider === "github" ? "GITHUB_TOKEN is not set" : "PORTOLAN_TOKEN is not set" };
|
|
34
|
+
|
|
35
|
+
return { ...forge, tag: name };
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
/** The body with this script's section replaced, or appended when absent. */
|
|
39
|
+
export function splice(existing, markdown) {
|
|
40
|
+
const section = OPEN + "\n" + markdown.trimEnd() + "\n" + CLOSE;
|
|
41
|
+
const from = existing.indexOf(OPEN);
|
|
42
|
+
const to = existing.indexOf(CLOSE, from);
|
|
43
|
+
if (from !== -1 && to !== -1) {
|
|
44
|
+
return existing.slice(0, from) + section + existing.slice(to + CLOSE.length);
|
|
45
|
+
}
|
|
46
|
+
const rest = existing.trimEnd();
|
|
47
|
+
|
|
48
|
+
return rest ? rest + "\n\n" + section + "\n" : section + "\n";
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
/** The requests each forge answers: read the release by tag, create, update. */
|
|
52
|
+
function routes(forge) {
|
|
53
|
+
const project = projectUrl(forge);
|
|
54
|
+
if (forge.provider === "github") {
|
|
55
|
+
return {
|
|
56
|
+
read: `${project}/releases/tags/${encodeURIComponent(forge.tag)}`,
|
|
57
|
+
body: (release) => release.body ?? "",
|
|
58
|
+
create: (text) => ({
|
|
59
|
+
method: "POST", url: `${project}/releases`,
|
|
60
|
+
payload: { tag_name: forge.tag, name: forge.tag, body: text },
|
|
61
|
+
}),
|
|
62
|
+
update: (release, text) => ({
|
|
63
|
+
method: "PATCH", url: `${project}/releases/${release.id}`, payload: { body: text },
|
|
64
|
+
}),
|
|
65
|
+
link: (release) => release.html_url,
|
|
66
|
+
};
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
const tag = encodeURIComponent(forge.tag);
|
|
70
|
+
|
|
71
|
+
return {
|
|
72
|
+
read: `${project}/releases/${tag}`,
|
|
73
|
+
body: (release) => release.description ?? "",
|
|
74
|
+
create: (text) => ({
|
|
75
|
+
method: "POST", url: `${project}/releases`,
|
|
76
|
+
payload: { tag_name: forge.tag, name: forge.tag, description: text },
|
|
77
|
+
}),
|
|
78
|
+
update: (release, text) => ({
|
|
79
|
+
method: "PUT", url: `${project}/releases/${tag}`, payload: { description: text },
|
|
80
|
+
}),
|
|
81
|
+
link: (release) => release._links?.self,
|
|
82
|
+
};
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
/**
|
|
86
|
+
* Writes the section. Answers `created`, `updated`, or `refused` with the
|
|
87
|
+
* status when the forge would not let this token write here.
|
|
88
|
+
*/
|
|
89
|
+
export async function upsert(forge, markdown, fetchImpl = fetch) {
|
|
90
|
+
const auth = headers(forge);
|
|
91
|
+
const { read, body, create, update, link } = routes(forge);
|
|
92
|
+
|
|
93
|
+
const found = await fetchImpl(read, { headers: auth });
|
|
94
|
+
if (refused(found)) return { outcome: "refused", status: found.status };
|
|
95
|
+
if (!found.ok && found.status !== 404) throw await failure("read release", found);
|
|
96
|
+
const release = found.status === 404 ? null : await found.json();
|
|
97
|
+
|
|
98
|
+
const { method, url, payload } = release
|
|
99
|
+
? update(release, splice(body(release), markdown))
|
|
100
|
+
: create(splice("", markdown));
|
|
101
|
+
const res = await fetchImpl(url, {
|
|
102
|
+
method,
|
|
103
|
+
headers: { ...auth, "content-type": "application/json" },
|
|
104
|
+
body: JSON.stringify(payload),
|
|
105
|
+
});
|
|
106
|
+
if (refused(res)) return { outcome: "refused", status: res.status };
|
|
107
|
+
if (!res.ok) throw await failure(release ? "update release" : "create release", res);
|
|
108
|
+
|
|
109
|
+
return { outcome: release ? "updated" : "created", url: link(await res.json()) ?? url };
|
|
110
|
+
}
|
|
111
|
+
|
|
112
|
+
async function main() {
|
|
113
|
+
const [file, tag] = process.argv.slice(2);
|
|
114
|
+
if (!file) throw new Error("usage: forge-release.mjs <markdown file> [tag]");
|
|
115
|
+
const markdown = readFileSync(file, "utf8");
|
|
116
|
+
|
|
117
|
+
const forge = forgeFromEnv(process.env, tag);
|
|
118
|
+
if (!forge.provider) {
|
|
119
|
+
console.error(`forge-release: nothing to write to (${forge.reason})`);
|
|
120
|
+
|
|
121
|
+
return;
|
|
122
|
+
}
|
|
123
|
+
|
|
124
|
+
const done = await upsert(forge, markdown);
|
|
125
|
+
if (done.outcome === "refused") {
|
|
126
|
+
console.error(`forge-release: the forge refused (${done.status}); the token cannot write releases`);
|
|
127
|
+
|
|
128
|
+
return;
|
|
129
|
+
}
|
|
130
|
+
console.log(`forge-release: ${done.outcome} ${done.url}`);
|
|
131
|
+
}
|
|
132
|
+
|
|
133
|
+
if (import.meta.main) {
|
|
134
|
+
main().catch((cause) => {
|
|
135
|
+
console.error("forge-release: " + cause.message);
|
|
136
|
+
process.exit(1);
|
|
137
|
+
});
|
|
138
|
+
}
|