@transtyle/exporter-css-variables 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 +40 -0
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# @transtyle/exporter-css-variables
|
|
2
|
+
|
|
3
|
+
Plain CSS custom properties backend for **[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
|
+
Emits `variables.transtyle.css`: the resolved semantic catalog, 1:1, as CSS custom
|
|
13
|
+
properties. No framework, no opinions — useful on its own for a hand-rolled design system,
|
|
14
|
+
and the right target when no exporter exists for your stack yet.
|
|
15
|
+
|
|
16
|
+
It is also the **reference implementation of the plugin API**. An exporter is exactly this
|
|
17
|
+
and nothing more: `emit(normalized, ctx) → { files, coverage }`. If you are writing one,
|
|
18
|
+
read this package first — it is deliberately boring so that it stays readable.
|
|
19
|
+
|
|
20
|
+
## Use
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
npm i -D @transtyle/cli @transtyle/exporter-css-variables
|
|
24
|
+
npx transtyle add css-variables # adds the target to transtyle.config.json
|
|
25
|
+
npx transtyle build css-variables
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
The CLI resolves exporters **from your project first**, so this package does not have to be
|
|
29
|
+
a dependency of the CLI itself. Every build writes a `usage.md` next to the artifacts
|
|
30
|
+
explaining how to wire them into that ecosystem, and a `report.json` recording where every
|
|
31
|
+
value came from and what the target could not express.
|
|
32
|
+
|
|
33
|
+
## Documentation
|
|
34
|
+
|
|
35
|
+
- [css-variables exporter guide](https://transtyle.github.io/transtyle/docs/exporter-css-variables/)
|
|
36
|
+
- [Write an exporter](https://transtyle.github.io/transtyle/docs/write-an-exporter/)
|
|
37
|
+
|
|
38
|
+
## License
|
|
39
|
+
|
|
40
|
+
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/exporter-css-variables",
|
|
3
|
-
"version": "0.1.0-alpha.
|
|
3
|
+
"version": "0.1.0-alpha.2",
|
|
4
4
|
"description": "Transtyle exporter emitting the resolved semantic catalog as plain CSS custom properties — the simplest possible backend and the plugin-API conformance fixture.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./src/index.js",
|
|
@@ -35,7 +35,7 @@
|
|
|
35
35
|
"url": "git+https://github.com/transtyle/transtyle.git",
|
|
36
36
|
"directory": "packages/exporter-css-variables"
|
|
37
37
|
},
|
|
38
|
-
"homepage": "https://github.
|
|
38
|
+
"homepage": "https://transtyle.github.io/transtyle/docs/exporter-css-variables/",
|
|
39
39
|
"bugs": "https://github.com/transtyle/transtyle/issues",
|
|
40
40
|
"license": "MIT"
|
|
41
41
|
}
|