architecture-publisher 0.0.0-stage → 0.13.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 +114 -2
- package/package.json +86 -4
- package/renderers/archify/supply/LICENSE +22 -0
- package/renderers/archify/supply/THIRD_PARTY_NOTICES.md +77 -0
- package/renderers/archify/supply/assets/JetBrainsMono-OFL.txt +93 -0
- package/renderers/archify/supply/assets/template.html +14761 -0
- package/renderers/archify/supply/bin/archify.mjs +7289 -0
- package/renderers/archify/supply/bin/delivery-update.mjs +92 -0
- package/renderers/archify/supply/bin/finalize.mjs +1055 -0
- package/renderers/archify/supply/bin/open-artifact.mjs +146 -0
- package/renderers/archify/supply/bin/preview.mjs +969 -0
- package/renderers/archify/supply/bin/visual-check.mjs +2779 -0
- package/renderers/archify/supply/explainer/browser-check.mjs +208 -0
- package/renderers/archify/supply/explainer/charts.mjs +70 -0
- package/renderers/archify/supply/explainer/check.mjs +167 -0
- package/renderers/archify/supply/explainer/diagrams.mjs +517 -0
- package/renderers/archify/supply/explainer/diff.mjs +124 -0
- package/renderers/archify/supply/explainer/inline.mjs +155 -0
- package/renderers/archify/supply/explainer/layout.mjs +35 -0
- package/renderers/archify/supply/explainer/page-bundle.mjs +16 -0
- package/renderers/archify/supply/explainer/parse.mjs +300 -0
- package/renderers/archify/supply/explainer/patch.mjs +117 -0
- package/renderers/archify/supply/explainer/prepare.mjs +131 -0
- package/renderers/archify/supply/explainer/reader.css +472 -0
- package/renderers/archify/supply/explainer/reader.js +666 -0
- package/renderers/archify/supply/explainer/render.mjs +223 -0
- package/renderers/archify/supply/explainer/revision.mjs +20 -0
- package/renderers/archify/supply/explainer/sources.mjs +318 -0
- package/renderers/archify/supply/explainer/validate.mjs +138 -0
- package/renderers/archify/supply/explainer/vendor/pele/LICENSE +40 -0
- package/renderers/archify/supply/explainer/vendor/pele/README.md +5 -0
- package/renderers/archify/supply/explainer/vendor/pele/chunks/3DKXF73K.js +4 -0
- package/renderers/archify/supply/explainer/vendor/pele/chunks/42UTT654.js +3 -0
- package/renderers/archify/supply/explainer/vendor/pele/chunks/DKTLEL5E.js +1 -0
- package/renderers/archify/supply/explainer/vendor/pele/chunks/EEIX5ZYH.js +2 -0
- package/renderers/archify/supply/explainer/vendor/pele/chunks/EJ5KOXYD.js +25 -0
- package/renderers/archify/supply/explainer/vendor/pele/chunks/GUJTEFZK.js +1 -0
- package/renderers/archify/supply/explainer/vendor/pele/chunks/IZOKQ2GT.js +4 -0
- package/renderers/archify/supply/explainer/vendor/pele/chunks/L4LY553T.js +3 -0
- package/renderers/archify/supply/explainer/vendor/pele/chunks/MSKIJHB2.js +2 -0
- package/renderers/archify/supply/explainer/vendor/pele/chunks/RVARI57O.js +1 -0
- package/renderers/archify/supply/explainer/vendor/pele/chunks/UKSIWDDN.js +2 -0
- package/renderers/archify/supply/explainer/vendor/pele/chunks/UPTXNAXN.js +2 -0
- package/renderers/archify/supply/explainer/vendor/pele/chunks/XTDUIGUI.js +9 -0
- package/renderers/archify/supply/explainer/vendor/pele/chunks/YAYTP6L5.js +9 -0
- package/renderers/archify/supply/explainer/vendor/pele/core.js +1 -0
- package/renderers/archify/supply/explainer/vendor/pele/diagrams/pie.js +1 -0
- package/renderers/archify/supply/explainer/vendor/pele/diagrams/quadrantChart.js +1 -0
- package/renderers/archify/supply/explainer/vendor/pele/diagrams/radar.js +1 -0
- package/renderers/archify/supply/explainer/vendor/pele/diagrams/sankey.js +1 -0
- package/renderers/archify/supply/explainer/vendor/pele/diagrams/venn.js +1 -0
- package/renderers/archify/supply/explainer/vendor/pele/diagrams/xychart.js +1 -0
- package/renderers/archify/supply/explainer/writing.mjs +139 -0
- package/renderers/archify/supply/locales/en.json +488 -0
- package/renderers/archify/supply/locales/es.json +488 -0
- package/renderers/archify/supply/locales/ko.json +488 -0
- package/renderers/archify/supply/locales/manifest.json +10 -0
- package/renderers/archify/supply/locales/zh-CN.json +488 -0
- package/renderers/archify/supply/locales/zh-TW.json +488 -0
- package/renderers/archify/supply/migrations/workflow-v2.mjs +280 -0
- package/renderers/archify/supply/package.json +17 -0
- package/renderers/archify/supply/renderers/architecture/grid.mjs +62 -0
- package/renderers/archify/supply/renderers/architecture/labels.mjs +2 -0
- package/renderers/archify/supply/renderers/architecture/render-architecture.mjs +1204 -0
- package/renderers/archify/supply/renderers/architecture/routing.mjs +1469 -0
- package/renderers/archify/supply/renderers/class/render-class.mjs +1095 -0
- package/renderers/archify/supply/renderers/dataflow/dataflow-compiler.mjs +1605 -0
- package/renderers/archify/supply/renderers/dataflow/joint-label-routing.mjs +165 -0
- package/renderers/archify/supply/renderers/dataflow/label-capacity.mjs +81 -0
- package/renderers/archify/supply/renderers/dataflow/render-dataflow.mjs +23 -0
- package/renderers/archify/supply/renderers/erd/grid.mjs +150 -0
- package/renderers/archify/supply/renderers/erd/render-erd.mjs +1588 -0
- package/renderers/archify/supply/renderers/explainer/render-explainer.mjs +42 -0
- package/renderers/archify/supply/renderers/lifecycle/render-lifecycle.mjs +1134 -0
- package/renderers/archify/supply/renderers/sequence/render-sequence.mjs +1105 -0
- package/renderers/archify/supply/renderers/shared/atomic-output.mjs +1982 -0
- package/renderers/archify/supply/renderers/shared/automatic-labels.mjs +290 -0
- package/renderers/archify/supply/renderers/shared/brand-marks.mjs +706 -0
- package/renderers/archify/supply/renderers/shared/cli.mjs +429 -0
- package/renderers/archify/supply/renderers/shared/desktop-readability.mjs +132 -0
- package/renderers/archify/supply/renderers/shared/diagnostics.mjs +0 -0
- package/renderers/archify/supply/renderers/shared/engineering-profiles.mjs +157 -0
- package/renderers/archify/supply/renderers/shared/generated-brand-marks.mjs +2003 -0
- package/renderers/archify/supply/renderers/shared/generated-validators.mjs +279 -0
- package/renderers/archify/supply/renderers/shared/geometry.mjs +2073 -0
- package/renderers/archify/supply/renderers/shared/i18n.mjs +328 -0
- package/renderers/archify/supply/renderers/shared/layout-report.mjs +57 -0
- package/renderers/archify/supply/renderers/shared/legend.mjs +227 -0
- package/renderers/archify/supply/renderers/shared/node-card-style.mjs +32 -0
- package/renderers/archify/supply/renderers/shared/output-path.mjs +440 -0
- package/renderers/archify/supply/renderers/shared/owned-temp-directory.mjs +82 -0
- package/renderers/archify/supply/renderers/shared/path-semantics.mjs +1017 -0
- package/renderers/archify/supply/renderers/shared/portable-path.mjs +408 -0
- package/renderers/archify/supply/renderers/shared/repository-evidence.mjs +394 -0
- package/renderers/archify/supply/renderers/shared/repository-location.mjs +71 -0
- package/renderers/archify/supply/renderers/shared/route-quality.mjs +670 -0
- package/renderers/archify/supply/renderers/shared/sidecar-path.mjs +38 -0
- package/renderers/archify/supply/renderers/shared/spatial-grid.mjs +66 -0
- package/renderers/archify/supply/renderers/shared/svg-path-analysis.mjs +135 -0
- package/renderers/archify/supply/renderers/shared/text-fit.mjs +105 -0
- package/renderers/archify/supply/renderers/shared/utils.mjs +260 -0
- package/renderers/archify/supply/renderers/shared/validator.mjs +83 -0
- package/renderers/archify/supply/renderers/timeline/render-timeline.mjs +576 -0
- package/renderers/archify/supply/renderers/tree/render-tree.mjs +573 -0
- package/renderers/archify/supply/renderers/waterfall/render-waterfall.mjs +413 -0
- package/renderers/archify/supply/renderers/workflow/render-workflow.mjs +47 -0
- package/renderers/archify/supply/renderers/workflow/workflow-compiler.mjs +5920 -0
- package/renderers/archify/supply/renderers/workflow/workflow-migration-geometry.mjs +161 -0
- package/renderers/archify/supply/renderers/workflow/workflow-placement-repair.mjs +94 -0
- package/renderers/archify/supply/schemas/architecture.schema.json +152 -0
- package/renderers/archify/supply/schemas/class.schema.json +345 -0
- package/renderers/archify/supply/schemas/common.schema.json +181 -0
- package/renderers/archify/supply/schemas/dataflow.schema.json +254 -0
- package/renderers/archify/supply/schemas/erd.schema.json +381 -0
- package/renderers/archify/supply/schemas/explainer.schema.json +927 -0
- package/renderers/archify/supply/schemas/lifecycle.schema.json +179 -0
- package/renderers/archify/supply/schemas/sequence.schema.json +234 -0
- package/renderers/archify/supply/schemas/timeline.schema.json +160 -0
- package/renderers/archify/supply/schemas/tree.schema.json +141 -0
- package/renderers/archify/supply/schemas/waterfall.schema.json +147 -0
- package/renderers/archify/supply/schemas/workflow.schema.json +439 -0
- package/renderers/archify/supply/scripts/check-render-output.mjs +1469 -0
- package/renderers/archify/supply/supply.json +731 -0
- package/renderers/fonts/supply/noto-sans-cjk-sc/LICENSE +92 -0
- package/renderers/fonts/supply/noto-sans-cjk-sc/NotoSansCJKsc-Bold.otf +0 -0
- package/renderers/fonts/supply/noto-sans-cjk-sc/NotoSansCJKsc-Regular.otf +0 -0
- package/renderers/fonts/supply/supply.json +33 -0
- package/renderers/house/supply/source-sans-3/LICENSE +93 -0
- package/renderers/house/supply/source-sans-3/SourceSans3-It.otf +0 -0
- package/renderers/house/supply/source-sans-3/SourceSans3-Regular.otf +0 -0
- package/renderers/house/supply/source-sans-3/SourceSans3-Semibold.otf +0 -0
- package/renderers/house/supply/source-serif-4/LICENSE +93 -0
- package/renderers/house/supply/source-serif-4/SourceSerif4-Regular.otf +0 -0
- package/renderers/house/supply/source-serif-4/SourceSerif4Subhead-Regular.otf +0 -0
- package/renderers/house/supply/supply.json +71 -0
- package/renderers/icons/supply/LICENSE +43 -0
- package/renderers/icons/supply/artwork.json +9298 -0
- package/renderers/icons/supply/supply.json +27 -0
- package/renderers/opentype/supply/LICENSE +20 -0
- package/renderers/opentype/supply/opentype.mjs +16308 -0
- package/renderers/opentype/supply/package.json +51 -0
- package/renderers/opentype/supply/supply.json +40 -0
- package/renderers/opentype/supply/tiny-inflate-LICENSE +21 -0
- package/skills/architecture-publisher/SKILL.md +104 -0
- package/src/breaks.mjs +79 -0
- package/src/build.mjs +578 -0
- package/src/cli/main.mjs +6 -0
- package/src/cli/run.mjs +469 -0
- package/src/delivery.mjs +322 -0
- package/src/edition/colophon.mjs +178 -0
- package/src/edition/colophon.typ +153 -0
- package/src/edition/record.mjs +175 -0
- package/src/edition/typeset.mjs +153 -0
- package/src/edition/words.mjs +247 -0
- package/src/environment.mjs +32 -0
- package/src/house.json +91 -0
- package/src/icons.mjs +37 -0
- package/src/importers/likec4-worker.mjs +81 -0
- package/src/importers/likec4.mjs +237 -0
- package/src/importers/model.mjs +120 -0
- package/src/kinds.mjs +32 -0
- package/src/layout/channel-solver/conflicts.mjs +125 -0
- package/src/layout/channel-solver/options.mjs +224 -0
- package/src/layout/channel-solver/search.mjs +122 -0
- package/src/layout/channel-solver/solution.mjs +86 -0
- package/src/layout/channel-solver/tracks.mjs +56 -0
- package/src/layout/channels.mjs +595 -0
- package/src/layout/grid.mjs +488 -0
- package/src/layout/measure.mjs +358 -0
- package/src/layout/permutations.mjs +10 -0
- package/src/layout/placement.mjs +536 -0
- package/src/layout/rows.mjs +223 -0
- package/src/locale.mjs +246 -0
- package/src/map/archify.mjs +402 -0
- package/src/map/choice.mjs +577 -0
- package/src/map/explainer.mjs +342 -0
- package/src/map/guide.mjs +277 -0
- package/src/map/routes.mjs +463 -0
- package/src/model/edition.mjs +335 -0
- package/src/model/load.mjs +497 -0
- package/src/model/nearest-name.mjs +47 -0
- package/src/model/normalize.mjs +89 -0
- package/src/model/paths.mjs +87 -0
- package/src/model/schema.json +448 -0
- package/src/overview/checks.mjs +56 -0
- package/src/overview/glyphs.mjs +66 -0
- package/src/overview/house.typ +493 -0
- package/src/overview/lint.mjs +46 -0
- package/src/overview/typeset.mjs +243 -0
- package/src/plan/views.mjs +262 -0
- package/src/poster/balance.mjs +335 -0
- package/src/poster/compose/gates.mjs +44 -0
- package/src/poster/compose/plates.mjs +350 -0
- package/src/poster/figure.mjs +498 -0
- package/src/poster/justify.mjs +71 -0
- package/src/poster/plate.mjs +518 -0
- package/src/poster/strip.mjs +618 -0
- package/src/poster/text.mjs +303 -0
- package/src/poster/tokens.mjs +274 -0
- package/src/refusal.mjs +24 -0
- package/src/sources/ages.mjs +20 -0
- package/src/sources/bind.mjs +289 -0
- package/src/sources/coverage.mjs +146 -0
- package/src/sources/git.mjs +78 -0
- package/src/sources/scope.mjs +128 -0
- package/src/sources/worklist.mjs +174 -0
- package/src/style.mjs +71 -0
- package/src/supply.mjs +39 -0
- package/supplies/likec4/THIRD-PARTY-NOTICES.txt +2438 -0
- package/supplies/likec4/parser.mjs +111205 -0
- package/supplies/likec4/supply.json +516 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Architecture Publisher contributors
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,3 +1,115 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Architecture Publisher
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Architecture Publisher turns an explicit model of a repository's architecture
|
|
4
|
+
into a print edition and an interactive page, and checks every part and every
|
|
5
|
+
connection it draws against the code at one pinned commit.
|
|
6
|
+
|
|
7
|
+

