@transtyle/ir 0.1.0-alpha.1 → 0.1.0-alpha.2
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/README.md +37 -0
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# @transtyle/ir
|
|
2
|
+
|
|
3
|
+
The semantic catalog and intermediate representation of **[Transtyle](https://transtyle.github.io/transtyle/)**, a design system compiler.
|
|
4
|
+
|
|
5
|
+
> [!WARNING]
|
|
6
|
+
> **Alpha — experimental.** Breaking changes ship without a deprecation cycle: the token
|
|
7
|
+
> vocabulary, the generated output, the config format and the CLI surface can each change
|
|
8
|
+
> between alpha releases. Pin an exact version, and treat generated files as disposable
|
|
9
|
+
> output you regenerate — never as something to hand-edit and keep.
|
|
10
|
+
> ([why](https://github.com/transtyle/transtyle/blob/main/docs/adr/0010-pre-release-breaking-changes.md))
|
|
11
|
+
|
|
12
|
+
This is the pivot vocabulary every importer writes into and every exporter reads out of —
|
|
13
|
+
the LLVM-IR of the analogy. It is deliberately small, and it grows only when two independent
|
|
14
|
+
ecosystems need the same concept.
|
|
15
|
+
|
|
16
|
+
Install it when you are **writing an exporter** or otherwise reading the IR; the compiler
|
|
17
|
+
already depends on it.
|
|
18
|
+
|
|
19
|
+
## What is in here
|
|
20
|
+
|
|
21
|
+
`IR`, `COLOR`, `ROLE`, `GRID`, `TEXT`, `ELEVATION`, `SHADOW`, `Z`, `COMPONENT`, `RESERVED` —
|
|
22
|
+
the catalog constants; `PROVENANCE` and `COVERAGE` — the vocabularies for _where a value came
|
|
23
|
+
from_ and _how honestly a target expressed it_; plus token-tree helpers (`collectTokens`,
|
|
24
|
+
`mergeTrees`, `aliasTarget`, `expandModeMatrix`, `comboKey`, `droppedDimensions`,
|
|
25
|
+
`collectRoleArchetypes`).
|
|
26
|
+
|
|
27
|
+
**Zero dependencies.**
|
|
28
|
+
|
|
29
|
+
## Documentation
|
|
30
|
+
|
|
31
|
+
- [The Transtyle language](https://transtyle.github.io/transtyle/docs/language/)
|
|
32
|
+
- [Concepts](https://transtyle.github.io/transtyle/docs/concepts/)
|
|
33
|
+
- [Write an exporter](https://transtyle.github.io/transtyle/docs/write-an-exporter/)
|
|
34
|
+
|
|
35
|
+
## License
|
|
36
|
+
|
|
37
|
+
MIT — part of the [Transtyle](https://github.com/transtyle/transtyle) monorepo.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@transtyle/ir",
|
|
3
|
-
"version": "0.1.0-alpha.
|
|
3
|
+
"version": "0.1.0-alpha.2",
|
|
4
4
|
"description": "Transtyle IR: semantic catalog, provenance constants, token-tree helpers. Zero dependencies.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./src/index.js",
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
"url": "git+https://github.com/transtyle/transtyle.git",
|
|
19
19
|
"directory": "packages/ir"
|
|
20
20
|
},
|
|
21
|
-
"homepage": "https://github.
|
|
21
|
+
"homepage": "https://transtyle.github.io/transtyle/docs/language/",
|
|
22
22
|
"bugs": "https://github.com/transtyle/transtyle/issues",
|
|
23
23
|
"license": "MIT"
|
|
24
24
|
}
|