@transtyle/exporter-bootstrap 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 +52 -0
- package/package.json +3 -3
package/README.md
ADDED
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
# @transtyle/exporter-bootstrap
|
|
2
|
+
|
|
3
|
+
Bootstrap 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
|
+
Bootstrap 5.3+ (`>=5.3 <6`), both consumption paths, because the community is split:
|
|
13
|
+
|
|
14
|
+
| File | Path | Fidelity |
|
|
15
|
+
| --------------------------- | -------------------------------------------- | --------------- |
|
|
16
|
+
| `_variables.transtyle.scss` | imported **before** Bootstrap | full |
|
|
17
|
+
| `_maps.transtyle.scss` | imported **after** Bootstrap's own variables | full |
|
|
18
|
+
| `bootstrap-theme.css` | loaded after `bootstrap.css` | token tier only |
|
|
19
|
+
|
|
20
|
+
On the Sass path the OKLCH-derived subtle/emphasis values **replace** Bootstrap's own sRGB
|
|
21
|
+
tint/shade derivations. The CSS-variable path cannot reach values Sass baked into component
|
|
22
|
+
rules (`.btn-primary` backgrounds, hovers); that limit is documented rather than papered
|
|
23
|
+
over, and `report.json` says so per variable.
|
|
24
|
+
|
|
25
|
+
<!-- measured: bootstrap.surface.component = 657 -->
|
|
26
|
+
|
|
27
|
+
**Component tier:** all 657 component-scoped Bootstrap variables are classified against a
|
|
28
|
+
checked-in surface inventory that CI re-derives from Bootstrap's real `_variables.scss`.
|
|
29
|
+
Each is driven by a `component.*` token, chained through Bootstrap's own expressions,
|
|
30
|
+
follows a global, or is honestly reported as unsupported — never silently dropped.
|
|
31
|
+
|
|
32
|
+
## Use
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
npm i -D @transtyle/cli @transtyle/exporter-bootstrap
|
|
36
|
+
npx transtyle add bootstrap # adds the target to transtyle.config.json
|
|
37
|
+
npx transtyle build bootstrap
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
The CLI resolves exporters **from your project first**, so this package does not have to be
|
|
41
|
+
a dependency of the CLI itself. Every build writes a `usage.md` next to the artifacts
|
|
42
|
+
explaining how to wire them into that ecosystem, and a `report.json` recording where every
|
|
43
|
+
value came from and what the target could not express.
|
|
44
|
+
|
|
45
|
+
## Documentation
|
|
46
|
+
|
|
47
|
+
- [Bootstrap exporter guide](https://transtyle.github.io/transtyle/docs/exporter-bootstrap/)
|
|
48
|
+
- [Getting started](https://transtyle.github.io/transtyle/docs/getting-started/)
|
|
49
|
+
|
|
50
|
+
## License
|
|
51
|
+
|
|
52
|
+
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-bootstrap",
|
|
3
|
-
"version": "0.1.0-alpha.
|
|
3
|
+
"version": "0.1.0-alpha.2",
|
|
4
4
|
"description": "Transtyle exporter for Bootstrap themes (5.3+, Sass and CSS-variable paths).",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./src/index.js",
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
".": "./src/index.js"
|
|
9
9
|
},
|
|
10
10
|
"dependencies": {
|
|
11
|
-
"@transtyle/ir": "0.1.0-alpha.
|
|
11
|
+
"@transtyle/ir": "0.1.0-alpha.2"
|
|
12
12
|
},
|
|
13
13
|
"transtyle": {
|
|
14
14
|
"kind": "exporter",
|
|
@@ -39,7 +39,7 @@
|
|
|
39
39
|
"url": "git+https://github.com/transtyle/transtyle.git",
|
|
40
40
|
"directory": "packages/exporter-bootstrap"
|
|
41
41
|
},
|
|
42
|
-
"homepage": "https://github.
|
|
42
|
+
"homepage": "https://transtyle.github.io/transtyle/docs/exporter-bootstrap/",
|
|
43
43
|
"bugs": "https://github.com/transtyle/transtyle/issues",
|
|
44
44
|
"license": "MIT"
|
|
45
45
|
}
|