|
|
8
|
+
|
|
9
|
+
_Plate 01 of the publisher's own edition, built by 0.11.0 from
|
|
10
|
+
[its model](https://github.com/HengYangDS/architecture-publications/blob/dev/publications/architecture-publisher/README.md)._
|
|
11
|
+
|
|
12
|
+
You write the model: the components, the connections between them and the
|
|
13
|
+
files that show each one, or you import a LikeC4 workspace. `archpub` reads
|
|
14
|
+
those files at the commit the model pins, lays each view out as a plate with
|
|
15
|
+
no overlaps, and delivers a PDF of one plate per view, a picture of each page,
|
|
16
|
+
a standalone page that walks through the system, and a manifest that binds
|
|
17
|
+
every byte to its inputs. A person accepts the delivery before it is published.
|
|
18
|
+
|
|
19
|
+
## Install
|
|
20
|
+
|
|
21
|
+
```sh
|
|
22
|
+
mise use -g github:HengYangDS/architecture-publisher
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[mise](https://mise.jdx.dev) installs the release archive for your machine:
|
|
26
|
+
Linux and Windows on ARM64 or x86-64, or macOS on ARM64. It holds `archpub`
|
|
27
|
+
with its own Node.js and Typst, so it needs only Git. The
|
|
28
|
+
[how-to guides](docs/how-to.md#install-the-command) install it without mise or
|
|
29
|
+
as an npm package.
|
|
30
|
+
|
|
31
|
+
## Quick start
|
|
32
|
+
|
|
33
|
+
```sh
|
|
34
|
+
archpub check model.json --repo ../my-repository
|
|
35
|
+
archpub build model.json --repo ../my-repository --out delivery
|
|
36
|
+
archpub accept delivery --reviewer "Your Name"
|
|
37
|
+
archpub publish delivery --to <publication-root>
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
`check` validates the model, reads every file it claims and cites at the pinned
|
|
41
|
+
commit and lays out every plate, without writing anything. `build` writes the
|
|
42
|
+
delivery. Only an accepted delivery is published, under
|
|
43
|
+
`<publication-root>/<model id>/<version>/`. The [tutorial](docs/tutorial.md)
|
|
44
|
+
builds a first work from an empty directory in about fifteen minutes.
|
|
45
|
+
|
|
46
|
+
## What it guarantees
|
|
47
|
+
|
|
48
|
+
- **The model, not the code, states the architecture, and the code backs it.**
|
|
49
|
+
Each component claims the paths it owns and each connection cites the files
|
|
50
|
+
that show it. A claim that owns no file or a cited file that is gone is
|
|
51
|
+
refused, and `check --repo <checkout> --against <commit>` lists what moving
|
|
52
|
+
the pin would change.
|
|
53
|
+
- **A plate never draws an overlap.** Cards sit on one lattice and every wire is
|
|
54
|
+
horizontal or vertical; a wire through a card, a shared segment or a touching label
|
|
55
|
+
rejects the layout, and a view no layout can draw is refused, never shrunk.
|
|
56
|
+
- **The same inputs give the same bytes.** The manifest records the digest of
|
|
57
|
+
the model, every file read, every bundled supply and every file written;
|
|
58
|
+
with `--repo`, which dates the edition by the pinned commit, the same model
|
|
59
|
+
and version reproduce every byte on one platform.
|
|
60
|
+
- **A person accepts.** `accept` refuses a delivery that changed since it was
|
|
61
|
+
built, and records who accepted it.
|
|
62
|
+
|
|
63
|
+
## Published works
|
|
64
|
+
|
|
65
|
+
Six works are published from models kept outside the systems they describe, in
|
|
66
|
+
[architecture-publications](https://github.com/HengYangDS/architecture-publications),
|
|
67
|
+
each in English and Chinese:
|
|
68
|
+
|
|
69
|
+
- [ETHOS](https://github.com/HengYangDS/architecture-publications/blob/dev/publications/ethos/README.md):
|
|
70
|
+
how ETHOS turns official intent and fresh facts into proven repository
|
|
71
|
+
change.
|
|
72
|
+
- [Architecture Publisher](https://github.com/HengYangDS/architecture-publications/blob/dev/publications/architecture-publisher/README.md):
|
|
73
|
+
how a model becomes a print edition and a page.
|
|
74
|
+
- [AIGW Client Projection](https://github.com/HengYangDS/architecture-publications/blob/dev/publications/aigw-client/README.md),
|
|
75
|
+
[Data Department Work Guidelines](https://github.com/HengYangDS/architecture-publications/blob/dev/publications/ddwg/README.md),
|
|
76
|
+
[Film Kit](https://github.com/HengYangDS/architecture-publications/blob/dev/publications/filmkit/README.md)
|
|
77
|
+
and the
|
|
78
|
+
[OpenAI Responses Proxy](https://github.com/HengYangDS/architecture-publications/blob/dev/publications/openai-responses-proxy/README.md).
|
|
79
|
+
|
|
80
|
+
## With an agent
|
|
81
|
+
|
|
82
|
+
```sh
|
|
83
|
+
archpub skill
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
prints the agent Skill that ships with the installed version. It walks an agent
|
|
87
|
+
through agreeing on the reader's question, claiming files, planning views,
|
|
88
|
+
checking, writing the guide and building, and leaves acceptance to a person.
|
|
89
|
+
|
|
90
|
+
## Documentation
|
|
91
|
+
|
|
92
|
+
- [Tutorial](docs/tutorial.md): publish a first work, step by step.
|
|
93
|
+
- [How-to guides](docs/how-to.md): install, import, write a guide, compose an
|
|
94
|
+
overview, re-pin and hand a work to a reviewer.
|
|
95
|
+
- [Model reference](docs/reference/model.md): every field of an Architecture
|
|
96
|
+
Model.
|
|
97
|
+
- [Operations reference](docs/reference/operations.md): commands, layout, the
|
|
98
|
+
delivery and every refusal.
|
|
99
|
+
- [Glossary](docs/glossary.md): the words the publisher uses.
|
|
100
|
+
- [Product contract](docs/product-contract.md): inputs, outputs, quality floor
|
|
101
|
+
and boundaries.
|
|
102
|
+
- Examples: the [Big Bank model](examples/big-bank/README.md) and the
|
|
103
|
+
[LikeC4 shop workspace](examples/likec4-shop/README.md).
|
|
104
|
+
|
|
105
|
+
## Contributing
|
|
106
|
+
|
|
107
|
+
Bug reports, ideas and pull requests are welcome; [CONTRIBUTING](CONTRIBUTING.md)
|
|
108
|
+
explains how to report a problem, propose a change and check it locally. The
|
|
109
|
+
[changelog](CHANGELOG.md) records each release.
|
|
110
|
+
|
|
111
|
+
## License
|
|
112
|
+
|
|
113
|
+
Architecture Publisher is released under the [MIT License](LICENSE). The
|
|
114
|
+
bundled fonts, icons, measuring library, Archify and LikeC4 parser keep their
|
|
115
|
+
own licenses, which ship beside them.
|
package/package.json
CHANGED
|
@@ -1,6 +1,88 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "architecture-publisher",
|
|
3
|
-
"version": "0.
|
|
4
|
-
"
|
|
5
|
-
"
|
|
6
|
-
|
|
3
|
+
"version": "0.13.0",
|
|
4
|
+
"description": "Publish a repository's architecture model as a print edition and an interactive page",
|
|
5
|
+
"license": "MIT",
|
|
6
|
+
"repository": {
|
|
7
|
+
"type": "git",
|
|
8
|
+
"url": "git+https://github.com/HengYangDS/architecture-publisher.git"
|
|
9
|
+
},
|
|
10
|
+
"type": "module",
|
|
11
|
+
"bin": {
|
|
12
|
+
"archpub": "src/cli/main.mjs"
|
|
13
|
+
},
|
|
14
|
+
"exports": {
|
|
15
|
+
"./package.json": "./package.json"
|
|
16
|
+
},
|
|
17
|
+
"files": [
|
|
18
|
+
"src/",
|
|
19
|
+
"renderers/",
|
|
20
|
+
"supplies/",
|
|
21
|
+
"skills/",
|
|
22
|
+
"README.md"
|
|
23
|
+
],
|
|
24
|
+
"scripts": {
|
|
25
|
+
"generate": "node tools/supply/likec4.mjs --write",
|
|
26
|
+
"test": "node --import=./tests/fixtures/npm-environment.mjs --test --test-concurrency=2 --test-force-exit tests/*.test.mjs",
|
|
27
|
+
"check": "npm run check:static && npm run test:coverage && npm run check:package",
|
|
28
|
+
"check:static": "npm run check:generated && npm run check:format && npm run check:lint && npm run check:types && npm run check:imports && npm run check:dead-code && npm run check:docs && npm run check:spec",
|
|
29
|
+
"check:generated": "node tools/release/version.mjs --check && npm run check:ci && node tools/supply/likec4.mjs --check && node tools/supply/icons.mjs --check",
|
|
30
|
+
"check:format": "prettier --config .config/checks/prettier/prettier.toml --ignore-path .gitignore --ignore-path .config/checks/prettier/prettierignore --check . && taplo format --config .config/checks/taplo/taplo.toml --check",
|
|
31
|
+
"check:lint": "eslint --config .config/checks/eslint/eslint.config.mjs . --max-warnings 0",
|
|
32
|
+
"check:types": "tsc --project .config/checks/typescript/tsconfig.json --noEmit",
|
|
33
|
+
"check:imports": "node --test tests/module-boundaries.test.mjs",
|
|
34
|
+
"check:dead-code": "knip --config .config/checks/knip/knip.toml && knip --config .config/checks/knip/knip.toml --production --strict --include files,unlisted,unresolved,cycles,exports,nsExports",
|
|
35
|
+
"check:docs": "markdownlint-cli2 --config .config/checks/markdownlint-cli2/.markdownlint-cli2.yaml",
|
|
36
|
+
"check:spec": "openspec validate --all --strict --no-interactive",
|
|
37
|
+
"test:coverage": "c8 --config .config/checks/c8/.c8rc.json npm test",
|
|
38
|
+
"check:package": "node tools/checks/package.mjs",
|
|
39
|
+
"check:ci": "node tools/ci/projection.mjs --check",
|
|
40
|
+
"format": "prettier --config .config/checks/prettier/prettier.toml --ignore-path .gitignore --ignore-path .config/checks/prettier/prettierignore --write . && taplo format --config .config/checks/taplo/taplo.toml"
|
|
41
|
+
},
|
|
42
|
+
"devDependencies": {
|
|
43
|
+
"@eslint/js": "10.0.1",
|
|
44
|
+
"@fission-ai/openspec": "2.0.0",
|
|
45
|
+
"@likec4/language-services": "1.60.0",
|
|
46
|
+
"@types/node": "26.6.6",
|
|
47
|
+
"bundle-require": "5.1.0",
|
|
48
|
+
"c8": "12.0.0",
|
|
49
|
+
"esbuild": "0.28.2",
|
|
50
|
+
"eslint": "10.14.0",
|
|
51
|
+
"globals": "17.14.0",
|
|
52
|
+
"knip": "6.44.2",
|
|
53
|
+
"lucide-static": "1.70.0",
|
|
54
|
+
"markdownlint-cli2": "0.24.0",
|
|
55
|
+
"opentype.js": "2.0.0",
|
|
56
|
+
"playwright-core": "1.65.0",
|
|
57
|
+
"prettier": "3.9.10",
|
|
58
|
+
"publint": "0.3.25",
|
|
59
|
+
"semver": "7.8.6",
|
|
60
|
+
"smol-toml": "1.9.1",
|
|
61
|
+
"typescript": "7.0.2",
|
|
62
|
+
"yaml": "2.9.1"
|
|
63
|
+
},
|
|
64
|
+
"overrides": {
|
|
65
|
+
"glob": "14.0.3",
|
|
66
|
+
"katex": "0.19.1",
|
|
67
|
+
"markdownlint": {
|
|
68
|
+
"re2js": "2.9.1"
|
|
69
|
+
},
|
|
70
|
+
"minimatch": "11.0.4"
|
|
71
|
+
},
|
|
72
|
+
"packageManager": "npm@12.2.2",
|
|
73
|
+
"devEngines": {
|
|
74
|
+
"runtime": {
|
|
75
|
+
"name": "node",
|
|
76
|
+
"version": "26.13.0",
|
|
77
|
+
"onFail": "error"
|
|
78
|
+
},
|
|
79
|
+
"packageManager": {
|
|
80
|
+
"name": "npm",
|
|
81
|
+
"version": "12.2.2",
|
|
82
|
+
"onFail": "error"
|
|
83
|
+
}
|
|
84
|
+
},
|
|
85
|
+
"engines": {
|
|
86
|
+
"node": ">=22.13"
|
|
87
|
+
}
|
|
88
|
+
}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 tt-a1i (Archify)
|
|
4
|
+
Copyright (c) 2025 Cocoon AI
|
|
5
|
+
|
|
6
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
7
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
8
|
+
in the Software without restriction, including without limitation the rights
|
|
9
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
10
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
11
|
+
furnished to do so, subject to the following conditions:
|
|
12
|
+
|
|
13
|
+
The above copyright notice and this permission notice shall be included in all
|
|
14
|
+
copies or substantial portions of the Software.
|
|
15
|
+
|
|
16
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
17
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
18
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
19
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
20
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
21
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
22
|
+
SOFTWARE.
|
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
# Third-party notices
|
|
2
|
+
|
|
3
|
+
Archify includes optional vector data for third-party brand marks. These marks
|
|
4
|
+
are provided only to identify technologies and services in user-authored
|
|
5
|
+
diagrams. Their inclusion does not imply sponsorship, endorsement, partnership,
|
|
6
|
+
or affiliation with Archify.
|
|
7
|
+
|
|
8
|
+
The Archify MIT license applies to Archify's own code and content. It does not
|
|
9
|
+
replace the copyright licenses, trademark policies, or brand guidelines that
|
|
10
|
+
apply to third-party marks. Users are responsible for confirming that their
|
|
11
|
+
particular use is permitted.
|
|
12
|
+
|
|
13
|
+
## Simple Icons
|
|
14
|
+
|
|
15
|
+
Most of the built-in vector paths and their metadata were generated from
|
|
16
|
+
[Simple Icons 16.28.0](https://github.com/simple-icons/simple-icons/tree/16.28.0).
|
|
17
|
+
Simple Icons makes its collection work available under
|
|
18
|
+
[CC0 1.0 Universal](https://github.com/simple-icons/simple-icons/blob/16.28.0/LICENSE.md).
|
|
19
|
+
|
|
20
|
+
As Simple Icons explains in its
|
|
21
|
+
[disclaimer](https://github.com/simple-icons/simple-icons/blob/16.28.0/DISCLAIMER.md),
|
|
22
|
+
CC0 for the collection does not mean that every underlying icon is CC0. License
|
|
23
|
+
and brand-guideline metadata may be incomplete or change over time. The absence
|
|
24
|
+
of an individual license entry is not a grant of permission.
|
|
25
|
+
|
|
26
|
+
Archify embeds the selected icons as vector-path data and may render them in a
|
|
27
|
+
user-selected color. The following individual licenses were recorded in the
|
|
28
|
+
pinned Simple Icons 16.28.0 metadata:
|
|
29
|
+
|
|
30
|
+
| Mark | Recorded source | Recorded license | Archify treatment |
|
|
31
|
+
|---|---|---|---|
|
|
32
|
+
| Angular | [Angular press kit](https://angular.dev/press-kit) | [`CC-BY-4.0`](https://creativecommons.org/licenses/by/4.0/) | Embedded as vector-path data; color may be changed by the authored diagram. |
|
|
33
|
+
| Apache Airflow | [Apache logos](https://apache.org/logos) | [`Apache-2.0`](https://www.apache.org/licenses/LICENSE-2.0) | Embedded as vector-path data; Apache trademarks remain subject to the [ASF trademark policy](https://www.apache.org/foundation/marks/). |
|
|
34
|
+
| Apache Kafka | [Apache logos](https://apache.org/logos) | [`Apache-2.0`](https://www.apache.org/licenses/LICENSE-2.0) | Embedded as vector-path data; Apache trademarks remain subject to the [ASF trademark policy](https://www.apache.org/foundation/marks/). |
|
|
35
|
+
| .NET | [.NET brand repository](https://github.com/dotnet/brand/blob/c7d0f51b8ec59531332d05fb27a5b758a7a3d689/logo/dotnet-logo.svg) | [`CC0-1.0`](https://creativecommons.org/publicdomain/zero/1.0/) | Embedded as vector-path data; color may be changed by the authored diagram. |
|
|
36
|
+
| JavaScript | [JS community logo](https://github.com/voodootikigod/logo.js/blob/1544bdeed6d618a6cfe4f0650d04ab8d9cfa76d9/js.svg) | [`MIT`](https://github.com/voodootikigod/logo.js/blob/1544bdeed6d618a6cfe4f0650d04ab8d9cfa76d9/LICENSE) | Embedded as vector-path data; color may be changed by the authored diagram. |
|
|
37
|
+
| Jenkins | [Jenkins artwork source](https://get.jenkins.io/art/) | [`CC-BY-SA-3.0`](https://creativecommons.org/licenses/by-sa/3.0/) | Embedded as vector-path data; color may be changed by the authored diagram. Jenkins retains its trademark rights. |
|
|
38
|
+
| Rust | [Rust project](https://www.rust-lang.org) | [`CC-BY-SA-4.0`](https://creativecommons.org/licenses/by-sa/4.0/) | Embedded as vector-path data; color may be changed by the authored diagram. See the [Rust media guide](https://www.rust-lang.org/policies/media-guide). |
|
|
39
|
+
| Vue.js | [Vue logo source](https://github.com/vuejs/art/blob/a1c78b74569b70a25300925b4eacfefcc143b8f6/logo.svg) | [`CC-BY-NC-SA-4.0`](https://creativecommons.org/licenses/by-nc-sa/4.0/) | Embedded as vector-path data; color may be changed by the authored diagram. The non-commercial and share-alike conditions remain applicable; see the [Vue artwork terms](https://github.com/vuejs/art/blob/a1c78b74569b70a25300925b4eacfefcc143b8f6/README.md). |
|
|
40
|
+
|
|
41
|
+
The source, guideline, and known license fields for every packaged mark are
|
|
42
|
+
preserved in `renderers/shared/generated-brand-marks.mjs`.
|
|
43
|
+
|
|
44
|
+
## OpenAI mark
|
|
45
|
+
|
|
46
|
+
The OpenAI vector path is recorded from the
|
|
47
|
+
[OpenAI brand guidelines](https://openai.com/brand/), not from Simple Icons.
|
|
48
|
+
Use remains subject to those current guidelines and any applicable trademark
|
|
49
|
+
rights. Its inclusion does not state or imply endorsement by OpenAI.
|
|
50
|
+
|
|
51
|
+
## JetBrains Mono
|
|
52
|
+
|
|
53
|
+
Delivered Archify viewer artifacts embed the JetBrains Mono variable font
|
|
54
|
+
subsets served by Google Fonts. For characters covered by these subsets, font
|
|
55
|
+
selection does not depend on a network request or a locally installed copy.
|
|
56
|
+
Uncovered characters (including CJK) still use the system fallback stack;
|
|
57
|
+
browser and operating-system rasterization can differ.
|
|
58
|
+
JetBrains Mono is maintained at
|
|
59
|
+
[github.com/JetBrains/JetBrainsMono](https://github.com/JetBrains/JetBrainsMono)
|
|
60
|
+
and is distributed under the SIL Open Font License 1.1. The complete license
|
|
61
|
+
text is preserved in `assets/JetBrainsMono-OFL.txt` in the packaged Skill and
|
|
62
|
+
in the font CSS carried by standalone HTML and SVG exports.
|
|
63
|
+
|
|
64
|
+
## Pele
|
|
65
|
+
|
|
66
|
+
The explainer renders Mermaid chart fences with an unmodified subset of
|
|
67
|
+
[Pele 1.3.0](https://github.com/obsidianmd/pele), copyright (c) 2026 kepano,
|
|
68
|
+
distributed under the MIT License. The subset and its license text are in
|
|
69
|
+
`explainer/vendor/pele/` in the packaged Skill. Charts are rendered to static
|
|
70
|
+
SVG when a page is built; delivered pages contain no Pele code.
|
|
71
|
+
|
|
72
|
+
## No additional rights granted
|
|
73
|
+
|
|
74
|
+
Brand names, logos, and trademarks remain the property of their respective
|
|
75
|
+
owners. This notice records provenance and known terms; it does not grant rights
|
|
76
|
+
that Archify does not hold, and it does not state that every packaged mark has
|
|
77
|
+
been cleared for every commercial, promotional, or redistributive use.
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
Copyright 2020 The JetBrains Mono Project Authors (https://github.com/JetBrains/JetBrainsMono)
|
|
2
|
+
|
|
3
|
+
This Font Software is licensed under the SIL Open Font License, Version 1.1.
|
|
4
|
+
This license is copied below, and is also available with a FAQ at:
|
|
5
|
+
https://openfontlicense.org
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
-----------------------------------------------------------
|
|
9
|
+
SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
|
|
10
|
+
-----------------------------------------------------------
|
|
11
|
+
|
|
12
|
+
PREAMBLE
|
|
13
|
+
The goals of the Open Font License (OFL) are to stimulate worldwide
|
|
14
|
+
development of collaborative font projects, to support the font creation
|
|
15
|
+
efforts of academic and linguistic communities, and to provide a free and
|
|
16
|
+
open framework in which fonts may be shared and improved in partnership
|
|
17
|
+
with others.
|
|
18
|
+
|
|
19
|
+
The OFL allows the licensed fonts to be used, studied, modified and
|
|
20
|
+
redistributed freely as long as they are not sold by themselves. The
|
|
21
|
+
fonts, including any derivative works, can be bundled, embedded,
|
|
22
|
+
redistributed and/or sold with any software provided that any reserved
|
|
23
|
+
names are not used by derivative works. The fonts and derivatives,
|
|
24
|
+
however, cannot be released under any other type of license. The
|
|
25
|
+
requirement for fonts to remain under this license does not apply
|
|
26
|
+
to any document created using the fonts or their derivatives.
|
|
27
|
+
|
|
28
|
+
DEFINITIONS
|
|
29
|
+
"Font Software" refers to the set of files released by the Copyright
|
|
30
|
+
Holder(s) under this license and clearly marked as such. This may
|
|
31
|
+
include source files, build scripts and documentation.
|
|
32
|
+
|
|
33
|
+
"Reserved Font Name" refers to any names specified as such after the
|
|
34
|
+
copyright statement(s).
|
|
35
|
+
|
|
36
|
+
"Original Version" refers to the collection of Font Software components as
|
|
37
|
+
distributed by the Copyright Holder(s).
|
|
38
|
+
|
|
39
|
+
"Modified Version" refers to any derivative made by adding to, deleting,
|
|
40
|
+
or substituting -- in part or in whole -- any of the components of the
|
|
41
|
+
Original Version, by changing formats or by porting the Font Software to a
|
|
42
|
+
new environment.
|
|
43
|
+
|
|
44
|
+
"Author" refers to any designer, engineer, programmer, technical
|
|
45
|
+
writer or other person who contributed to the Font Software.
|
|
46
|
+
|
|
47
|
+
PERMISSION & CONDITIONS
|
|
48
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
|
49
|
+
a copy of the Font Software, to use, study, copy, merge, embed, modify,
|
|
50
|
+
redistribute, and sell modified and unmodified copies of the Font
|
|
51
|
+
Software, subject to the following conditions:
|
|
52
|
+
|
|
53
|
+
1) Neither the Font Software nor any of its individual components,
|
|
54
|
+
in Original or Modified Versions, may be sold by itself.
|
|
55
|
+
|
|
56
|
+
2) Original or Modified Versions of the Font Software may be bundled,
|
|
57
|
+
redistributed and/or sold with any software, provided that each copy
|
|
58
|
+
contains the above copyright notice and this license. These can be
|
|
59
|
+
included either as stand-alone text files, human-readable headers or
|
|
60
|
+
in the appropriate machine-readable metadata fields within text or
|
|
61
|
+
binary files as long as those fields can be easily viewed by the user.
|
|
62
|
+
|
|
63
|
+
3) No Modified Version of the Font Software may use the Reserved Font
|
|
64
|
+
Name(s) unless explicit written permission is granted by the corresponding
|
|
65
|
+
Copyright Holder. This restriction only applies to the primary font name as
|
|
66
|
+
presented to the users.
|
|
67
|
+
|
|
68
|
+
4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
|
|
69
|
+
Software shall not be used to promote, endorse or advertise any
|
|
70
|
+
Modified Version, except to acknowledge the contribution(s) of the
|
|
71
|
+
Copyright Holder(s) and the Author(s) or with their explicit written
|
|
72
|
+
permission.
|
|
73
|
+
|
|
74
|
+
5) The Font Software, modified or unmodified, in part or in whole,
|
|
75
|
+
must be distributed entirely under this license, and must not be
|
|
76
|
+
distributed under any other license. The requirement for fonts to
|
|
77
|
+
remain under this license does not apply to any document created
|
|
78
|
+
using the Font Software.
|
|
79
|
+
|
|
80
|
+
TERMINATION
|
|
81
|
+
This license becomes null and void if any of the above conditions are
|
|
82
|
+
not met.
|
|
83
|
+
|
|
84
|
+
DISCLAIMER
|
|
85
|
+
THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
86
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
|
|
87
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
|
|
88
|
+
OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
|
|
89
|
+
COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
|
90
|
+
INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
|
|
91
|
+
DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|
92
|
+
FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
|
|
93
|
+
OTHER DEALINGS IN THE FONT SOFTWARE.
|