@kanso-labs/unplugin-style-dictionary 0.10.13 → 0.10.15
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 +89 -34
- package/dist/compile.js +27 -14
- package/dist/compile.js.map +1 -1
- package/dist/config.js +65 -13
- package/dist/config.js.map +1 -1
- package/dist/index.js +308 -50
- package/dist/index.js.map +1 -1
- package/dist/options.js +40 -0
- package/dist/options.js.map +1 -0
- package/dist/patterns.js +8 -1
- package/dist/patterns.js.map +1 -1
- package/dist/size-report.js +6 -4
- package/dist/size-report.js.map +1 -1
- package/dist/types.d.ts +43 -14
- package/dist/watch-filter.js +18 -3
- package/dist/watch-filter.js.map +1 -1
- package/package.json +6 -6
package/README.md
CHANGED
|
@@ -36,8 +36,16 @@ them.
|
|
|
36
36
|
the error overlay rather than only to the terminal, and cleared on the next
|
|
37
37
|
one that succeeds.
|
|
38
38
|
- **Atomic writes**: Every generated file is written to a temporary sibling and
|
|
39
|
-
renamed into place, so
|
|
40
|
-
|
|
39
|
+
renamed into place, and so is every asset the `copy_assets` and
|
|
40
|
+
`android/copyImages` actions copy, so code reading one while it is being
|
|
41
|
+
rebuilt never sees it half-written. A file whose contents have not changed is
|
|
42
|
+
left alone. A custom action gets the same through `vol.promises.writeFile`,
|
|
43
|
+
`vol.writeFileSync`, `vol.promises.copyFile`, `vol.copyFileSync` and
|
|
44
|
+
`vol.promises.cp`; anything else it writes with, such as `appendFile` or a
|
|
45
|
+
write stream, writes in place. A destination that is a symbolic link is
|
|
46
|
+
written through to the file it points at, and a replaced file keeps its mode.
|
|
47
|
+
A hard-linked destination is replaced rather than updated, so the other link
|
|
48
|
+
keeps the old contents.
|
|
41
49
|
- **Multi-configuration**: Can run multiple Style Dictionary configurations in
|
|
42
50
|
one build (useful for multi-brand or multi-theme projects). They are compiled
|
|
43
51
|
one after another on purpose, so two configurations may safely write to the
|
|
@@ -157,18 +165,24 @@ With no `config`, the root is searched for `sd.config.json`, `config.json`,
|
|
|
157
165
|
`sd.config.js` and `sd.config.mjs`, in that order — and the first one that
|
|
158
166
|
**looks like a Style Dictionary configuration** wins. That means declaring at
|
|
159
167
|
least one of `platforms`, `source`, `include` or `tokens`. A candidate that
|
|
160
|
-
fails the check is
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
so which configuration a build used is answerable from the
|
|
168
|
+
fails the check is skipped rather than adopted, so an unrelated `config.json` —
|
|
169
|
+
an extremely common name for something else — no longer gets compiled over and
|
|
170
|
+
added to the watch set. The path that was picked is printed, along with any file
|
|
171
|
+
skipped on the way, so which configuration a build used is answerable from the
|
|
172
|
+
console. When nothing is adopted, the skipped files are reported as an error.
|
|
173
|
+
|
|
174
|
+
A configuration problem — nothing found, or a named `config` file that is
|
|
175
|
+
missing or will not parse — is said once rather than on every rebuild, and again
|
|
176
|
+
only if it comes back after a build that worked.
|
|
164
177
|
|
|
165
178
|
`config.json` stays in the list because Style Dictionary's own CLI defaults to
|
|
166
179
|
it, so a project relying on that default keeps working.
|
|
167
180
|
|
|
168
181
|
**Two of the four names are modules, and reading a module runs it.** A root
|
|
169
|
-
`sd.config.js` is imported
|
|
170
|
-
cannot prevent that, because the check can only look at what the
|
|
171
|
-
returned. If you name your configuration explicitly, or have none, say
|
|
182
|
+
`sd.config.js` is imported when it is first read, and again whenever it changes,
|
|
183
|
+
and validation cannot prevent that, because the check can only look at what the
|
|
184
|
+
import returned. If you name your configuration explicitly, or have none, say
|
|
185
|
+
so:
|
|
172
186
|
|
|
173
187
|
```typescript
|
|
174
188
|
StyleDictionary({ config: false })
|
|
@@ -545,8 +559,10 @@ StyleDictionary({
|
|
|
545
559
|
```
|
|
546
560
|
|
|
547
561
|
`'warn'` is the level worth knowing about: Style Dictionary's warnings without
|
|
548
|
-
the plugin's own progress lines and size table.
|
|
549
|
-
`'
|
|
562
|
+
the plugin's own progress lines and size table. Style Dictionary's own lines
|
|
563
|
+
stay — the platform name and the `✔︎` for each file it wrote — because `'warn'`
|
|
564
|
+
leaves its verbosity at the default, and only `'silent'` quiets them.
|
|
565
|
+
`silent: true` is an alias for `'silent'`.
|
|
550
566
|
|
|
551
567
|
A compile that fails is reported at every level, including `'silent'`, which is
|
|
552
568
|
why there is no `'error'`. `log.warnings` is never touched: if your
|
|
@@ -557,12 +573,12 @@ configuration turns a warning into a thrown build, that stays your decision.
|
|
|
557
573
|
Through your bundler, not straight to the console, and each one takes them its
|
|
558
574
|
own way:
|
|
559
575
|
|
|
560
|
-
| Target | Progress lines
|
|
561
|
-
| ------------------ |
|
|
562
|
-
| Vite | `config.logger.info`
|
|
563
|
-
| Rollup, Rolldown | the plugin context's log
|
|
564
|
-
| Webpack, Rspack | the console
|
|
565
|
-
| No host (one-shot) | the console
|
|
576
|
+
| Target | Progress lines and size table | A failed compile |
|
|
577
|
+
| ------------------ | ----------------------------- | ---------------------------------- |
|
|
578
|
+
| Vite | `config.logger.info` | `config.logger.error` |
|
|
579
|
+
| Rollup, Rolldown | the plugin context's log | the context's warning channel |
|
|
580
|
+
| Webpack, Rspack | the console | `compilation.warnings`, so `stats` |
|
|
581
|
+
| No host (one-shot) | the console | the console |
|
|
566
582
|
|
|
567
583
|
That is what makes a `customLogger` and `clearScreen` work under Vite, and what
|
|
568
584
|
puts a failed compile into `stats.toJson()` under webpack — where it reaches CI
|
|
@@ -583,9 +599,12 @@ than `compilation.errors`, so `failOnError: false` really does leave the build
|
|
|
583
599
|
passing.
|
|
584
600
|
|
|
585
601
|
**Your bundler's own log level applies.** `vite --logLevel silent` silences
|
|
586
|
-
Vite's logger, and the plugin's lines are Vite's logger's now, so they go too
|
|
587
|
-
|
|
588
|
-
|
|
602
|
+
Vite's logger, and the plugin's lines are Vite's logger's now, so they go too —
|
|
603
|
+
the size table included. Style Dictionary's own lines are not among them: the
|
|
604
|
+
platform name and the `✔︎` for each file it wrote are its own `console` calls, so
|
|
605
|
+
they still print unless the plugin's `logLevel` is `'silent'`. Nothing is lost
|
|
606
|
+
by it that matters: `failOnError` decides whether a broken token set stops the
|
|
607
|
+
build, and it decides that whether or not anything was printed.
|
|
589
608
|
|
|
590
609
|
Colour follows the usual conventions, which it previously ignored entirely: no
|
|
591
610
|
escapes when `NO_COLOR` is set, or when the stream is not a terminal, or under
|
|
@@ -679,6 +698,13 @@ dev server down from inside a step meant to reformat a file.
|
|
|
679
698
|
decides whether to rethrow. The two answer different questions: one is whether
|
|
680
699
|
the host stops, the other is that a build went wrong.
|
|
681
700
|
|
|
701
|
+
**A failure names the configuration it came from.** Style Dictionary's own
|
|
702
|
+
errors name neither the configuration nor the file behind them, so the plugin
|
|
703
|
+
wraps them: the message opens with the configuration's path, or its position in
|
|
704
|
+
the list, and Style Dictionary's error is the `cause`. A failed rebuild also
|
|
705
|
+
names the change it followed — the last file to change, which is not necessarily
|
|
706
|
+
the one that broke the build.
|
|
707
|
+
|
|
682
708
|
## Public API
|
|
683
709
|
|
|
684
710
|
Small on purpose. Five bundler entry points, one root entry, and two types.
|
|
@@ -720,14 +746,21 @@ const plugin = styleDictionary.rollup({ config: 'sd.config.json' })
|
|
|
720
746
|
* build (e.g. `tsdown`/`rolldown build` without `--watch`) only builds once, in
|
|
721
747
|
* `buildStart`.
|
|
722
748
|
*
|
|
723
|
-
*
|
|
724
|
-
* Vite's `config.logger`, the plugin context under rollup and
|
|
725
|
-
* `compilation.warnings` under webpack, which is what
|
|
726
|
-
* `stats.toJson()`.
|
|
727
|
-
*
|
|
728
|
-
*
|
|
729
|
-
*
|
|
730
|
-
*
|
|
749
|
+
* What the plugin says goes through the host wherever the host has a channel
|
|
750
|
+
* for it: Vite's `config.logger`, the plugin context under rollup and
|
|
751
|
+
* rolldown, and `compilation.warnings` under webpack and rspack, which is what
|
|
752
|
+
* puts a failed compile in `stats.toJson()`. The progress lines and the size
|
|
753
|
+
* table take the host's `info` channel, and webpack and rspack have none, so
|
|
754
|
+
* there both go to the console. A failure is reported on the warning channel
|
|
755
|
+
* and never the error one — rollup's `this.error` aborts the bundle, and that
|
|
756
|
+
* decision is `failOnError`'s alone. Where no host offers a channel the console
|
|
757
|
+
* is used, with colour gated on `NO_COLOR`, `FORCE_COLOR` and whether the
|
|
758
|
+
* stream is a terminal.
|
|
759
|
+
*
|
|
760
|
+
* Style Dictionary's own lines are not the plugin's. The platform name and the
|
|
761
|
+
* `✔︎` for each file it wrote are its own `console` calls, so they reach the
|
|
762
|
+
* console under every host, whatever the host's log level. `logLevel: 'silent'`
|
|
763
|
+
* quiets them, as does `log.verbosity: 'silent'` in the configuration.
|
|
731
764
|
*
|
|
732
765
|
* The three `onBuild*` hooks are called synchronously and their return value
|
|
733
766
|
* is not awaited, so a build never waits for one. A hook may still be written
|
|
@@ -860,14 +893,16 @@ export interface UnpluginStyleDictionaryOptions {
|
|
|
860
893
|
* first one that *looks like a Style Dictionary configuration* wins — it has
|
|
861
894
|
* to declare at least one of `platforms`, `source`, `include` or `tokens` —
|
|
862
895
|
* and the path it picked is announced, so which file a build used is
|
|
863
|
-
* answerable from the console. A candidate that fails that check is
|
|
864
|
-
*
|
|
865
|
-
*
|
|
896
|
+
* answerable from the console. A candidate that fails that check is skipped
|
|
897
|
+
* rather than adopted, because `config.json` is an extremely common name for
|
|
898
|
+
* something else entirely. It is named in that announcement when a later
|
|
899
|
+
* candidate is adopted, and reported as an error when none is.
|
|
866
900
|
*
|
|
867
901
|
* **`false` turns discovery off.** Two of the four names are modules rather
|
|
868
902
|
* than data, and reading a module means running it: a `sd.config.js` in the
|
|
869
|
-
* root is imported
|
|
870
|
-
*
|
|
903
|
+
* root is imported when it is first read, and again whenever it or a file
|
|
904
|
+
* named in `watch` changes. Validation cannot prevent that, because the
|
|
905
|
+
* check can only look at what the import returned — so a
|
|
871
906
|
* project that names its configuration explicitly, or has none, should say
|
|
872
907
|
* `config: false` rather than rely on there being nothing to find.
|
|
873
908
|
*/
|
|
@@ -924,6 +959,10 @@ export interface UnpluginStyleDictionaryOptions {
|
|
|
924
959
|
*
|
|
925
960
|
* Reporting happens either way, and is not suppressed by `silent`.
|
|
926
961
|
*
|
|
962
|
+
* Any other value throws a `TypeError` when the plugin is created — the
|
|
963
|
+
* string `'true'` from an environment variable included, which used to
|
|
964
|
+
* behave as `false`.
|
|
965
|
+
*
|
|
927
966
|
* @default 'build'
|
|
928
967
|
*/
|
|
929
968
|
failOnError?: 'build' | 'serve' | boolean
|
|
@@ -944,7 +983,9 @@ export interface UnpluginStyleDictionaryOptions {
|
|
|
944
983
|
* about rather than pointing at its own `--verbose` flag.
|
|
945
984
|
*
|
|
946
985
|
* A compile that fails is reported at every level, so there is no
|
|
947
|
-
* `'error'`: `'silent'` is the quietest and still reports a failure.
|
|
986
|
+
* `'error'`: `'silent'` is the quietest and still reports a failure. Any
|
|
987
|
+
* other value, `'error'` included, throws a `TypeError` when the plugin is
|
|
988
|
+
* created.
|
|
948
989
|
*
|
|
949
990
|
* This option governs what the plugin says, not where it goes. The messages
|
|
950
991
|
* are handed to the host — Vite's `config.logger`, the rollup and rolldown
|
|
@@ -981,6 +1022,10 @@ export interface UnpluginStyleDictionaryOptions {
|
|
|
981
1022
|
/**
|
|
982
1023
|
* Called when a build fails, with whatever was thrown.
|
|
983
1024
|
*
|
|
1025
|
+
* A failure inside Style Dictionary arrives wrapped in an `Error` whose
|
|
1026
|
+
* message names the configuration it came from, with Style Dictionary's own
|
|
1027
|
+
* error as its `cause`. One the plugin raises itself already names it.
|
|
1028
|
+
*
|
|
984
1029
|
* It fires whatever `failOnError` is set to, and before that option decides
|
|
985
1030
|
* whether to rethrow — the two answer different questions, and under a dev
|
|
986
1031
|
* server the default is not to throw at all.
|
|
@@ -1039,6 +1084,11 @@ export interface UnpluginStyleDictionaryOptions {
|
|
|
1039
1084
|
* stale output for the rest. Scope the watch half rather than the build half
|
|
1040
1085
|
* unless that is what you want.
|
|
1041
1086
|
*
|
|
1087
|
+
* Any other shape throws a `TypeError` when the plugin is created: a single
|
|
1088
|
+
* string, or an object with a key other than `build` and `watch` — `serve`
|
|
1089
|
+
* is the easy slip, since `failOnError` says `'serve'`. Both used to build
|
|
1090
|
+
* every platform.
|
|
1091
|
+
*
|
|
1042
1092
|
* @default undefined, which builds every platform
|
|
1043
1093
|
*/
|
|
1044
1094
|
platforms?: string[] | { build?: string[]; watch?: string[] }
|
|
@@ -1109,6 +1159,11 @@ export interface UnpluginStyleDictionaryOptions {
|
|
|
1109
1159
|
* else, name a file here relative to the root, and in `source` relative to
|
|
1110
1160
|
* where the build runs.
|
|
1111
1161
|
*
|
|
1162
|
+
* A configuration module is imported again when a file named here changes,
|
|
1163
|
+
* so a data file it reads when it loads is picked up. A module that a
|
|
1164
|
+
* configuration or a token module itself imports is evaluated once per
|
|
1165
|
+
* process, though: naming it here buys a rebuild, not a re-read.
|
|
1166
|
+
*
|
|
1112
1167
|
* What a change to a watched file then triggers is the host's to decide —
|
|
1113
1168
|
* see the interface documentation above.
|
|
1114
1169
|
*/
|
package/dist/compile.js
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
import { asError, errorMessage } from "./errors.js";
|
|
2
2
|
import { configForBuild, describeConfig, readConfigObject } from "./config.js";
|
|
3
3
|
import { patternsMatchingNothing, sourcePatternsOf } from "./patterns.js";
|
|
4
|
-
import {
|
|
4
|
+
import { sizeTable } from "./size-report.js";
|
|
5
5
|
import { configFingerprint, declaredDestinations, isUpToDate, newestSourceOf, readPersistedRecords, recordOf, recordsFileFor, writePersistedRecords, writtenDestination } from "./up-to-date.js";
|
|
6
6
|
import fs from "node:fs";
|
|
7
7
|
import path from "node:path";
|
|
8
8
|
import StyleDictionary from "style-dictionary";
|
|
9
9
|
//#region src/compile.ts
|
|
10
10
|
async function runBuilds(instance, resolvedConfigs, context) {
|
|
11
|
-
const { cache, destinationRecords, failOnError, generatedDestinations, log, notifyBuildOutcome, onBuildEnd, onBuildError, onBuildStart, persistedRecordFiles, platformsOption, quiet, report,
|
|
11
|
+
const { cache, destinationRecords, failOnError, generatedDestinations, log, logTable, notifyBuildOutcome, onBuildEnd, onBuildError, onBuildStart, persistedRecordFiles, platformsOption, quiet, report, verbosity, volume, watch } = instance;
|
|
12
12
|
const root = instance.root();
|
|
13
13
|
const startTime = Date.now();
|
|
14
14
|
const generatedFiles = /* @__PURE__ */ new Set();
|
|
@@ -26,6 +26,7 @@ async function runBuilds(instance, resolvedConfigs, context) {
|
|
|
26
26
|
for (const [index, item] of resolvedConfigs.entries()) {
|
|
27
27
|
const declared = cache ? await readConfigObject(item) : null;
|
|
28
28
|
const selectedPlatforms = platformsFor(platformsOption, context);
|
|
29
|
+
if (declared) checkSelection(item, index, selectedPlatforms, declared.platforms);
|
|
29
30
|
const newestSource = declared ? await newestSourceOf({
|
|
30
31
|
log,
|
|
31
32
|
root,
|
|
@@ -42,10 +43,10 @@ async function runBuilds(instance, resolvedConfigs, context) {
|
|
|
42
43
|
continue;
|
|
43
44
|
}
|
|
44
45
|
const sd = new StyleDictionary(await configForBuild(item), { init: false });
|
|
45
|
-
await sd.extend(void 0, {
|
|
46
|
+
await namingConfig(item, index, async () => sd.extend(void 0, {
|
|
46
47
|
mutateOriginal: true,
|
|
47
48
|
verbosity
|
|
48
|
-
});
|
|
49
|
+
}));
|
|
49
50
|
if (sd.allTokens.length === 0) {
|
|
50
51
|
const asObject = await readConfigObject(item);
|
|
51
52
|
const barren = asObject ? await patternsMatchingNothing(sourcePatternsOf(asObject)) : [];
|
|
@@ -59,12 +60,10 @@ async function runBuilds(instance, resolvedConfigs, context) {
|
|
|
59
60
|
sd.volume = notingWrites(volume, wrote);
|
|
60
61
|
const writing = declaredDestinations({ platforms: sd.platforms }, selectedPlatforms);
|
|
61
62
|
for (const destination of writing) destinationRecords.delete(destination);
|
|
62
|
-
if (selectedPlatforms === void 0) await sd.buildAllPlatforms();
|
|
63
|
+
if (selectedPlatforms === void 0) await namingConfig(item, index, async () => sd.buildAllPlatforms());
|
|
63
64
|
else {
|
|
64
|
-
|
|
65
|
-
const
|
|
66
|
-
if (unknown.length > 0) throw new Error(`${describeConfig(item, index)} does not define the platform(s) ${unknown.join(", ")}. It defines ${defined.join(", ")}.`);
|
|
67
|
-
for (const name of selectedPlatforms) await sd.buildPlatform(name);
|
|
65
|
+
checkSelection(item, index, selectedPlatforms, sd.platforms);
|
|
66
|
+
for (const name of selectedPlatforms) await namingConfig(item, index, async () => sd.buildPlatform(name));
|
|
68
67
|
}
|
|
69
68
|
for (const platform of Object.values(sd.platforms)) for (const file of platform.files ?? []) if (file.destination) generatedFiles.add(writtenDestination(platform.buildPath, file.destination));
|
|
70
69
|
if (fingerprint !== null) for (const destination of writing) {
|
|
@@ -79,7 +78,8 @@ async function runBuilds(instance, resolvedConfigs, context) {
|
|
|
79
78
|
generatedDestinations.clear();
|
|
80
79
|
for (const destination of generatedFiles) generatedDestinations.add(destination.replace(/\\/g, "/"));
|
|
81
80
|
} catch (err) {
|
|
82
|
-
|
|
81
|
+
const duration = Date.now() - startTime;
|
|
82
|
+
log(context ? `Compilation failed after a change in ${context} (${duration}ms): ${errorMessage(err)}` : `Compilation failed after ${duration}ms: ${errorMessage(err)}`, "error");
|
|
83
83
|
notifyBuildOutcome(asError(err));
|
|
84
84
|
if (onBuildError) callHook(log, "onBuildError", onBuildError, err);
|
|
85
85
|
if (failsTheBuild(failOnError, context)) throw err;
|
|
@@ -94,10 +94,10 @@ async function runBuilds(instance, resolvedConfigs, context) {
|
|
|
94
94
|
return;
|
|
95
95
|
}
|
|
96
96
|
if (report && !quiet && !everythingSkipped && generatedFiles.size > 0) try {
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
}, generatedFiles);
|
|
97
|
+
logTable((colour) => sizeTable({
|
|
98
|
+
colour,
|
|
99
|
+
root
|
|
100
|
+
}, generatedFiles));
|
|
101
101
|
} catch (err) {
|
|
102
102
|
log(`Failed to report generated file sizes: ${errorMessage(err)}`, "error");
|
|
103
103
|
}
|
|
@@ -120,12 +120,25 @@ function callHook(log, name, hook, ...args) {
|
|
|
120
120
|
log(`The ${name} hook rejected: ${errorMessage(err)}`, "error");
|
|
121
121
|
});
|
|
122
122
|
}
|
|
123
|
+
function checkSelection(item, index, selected, platforms) {
|
|
124
|
+
if (selected === void 0) return;
|
|
125
|
+
const defined = Object.keys(platforms ?? {});
|
|
126
|
+
const unknown = selected.filter((name) => !defined.includes(name));
|
|
127
|
+
if (unknown.length > 0) throw new Error(`${describeConfig(item, index)} does not define the platform(s) ${unknown.join(", ")}. It defines ${defined.join(", ")}.`);
|
|
128
|
+
}
|
|
123
129
|
function failsTheBuild(failOnError, context) {
|
|
124
130
|
return failOnError === true || (context === void 0 ? failOnError === "build" : failOnError === "serve");
|
|
125
131
|
}
|
|
126
132
|
function isThenable(value) {
|
|
127
133
|
return typeof value === "object" && value !== null && "then" in value && typeof value.then === "function";
|
|
128
134
|
}
|
|
135
|
+
async function namingConfig(item, index, step) {
|
|
136
|
+
try {
|
|
137
|
+
return await step();
|
|
138
|
+
} catch (err) {
|
|
139
|
+
throw new Error(`${describeConfig(item, index)} failed: ${errorMessage(err)}`, { cause: err });
|
|
140
|
+
}
|
|
141
|
+
}
|
|
129
142
|
function notingWrites(volume, into) {
|
|
130
143
|
const note = (file) => {
|
|
131
144
|
if (typeof file === "string") into.add(path.resolve(file));
|
package/dist/compile.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"compile.js","names":[],"sources":["../src/compile.ts"],"sourcesContent":["// One compile of every resolved configuration: building each one through the\n// atomic volume, recording what it wrote, and saying how it went.\n//\n// Nothing here holds state. What a plugin instance owns is handed in as a\n// `PluginInstance`, which the factory builds once, and the two parts of it\n// that are assigned after the factory has run — `root` and the overlay\n// callback — are reached through it when a compile runs rather than copied\n// when it was built.\n\nimport fs from 'node:fs'\nimport path from 'node:path'\nimport StyleDictionary from 'style-dictionary'\n\nimport type { ResolvedConfig } from './config.js'\nimport type { UnpluginStyleDictionaryOptions } from './types.js'\nimport type { DestinationRecord } from './up-to-date.js'\n\nimport { configForBuild, describeConfig, readConfigObject } from './config.js'\nimport { asError, errorMessage } from './errors.js'\nimport { patternsMatchingNothing, sourcePatternsOf } from './patterns.js'\nimport { reportSizes } from './size-report.js'\nimport {\n configFingerprint,\n declaredDestinations,\n isUpToDate,\n newestSourceOf,\n readPersistedRecords,\n recordOf,\n recordsFileFor,\n writePersistedRecords,\n writtenDestination,\n} from './up-to-date.js'\n\n// What `runBuilds` reads from the plugin instance it compiles for.\n//\n// `root` and `notifyBuildOutcome` are functions for the same reason: each is\n// assigned after the factory has run — `root` by `adoptCompiler` or\n// `configResolved`, the overlay callback by `configureServer` — so a value\n// copied when this was built would be the working directory and `undefined`\n// for good. `generatedDestinations` is the instance's own record of what it\n// wrote, and `destinationRecords` is the process's record of which\n// configuration last wrote each file and what it read, with\n// `persistedRecordFiles` naming the file each root's copy persists to;\n// none of them lives here.\nexport interface PluginInstance {\n cache: boolean\n destinationRecords: Map<string, DestinationRecord>\n failOnError: NonNullable<UnpluginStyleDictionaryOptions['failOnError']>\n generatedDestinations: Set<string>\n log: (message: string, type: 'error' | 'info' | 'success') => void\n notifyBuildOutcome: (error: Error | null) => void\n onBuildEnd: UnpluginStyleDictionaryOptions['onBuildEnd']\n onBuildError: UnpluginStyleDictionaryOptions['onBuildError']\n onBuildStart: UnpluginStyleDictionaryOptions['onBuildStart']\n persistedRecordFiles: Map<string, string>\n platformsOption: UnpluginStyleDictionaryOptions['platforms']\n quiet: boolean\n report: boolean\n root: () => string\n stdoutColour: boolean\n verbosity: 'default' | 'silent' | 'verbose' | undefined\n volume: typeof fs\n watch: UnpluginStyleDictionaryOptions['watch']\n}\n\n// Compile design tokens\nexport async function runBuilds(\n instance: PluginInstance,\n resolvedConfigs: ResolvedConfig[],\n context?: string,\n): Promise<void> {\n const {\n cache,\n destinationRecords,\n failOnError,\n generatedDestinations,\n log,\n notifyBuildOutcome,\n onBuildEnd,\n onBuildError,\n onBuildStart,\n persistedRecordFiles,\n platformsOption,\n quiet,\n report,\n stdoutColour,\n verbosity,\n volume,\n watch,\n } = instance\n\n // Read when this compile starts rather than when the instance was built,\n // because the host assigns it after the factory has run.\n const root = instance.root()\n\n const startTime = Date.now()\n\n // Ahead of the `try` rather than inside it, because the reporting below\n // reads it and that reporting is deliberately outside.\n const generatedFiles = new Set<string>()\n\n // How many configurations were already up to date. Read by the reporting\n // below, which is why it sits out here with `generatedFiles`.\n let skipped = 0\n\n // The records an earlier process persisted for this root, loaded the first\n // time this process compiles for it and never over a record this process\n // wrote itself. Only with `cache` on, the one case that reads or keeps\n // them: every other build compiles regardless.\n let recordsFile = cache ? persistedRecordFiles.get(root) : undefined\n if (cache && recordsFile === undefined) {\n recordsFile = recordsFileFor(root)\n persistedRecordFiles.set(root, recordsFile)\n for (const [destination, record] of readPersistedRecords(recordsFile)) {\n if (!destinationRecords.has(destination)) {\n destinationRecords.set(destination, record)\n }\n }\n }\n\n // What this compile recorded, and so what it adds to the persisted copy.\n const recorded = new Map<string, DestinationRecord>()\n\n try {\n if (!context) {\n log('Compiling design tokens...', 'info')\n }\n\n // Before anything is resolved or built, and once per build — a watch\n // rebuild is a build, so this fires again for each one.\n if (onBuildStart) callHook(log, 'onBuildStart', onBuildStart)\n\n // Configurations are built one after another rather than with\n // `Promise.all`, and that is load-bearing. Two configurations may name\n // the same destination file, and each instance gets the atomic volume\n // swapped onto it below — overlapping builds would interleave those\n // writes and hand a reader a file assembled from both.\n for (const [index, item] of resolvedConfigs.entries()) {\n // Read ahead of the instance, because avoiding the instance is the\n // point: construction plus `extend` is the 15-30% of a build that\n // parses the token sources, and `buildAllPlatforms` is the rest.\n //\n // Without a `report`, so a configuration that will not parse says\n // nothing here — the build below hands Style Dictionary the path and\n // lets its own message through, which is more specific than anything\n // this could say.\n const declared = cache ? await readConfigObject(item) : null\n const selectedPlatforms = platformsFor(platformsOption, context)\n\n // What this configuration reads, as it stands before the compile below\n // reads any of it. The up-to-date check needs it now, and the record\n // needs it afterwards: it is what the next check measures \"changed\n // since\" against. Only asked with `cache` on, the one case that reads it.\n const newestSource = declared\n ? await newestSourceOf({ log, root, watch }, item, declared)\n : null\n\n // Who this configuration is: its contents, the hooks it names as the\n // registry holds them now, and the Style Dictionary version. Taken here,\n // after the `config` function's `register*` calls have landed, and once:\n // the check compares it with each destination's record, and the record\n // keeps it. Only with `cache` on, because nothing compares it otherwise\n // and reading a configuration module to compute it would run it again.\n const fingerprint = declared\n ? configFingerprint(root, item, declared)\n : null\n\n if (\n declared &&\n isUpToDate(\n { destinationRecords, fingerprint, newestSource },\n item,\n declared,\n selectedPlatforms,\n )\n ) {\n // The destinations still have to be collected. They are what stops\n // the plugin's own output being treated as a watched source, so a\n // skipped configuration that contributed none would have its files\n // rebuild the moment a watcher noticed them.\n for (const destination of declaredDestinations(declared)) {\n generatedFiles.add(destination)\n }\n\n skipped++\n continue\n }\n\n // `{ init: false }` is the escape hatch Style Dictionary documents on\n // this constructor, and it is what makes a bad configuration\n // catchable. Left to itself the constructor ends in a call to\n // `init()` whose promise it neither stores nor returns, so a config\n // that fails to load rejects a promise nobody holds: the `catch`\n // below never runs, and the host dies with a raw stack or — where an\n // `unhandledRejection` handler suppresses it — hangs on a\n // `buildStart` that never settles. `await sd.hasInitialized` cannot\n // observe it either, since that promise is only ever resolved, at the\n // tail of a successful extend.\n //\n // It is handed the configuration as an object rather than as a path\n // for the same reason: Style Dictionary imports a path with no\n // cache-busting query of its own, so under a long-lived dev server\n // every rebuild after the first built the config the process started\n // with while the watch list followed the edit.\n const sd = new StyleDictionary(await configForBuild(item), {\n init: false,\n })\n\n // One initialisation rather than two. `init()` is `extend()` with\n // `mutateOriginal`, so the old pair loaded the configuration and\n // combined every source twice — running a custom parser or\n // preprocessor twice with it — and the first of the two ran at\n // default verbosity, which is how Style Dictionary's own warnings\n // escaped this plugin's `silent`. `config` defaults to the one the\n // constructor was handed.\n //\n // `verbosity` is `undefined` unless a consumer asked for a level, and\n // Style Dictionary falls through an unset one to the configuration's\n // own `log.verbosity`. Overwriting it here is what silenced the one\n // line explaining why a build wrote nothing. `log.warnings` is not\n // touched either way: a consumer's `warnings: 'error'` turning a\n // missing output file into a thrown build is their decision.\n await sd.extend(undefined, { mutateOriginal: true, verbosity })\n\n // **Before the build, and that is the whole of it.** A token set that\n // resolved to nothing is not an error anywhere in this stack: Style\n // Dictionary writes the file with no custom properties in it, prints\n // its usual `✔︎` line at any verbosity, and returns. So a token file\n // deleted mid-session took the generated output down with it and\n // reported `Rebuilt design tokens` while doing it, and a `source`\n // matching nothing shipped an empty stylesheet from a build that\n // exited 0.\n //\n // Checked here because `buildAllPlatforms` truncates and rewrites the\n // destination: one line later the previous good output is already gone\n // and an error would be accurate and useless.\n if (sd.allTokens.length === 0) {\n // The configuration as an object, so its own patterns can be named.\n // Without a `report`, because a configuration that will not parse\n // never reaches here — the `extend` above would have thrown first.\n const asObject = await readConfigObject(item)\n const barren = asObject\n ? await patternsMatchingNothing(sourcePatternsOf(asObject))\n : []\n\n // Thrown rather than reported, so it takes the path `failOnError`\n // already owns — the same decision, made in one place, rather than a\n // second way for a build to fail.\n throw new Error(\n [\n `${describeConfig(item, index)} resolved no tokens, so its output would be emptied.`,\n barren.length > 0\n ? `These patterns matched no files: ${barren.join(', ')}`\n : `It declares no source or include patterns that matched anything.`,\n `Nothing was written. Set failOnError to false to build anyway.`,\n ].join(' '),\n )\n }\n\n // Swap in the atomic volume only now that the instance has finished\n // reading its configs and token sources, so every write below lands\n // through `rename` while the read path stays exactly as it was. Seen\n // through a layer that notes what this build writes, which the record\n // below needs: a declared file is not necessarily a written one.\n const wrote = new Set<string>()\n sd.volume = notingWrites(volume, wrote)\n\n // The files this compile is about to write, named exactly as the\n // up-to-date check names them, and only the selected platforms' — a\n // scoped build leaves the others' files, and whatever wrote them, alone.\n const writing = declaredDestinations(\n { platforms: sd.platforms },\n selectedPlatforms,\n )\n\n // Forgotten before the first write rather than overwritten after the\n // last, because a build that throws partway has already replaced some\n // of these files. A record left standing would vouch for output that\n // no longer matches the configuration it names.\n for (const destination of writing) {\n destinationRecords.delete(destination)\n }\n\n if (selectedPlatforms === undefined) {\n await sd.buildAllPlatforms()\n } else {\n // Named, so a typo is an error rather than a platform silently not\n // built — which is what Style Dictionary's own CLI means by \"Must be\n // defined in the config\".\n const defined = Object.keys(sd.platforms)\n const unknown = selectedPlatforms.filter(\n (name) => !defined.includes(name),\n )\n if (unknown.length > 0) {\n throw new Error(\n `${describeConfig(item, index)} does not define the platform(s) ${unknown.join(', ')}. It defines ${defined.join(', ')}.`,\n )\n }\n\n // One after another, matching the loop this sits inside: two\n // platforms may name the same destination, and `buildAllPlatforms`\n // fanning its own out with `Promise.all` is Style Dictionary's\n // choice over configurations it owns, not this plugin's over a\n // selection a consumer wrote.\n for (const name of selectedPlatforms) {\n await sd.buildPlatform(name)\n }\n }\n\n // Every declared platform, not only the ones this compile built. A\n // file an unselected platform wrote on an earlier build is still the\n // plugin's own output, and dropping it from this set would let a\n // watcher treat it as a token source and rebuild on it forever.\n //\n // Collected on every build rather than only on the ones whose size\n // report prints it below. The set is also what keeps a rebuild from\n // being triggered by the write it just made, and a rebuild passes a\n // `context` — so gating the collection on `!context` left it empty on\n // exactly the builds a watcher is live for.\n //\n // Named by `writtenDestination`, the one place that knows where Style\n // Dictionary writes a file. Every copy of that rule this code has had\n // named files that were never written — against `root` until #362, and\n // an absolute destination until #367 — and handed them to `onBuildEnd`,\n // the size report and this very set.\n for (const platform of Object.values(sd.platforms)) {\n for (const file of platform.files ?? []) {\n if (file.destination) {\n generatedFiles.add(\n writtenDestination(platform.buildPath, file.destination),\n )\n }\n }\n }\n\n // Recorded only now, so a build that threw vouches for none of what it\n // wrote before throwing. Every configuration is recorded, a file-backed\n // one included: an object configuration naming the same file has to\n // see that something else wrote it last.\n //\n // `newestSource` goes in beside the fingerprint. It was taken before\n // this compile read anything, so a source saved while it ran is newer\n // than it, and the rebuild queued for that save is not skipped. So does\n // each file's mtime as this compile left it, byte-identical skip and\n // all: a later check trusts the record only while the file still has\n // it. A file Style Dictionary declined to write is recorded as such, so\n // a later check does not go looking for it; one it wrote and that is\n // already gone gets no record, so the next build compiles.\n //\n // Only a compile with `cache` on has a fingerprint to record. One with it\n // off has still forgotten what it rewrote, above, which is what keeps\n // every other instance from vouching for its output.\n if (fingerprint !== null) {\n for (const destination of writing) {\n const record = recordOf(\n destination,\n fingerprint,\n newestSource,\n wrote.has(destination),\n )\n if (record) {\n destinationRecords.set(destination, record)\n recorded.set(destination, record)\n }\n }\n }\n }\n\n // Replaced wholesale rather than added to, so a destination dropped from\n // a configuration stops being treated as ours and becomes watchable\n // again. A build that throws never reaches this and leaves the previous\n // set standing, which is the safe direction: the files it wrote before\n // failing are still ours.\n // Once per compile rather than per configuration, and only after every\n // configuration succeeded. A compile that throws persists nothing, which\n // is safe: whatever it rewrote no longer has the mtime its old record\n // names, so that record vouches for nothing.\n if (recordsFile !== undefined && recorded.size > 0) {\n writePersistedRecords(recordsFile, recorded)\n }\n\n generatedDestinations.clear()\n for (const destination of generatedFiles) {\n generatedDestinations.add(destination.replace(/\\\\/g, '/'))\n }\n } catch (err) {\n const duration = Date.now() - startTime\n log(`Compilation failed after ${duration}ms: ${errorMessage(err)}`, 'error')\n\n // Ahead of the throw decision on purpose, so the overlay sees a failure\n // whatever `failOnError` does with it. Under the dev server's default\n // the line below does not throw, and reading the outcome from a caller's\n // `catch` would see a rebuild that looked like it succeeded.\n notifyBuildOutcome(asError(err))\n\n // Ahead of the throw decision for the same reason as the line above: a\n // rebuild under the dev server's default does not throw, and a hook that\n // only fired when something else was about to fail would be silent on\n // exactly the builds a consumer is watching.\n if (onBuildError) callHook(log, 'onBuildError', onBuildError, err)\n\n // Reported, and then rethrown so the host stops. Swallowing it left\n // every target exiting 0 with the previous run's tokens still on disk\n // and in the bundle — a green build shipping stale values.\n if (failsTheBuild(failOnError, context)) throw err\n\n // Explicit, now that the reporting below sits outside the `try`. This\n // `catch` used to end the function by falling off the end of it; a\n // failure that is not rethrown would otherwise carry on to announce a\n // compile that did not happen.\n return\n }\n\n // The compile is what the overlay reflects, so this is said here rather\n // than at the end: everything below is reporting, it returns early in\n // three places, and a size table that throws must not leave a successful\n // build looking unfinished.\n notifyBuildOutcome(null)\n\n // One measurement, read by the hook below and by the reporting under it.\n const duration = Date.now() - startTime\n\n // Beside the overlay notification, and for the same reason it sits here\n // rather than at the end of the function: the reporting below returns\n // early in three places, and a build that finished has finished whether or\n // not a size table gets printed for it.\n //\n // Sorted, so two runs of one configuration hand back the same order —\n // `generatedFiles` is a set in platform-then-file order, which is stable\n // in practice and guaranteed by nothing. The paths stay platform-native:\n // this is a list a consumer is going to open files with, not one the\n // watcher compares against.\n //\n // Only the declared files that are on disk. One whose filter matched no\n // tokens is declared and never written, and a hook opening it got an ENOENT.\n if (onBuildEnd) {\n // `toSorted` is what the linter asks for and what this cannot use:\n // `lib` is ES2022 here and `toSorted` is ES2023, so it types as an error\n // even though every Node this package supports has it. The rule guards\n // against mutating an array someone else holds, and this one was built\n // from the set on the line it appears on.\n const files = Array.from(generatedFiles)\n .filter((file) => fs.existsSync(file))\n // oxlint-disable-next-line unicorn/no-array-sort\n .sort((left, right) => left.localeCompare(right))\n callHook(log, 'onBuildEnd', onBuildEnd, files, duration)\n }\n\n // The `try` ends above, and everything from here down is reporting. Style\n // Dictionary has finished writing by now and `generatedDestinations` is\n // already replaced, so nothing below can put a file on disk in doubt —\n // which is why a throw from it must not be caught as a compile failure.\n // It used to be: a fault in the padding arithmetic printed `Compilation\n // failed after 19ms` over a build whose every token file was correct, and\n // with `failOnError` defaulting to `'build'` that stopped the bundler.\n\n // Every configuration was already current, so nothing was written. Said\n // rather than left implied: a build that prints its opening line and then\n // finishes in two milliseconds reads as one that silently did nothing.\n const everythingSkipped = skipped === resolvedConfigs.length\n\n if (context) {\n log(\n everythingSkipped\n ? `Design tokens already up to date after change in ${context} (${duration}ms)`\n : `Rebuilt design tokens due to change in ${context} (${duration}ms)`,\n 'success',\n )\n return\n }\n\n // The table is skipped when nothing was written, on top of `report` and\n // `quiet`. It reads every generated file in full and gzips it, and\n // reprinting the sizes of files this build did not touch is the one case\n // where that cost buys nothing at all.\n if (report && !quiet && !everythingSkipped && generatedFiles.size > 0) {\n try {\n reportSizes({ root, stdoutColour }, generatedFiles)\n } catch (err) {\n // At `'error'`, so it is said at every level including `silent`,\n // exactly as a compile failure is — and worded so it cannot be read\n // as one. Not rethrown: the build succeeded.\n log(\n `Failed to report generated file sizes: ${errorMessage(err)}`,\n 'error',\n )\n }\n }\n\n if (everythingSkipped) {\n log(`Design tokens are already up to date (${duration}ms)`, 'success')\n return\n }\n\n log(\n skipped > 0\n ? `Compiled successfully! (${duration}ms, ${skipped} already up to date)`\n : `Compiled successfully! (${duration}ms)`,\n 'success',\n )\n}\n\n// Runs one of the consumer's `onBuild*` hooks without letting it decide the\n// fate of the build that called it.\n//\n// Two ways a hook can go wrong, and neither may propagate. A throw is caught\n// here, because a post-processing step that fails must not undo a compile the\n// plugin itself completed — the files are written and correct. A rejected\n// promise is the quieter one: the return value is deliberately not awaited,\n// so a rejection has nothing holding it and reaches the host as an unhandled\n// rejection, which under Node's default takes the process down — a dev server\n// killed from inside a hook that was only meant to reformat a file.\n//\n// Both are reported at `'error'`, so they are said at every level including\n// `silent`, and worded so neither can be read as the compile having failed.\nfunction callHook<A extends unknown[]>(\n log: PluginInstance['log'],\n name: string,\n hook: (...args: A) => Promise<void> | void,\n ...args: A\n): void {\n let result: unknown\n\n try {\n // Captured rather than dropped, because the promise an `async` hook\n // returns is the thing the check below needs. Wrapping this call in a\n // block-bodied arrow — which is what the linter asks for when the return\n // type is plain `void` — discarded it, and the rejection escaped exactly\n // as it had before any of this existed.\n result = hook(...args)\n } catch (err) {\n log(`The ${name} hook threw: ${errorMessage(err)}`, 'error')\n return\n }\n\n if (!isThenable(result)) return\n\n void Promise.resolve(result).catch((err: unknown) => {\n log(`The ${name} hook rejected: ${errorMessage(err)}`, 'error')\n })\n}\n\n// Whether a failure in this compile should be thrown rather than only\n// reported. The two compiles are told apart by `runBuilds`'s `context`,\n// which only the rebuild paths pass.\nfunction failsTheBuild(\n failOnError: NonNullable<UnpluginStyleDictionaryOptions['failOnError']>,\n context: string | undefined,\n): boolean {\n return (\n failOnError === true ||\n (context === undefined ? failOnError === 'build' : failOnError === 'serve')\n )\n}\n\n// A hook is the consumer's code, and what it hands back is not this plugin's to\n// assume. A predicate rather than `instanceof Promise`, which answers `false`\n// for a thenable from another realm or from a promise library — exactly the\n// case where letting a rejection escape does the damage.\nfunction isThenable(value: unknown): value is PromiseLike<unknown> {\n return (\n typeof value === 'object' &&\n value !== null &&\n 'then' in value &&\n typeof value.then === 'function'\n )\n}\n\n// `volume`, with every path Style Dictionary writes through it noted in\n// `into`, resolved as `writtenDestination` resolves a declared one. Each file\n// a build writes reaches `promises.writeFile` (`buildPlatform` in\n// `lib/StyleDictionary.js`) — a byte-identical one included, since the atomic\n// writer decides to skip the rename only once it has been handed the file — so\n// `into` ends up holding exactly what the build wrote, and a file it declined\n// to write never appears in it. Built per compile, over the atomic volume\n// rather than in place of it.\n//\n// The sync writer is inherited untouched. Only an action reaches it, a\n// configuration with actions is never skipped, and `tests/index.test.ts`\n// checks that an action is handed the atomic writer itself.\nfunction notingWrites(volume: typeof fs, into: Set<string>): typeof fs {\n const note = (file: unknown) => {\n if (typeof file === 'string') into.add(path.resolve(file))\n }\n\n /* oxlint-disable typescript/no-unsafe-type-assertion */\n return Object.create(volume, {\n promises: {\n value: Object.create(volume.promises, {\n writeFile: {\n value: async (...args: Parameters<typeof fs.promises.writeFile>) => {\n note(args[0])\n await volume.promises.writeFile(...args)\n },\n },\n }) as typeof fs.promises,\n },\n }) as typeof fs\n /* oxlint-enable typescript/no-unsafe-type-assertion */\n}\n\n// Which platforms this compile covers, or `undefined` for all of them.\n//\n// The array form applies to every build; the object form splits the first\n// compile from the watch rebuilds, and `context` is what tells them apart —\n// only the rebuild paths pass one. An absent key means every platform, so\n// `{ watch: ['css'] }` builds everything once and then only css.\nfunction platformsFor(\n platformsOption: UnpluginStyleDictionaryOptions['platforms'],\n context: string | undefined,\n): string[] | undefined {\n if (platformsOption === undefined) return undefined\n if (Array.isArray(platformsOption)) return platformsOption\n\n return context === undefined ? platformsOption.build : platformsOption.watch\n}\n"],"mappings":";;;;;;;;;AAkEA,eAAsB,UACpB,UACA,iBACA,SACe;CACf,MAAM,EACJ,OACA,oBACA,aACA,uBACA,KACA,oBACA,YACA,cACA,cACA,sBACA,iBACA,OACA,QACA,cACA,WACA,QACA,UACE;CAIJ,MAAM,OAAO,SAAS,KAAK;CAE3B,MAAM,YAAY,KAAK,IAAI;CAI3B,MAAM,iCAAiB,IAAI,IAAY;CAIvC,IAAI,UAAU;CAMd,IAAI,cAAc,QAAQ,qBAAqB,IAAI,IAAI,IAAI,KAAA;CAC3D,IAAI,SAAS,gBAAgB,KAAA,GAAW;EACtC,cAAc,eAAe,IAAI;EACjC,qBAAqB,IAAI,MAAM,WAAW;EAC1C,KAAK,MAAM,CAAC,aAAa,WAAW,qBAAqB,WAAW,GAClE,IAAI,CAAC,mBAAmB,IAAI,WAAW,GACrC,mBAAmB,IAAI,aAAa,MAAM;CAGhD;CAGA,MAAM,2BAAW,IAAI,IAA+B;CAEpD,IAAI;EACF,IAAI,CAAC,SACH,IAAI,8BAA8B,MAAM;EAK1C,IAAI,cAAc,SAAS,KAAK,gBAAgB,YAAY;EAO5D,KAAK,MAAM,CAAC,OAAO,SAAS,gBAAgB,QAAQ,GAAG;GASrD,MAAM,WAAW,QAAQ,MAAM,iBAAiB,IAAI,IAAI;GACxD,MAAM,oBAAoB,aAAa,iBAAiB,OAAO;GAM/D,MAAM,eAAe,WACjB,MAAM,eAAe;IAAE;IAAK;IAAM;GAAM,GAAG,MAAM,QAAQ,IACzD;GAQJ,MAAM,cAAc,WAChB,kBAAkB,MAAM,MAAM,QAAQ,IACtC;GAEJ,IACE,YACA,WACE;IAAE;IAAoB;IAAa;GAAa,GAChD,MACA,UACA,iBACF,GACA;IAKA,KAAK,MAAM,eAAe,qBAAqB,QAAQ,GACrD,eAAe,IAAI,WAAW;IAGhC;IACA;GACF;GAkBA,MAAM,KAAK,IAAI,gBAAgB,MAAM,eAAe,IAAI,GAAG,EACzD,MAAM,MACR,CAAC;GAgBD,MAAM,GAAG,OAAO,KAAA,GAAW;IAAE,gBAAgB;IAAM;GAAU,CAAC;GAc9D,IAAI,GAAG,UAAU,WAAW,GAAG;IAI7B,MAAM,WAAW,MAAM,iBAAiB,IAAI;IAC5C,MAAM,SAAS,WACX,MAAM,wBAAwB,iBAAiB,QAAQ,CAAC,IACxD,CAAC;IAKL,MAAM,IAAI,MACR;KACE,GAAG,eAAe,MAAM,KAAK,EAAE;KAC/B,OAAO,SAAS,IACZ,oCAAoC,OAAO,KAAK,IAAI,MACpD;KACJ;IACF,CAAC,CAAC,KAAK,GAAG,CACZ;GACF;GAOA,MAAM,wBAAQ,IAAI,IAAY;GAC9B,GAAG,SAAS,aAAa,QAAQ,KAAK;GAKtC,MAAM,UAAU,qBACd,EAAE,WAAW,GAAG,UAAU,GAC1B,iBACF;GAMA,KAAK,MAAM,eAAe,SACxB,mBAAmB,OAAO,WAAW;GAGvC,IAAI,sBAAsB,KAAA,GACxB,MAAM,GAAG,kBAAkB;QACtB;IAIL,MAAM,UAAU,OAAO,KAAK,GAAG,SAAS;IACxC,MAAM,UAAU,kBAAkB,QAC/B,SAAS,CAAC,QAAQ,SAAS,IAAI,CAClC;IACA,IAAI,QAAQ,SAAS,GACnB,MAAM,IAAI,MACR,GAAG,eAAe,MAAM,KAAK,EAAE,mCAAmC,QAAQ,KAAK,IAAI,EAAE,eAAe,QAAQ,KAAK,IAAI,EAAE,EACzH;IAQF,KAAK,MAAM,QAAQ,mBACjB,MAAM,GAAG,cAAc,IAAI;GAE/B;GAkBA,KAAK,MAAM,YAAY,OAAO,OAAO,GAAG,SAAS,GAC/C,KAAK,MAAM,QAAQ,SAAS,SAAS,CAAC,GACpC,IAAI,KAAK,aACP,eAAe,IACb,mBAAmB,SAAS,WAAW,KAAK,WAAW,CACzD;GAsBN,IAAI,gBAAgB,MAClB,KAAK,MAAM,eAAe,SAAS;IACjC,MAAM,SAAS,SACb,aACA,aACA,cACA,MAAM,IAAI,WAAW,CACvB;IACA,IAAI,QAAQ;KACV,mBAAmB,IAAI,aAAa,MAAM;KAC1C,SAAS,IAAI,aAAa,MAAM;IAClC;GACF;EAEJ;EAWA,IAAI,gBAAgB,KAAA,KAAa,SAAS,OAAO,GAC/C,sBAAsB,aAAa,QAAQ;EAG7C,sBAAsB,MAAM;EAC5B,KAAK,MAAM,eAAe,gBACxB,sBAAsB,IAAI,YAAY,QAAQ,OAAO,GAAG,CAAC;CAE7D,SAAS,KAAK;EAEZ,IAAI,4BADa,KAAK,IAAI,IAAI,UACW,MAAM,aAAa,GAAG,KAAK,OAAO;EAM3E,mBAAmB,QAAQ,GAAG,CAAC;EAM/B,IAAI,cAAc,SAAS,KAAK,gBAAgB,cAAc,GAAG;EAKjE,IAAI,cAAc,aAAa,OAAO,GAAG,MAAM;EAM/C;CACF;CAMA,mBAAmB,IAAI;CAGvB,MAAM,WAAW,KAAK,IAAI,IAAI;CAe9B,IAAI,YAUF,SAAS,KAAK,cAAc,YAJd,MAAM,KAAK,cAAc,CAAC,CACrC,QAAQ,SAAS,GAAG,WAAW,IAAI,CAAC,CAAC,CAErC,MAAM,MAAM,UAAU,KAAK,cAAc,KAAK,CACL,GAAG,QAAQ;CAczD,MAAM,oBAAoB,YAAY,gBAAgB;CAEtD,IAAI,SAAS;EACX,IACE,oBACI,oDAAoD,QAAQ,IAAI,SAAS,OACzE,0CAA0C,QAAQ,IAAI,SAAS,MACnE,SACF;EACA;CACF;CAMA,IAAI,UAAU,CAAC,SAAS,CAAC,qBAAqB,eAAe,OAAO,GAClE,IAAI;EACF,YAAY;GAAE;GAAM;EAAa,GAAG,cAAc;CACpD,SAAS,KAAK;EAIZ,IACE,0CAA0C,aAAa,GAAG,KAC1D,OACF;CACF;CAGF,IAAI,mBAAmB;EACrB,IAAI,yCAAyC,SAAS,MAAM,SAAS;EACrE;CACF;CAEA,IACE,UAAU,IACN,2BAA2B,SAAS,MAAM,QAAQ,wBAClD,2BAA2B,SAAS,MACxC,SACF;AACF;AAeA,SAAS,SACP,KACA,MACA,MACA,GAAG,MACG;CACN,IAAI;CAEJ,IAAI;EAMF,SAAS,KAAK,GAAG,IAAI;CACvB,SAAS,KAAK;EACZ,IAAI,OAAO,KAAK,eAAe,aAAa,GAAG,KAAK,OAAO;EAC3D;CACF;CAEA,IAAI,CAAC,WAAW,MAAM,GAAG;CAEzB,QAAa,QAAQ,MAAM,CAAC,CAAC,OAAO,QAAiB;EACnD,IAAI,OAAO,KAAK,kBAAkB,aAAa,GAAG,KAAK,OAAO;CAChE,CAAC;AACH;AAKA,SAAS,cACP,aACA,SACS;CACT,OACE,gBAAgB,SACf,YAAY,KAAA,IAAY,gBAAgB,UAAU,gBAAgB;AAEvE;AAMA,SAAS,WAAW,OAA+C;CACjE,OACE,OAAO,UAAU,YACjB,UAAU,QACV,UAAU,SACV,OAAO,MAAM,SAAS;AAE1B;AAcA,SAAS,aAAa,QAAmB,MAA8B;CACrE,MAAM,QAAQ,SAAkB;EAC9B,IAAI,OAAO,SAAS,UAAU,KAAK,IAAI,KAAK,QAAQ,IAAI,CAAC;CAC3D;CAGA,OAAO,OAAO,OAAO,QAAQ,EAC3B,UAAU,EACR,OAAO,OAAO,OAAO,OAAO,UAAU,EACpC,WAAW,EACT,OAAO,OAAO,GAAG,SAAmD;EAClE,KAAK,KAAK,EAAE;EACZ,MAAM,OAAO,SAAS,UAAU,GAAG,IAAI;CACzC,EACF,EACF,CAAC,EACH,EACF,CAAC;AAEH;AAQA,SAAS,aACP,iBACA,SACsB;CACtB,IAAI,oBAAoB,KAAA,GAAW,OAAO,KAAA;CAC1C,IAAI,MAAM,QAAQ,eAAe,GAAG,OAAO;CAE3C,OAAO,YAAY,KAAA,IAAY,gBAAgB,QAAQ,gBAAgB;AACzE"}
|
|
1
|
+
{"version":3,"file":"compile.js","names":[],"sources":["../src/compile.ts"],"sourcesContent":["// One compile of every resolved configuration: building each one through the\n// atomic volume, recording what it wrote, and saying how it went.\n//\n// Nothing here holds state. What a plugin instance owns is handed in as a\n// `PluginInstance`, which the factory builds once, and the two parts of it\n// that are assigned after the factory has run — `root` and the overlay\n// callback — are reached through it when a compile runs rather than copied\n// when it was built.\n\nimport fs from 'node:fs'\nimport path from 'node:path'\nimport StyleDictionary from 'style-dictionary'\n\nimport type { ResolvedConfig } from './config.js'\nimport type { UnpluginStyleDictionaryOptions } from './types.js'\nimport type { DestinationRecord } from './up-to-date.js'\n\nimport { configForBuild, describeConfig, readConfigObject } from './config.js'\nimport { asError, errorMessage } from './errors.js'\nimport { patternsMatchingNothing, sourcePatternsOf } from './patterns.js'\nimport { sizeTable } from './size-report.js'\nimport {\n configFingerprint,\n declaredDestinations,\n isUpToDate,\n newestSourceOf,\n readPersistedRecords,\n recordOf,\n recordsFileFor,\n writePersistedRecords,\n writtenDestination,\n} from './up-to-date.js'\n\n// What `runBuilds` reads from the plugin instance it compiles for.\n//\n// `root` and `notifyBuildOutcome` are functions for the same reason: each is\n// assigned after the factory has run — `root` by `adoptCompiler` or\n// `configResolved`, the overlay callback by `configureServer` — so a value\n// copied when this was built would be the working directory and `undefined`\n// for good. `log` and `logTable` read the message host when they are called,\n// for the same reason. `generatedDestinations` is the instance's own record of what it\n// wrote, and `destinationRecords` is the process's record of which\n// configuration last wrote each file and what it read, with\n// `persistedRecordFiles` naming the file each root's copy persists to;\n// none of them lives here.\nexport interface PluginInstance {\n cache: boolean\n destinationRecords: Map<string, DestinationRecord>\n failOnError: NonNullable<UnpluginStyleDictionaryOptions['failOnError']>\n generatedDestinations: Set<string>\n log: (message: string, type: 'error' | 'info' | 'success') => void\n logTable: (render: (colour: boolean) => string[]) => void\n notifyBuildOutcome: (error: Error | null) => void\n onBuildEnd: UnpluginStyleDictionaryOptions['onBuildEnd']\n onBuildError: UnpluginStyleDictionaryOptions['onBuildError']\n onBuildStart: UnpluginStyleDictionaryOptions['onBuildStart']\n persistedRecordFiles: Map<string, string>\n platformsOption: UnpluginStyleDictionaryOptions['platforms']\n quiet: boolean\n report: boolean\n root: () => string\n verbosity: 'default' | 'silent' | 'verbose' | undefined\n volume: typeof fs\n watch: UnpluginStyleDictionaryOptions['watch']\n}\n\n// Compile design tokens\nexport async function runBuilds(\n instance: PluginInstance,\n resolvedConfigs: ResolvedConfig[],\n context?: string,\n): Promise<void> {\n const {\n cache,\n destinationRecords,\n failOnError,\n generatedDestinations,\n log,\n logTable,\n notifyBuildOutcome,\n onBuildEnd,\n onBuildError,\n onBuildStart,\n persistedRecordFiles,\n platformsOption,\n quiet,\n report,\n verbosity,\n volume,\n watch,\n } = instance\n\n // Read when this compile starts rather than when the instance was built,\n // because the host assigns it after the factory has run.\n const root = instance.root()\n\n const startTime = Date.now()\n\n // Ahead of the `try` rather than inside it, because the reporting below\n // reads it and that reporting is deliberately outside.\n const generatedFiles = new Set<string>()\n\n // How many configurations were already up to date. Read by the reporting\n // below, which is why it sits out here with `generatedFiles`.\n let skipped = 0\n\n // The records an earlier process persisted for this root, loaded the first\n // time this process compiles for it and never over a record this process\n // wrote itself. Only with `cache` on, the one case that reads or keeps\n // them: every other build compiles regardless.\n let recordsFile = cache ? persistedRecordFiles.get(root) : undefined\n if (cache && recordsFile === undefined) {\n recordsFile = recordsFileFor(root)\n persistedRecordFiles.set(root, recordsFile)\n for (const [destination, record] of readPersistedRecords(recordsFile)) {\n if (!destinationRecords.has(destination)) {\n destinationRecords.set(destination, record)\n }\n }\n }\n\n // What this compile recorded, and so what it adds to the persisted copy.\n const recorded = new Map<string, DestinationRecord>()\n\n try {\n if (!context) {\n log('Compiling design tokens...', 'info')\n }\n\n // Before anything is resolved or built, and once per build — a watch\n // rebuild is a build, so this fires again for each one.\n if (onBuildStart) callHook(log, 'onBuildStart', onBuildStart)\n\n // Configurations are built one after another rather than with\n // `Promise.all`, and that is load-bearing. Two configurations may name\n // the same destination file, and each instance gets the atomic volume\n // swapped onto it below — overlapping builds would interleave those\n // writes and hand a reader a file assembled from both.\n for (const [index, item] of resolvedConfigs.entries()) {\n // Read ahead of the instance, because avoiding the instance is the\n // point: construction plus `extend` is the 15-30% of a build that\n // parses the token sources, and `buildAllPlatforms` is the rest.\n //\n // Without a `report`, so a configuration that will not parse says\n // nothing here — the build below hands Style Dictionary the path and\n // lets its own message through, which is more specific than anything\n // this could say.\n const declared = cache ? await readConfigObject(item) : null\n const selectedPlatforms = platformsFor(platformsOption, context)\n\n // Ahead of the up-to-date check, which judges a selection by the\n // destinations the configuration declares for it and so cannot see a\n // name it does not define: `['css', 'andriod']` was judged on `css`\n // alone, and with `css` current the whole build was skipped and the typo\n // went unreported until a source changed. The build path checks again\n // below, for the builds that reach it without `declared`.\n if (declared) {\n checkSelection(item, index, selectedPlatforms, declared.platforms)\n }\n\n // What this configuration reads, as it stands before the compile below\n // reads any of it. The up-to-date check needs it now, and the record\n // needs it afterwards: it is what the next check measures \"changed\n // since\" against. Only asked with `cache` on, the one case that reads it.\n const newestSource = declared\n ? await newestSourceOf({ log, root, watch }, item, declared)\n : null\n\n // Who this configuration is: its contents, the hooks it names as the\n // registry holds them now, and the Style Dictionary version. Taken here,\n // after the `config` function's `register*` calls have landed, and once:\n // the check compares it with each destination's record, and the record\n // keeps it. Only with `cache` on, because nothing compares it otherwise\n // and reading a configuration module to compute it would run it again.\n const fingerprint = declared\n ? configFingerprint(root, item, declared)\n : null\n\n if (\n declared &&\n isUpToDate(\n { destinationRecords, fingerprint, newestSource },\n item,\n declared,\n selectedPlatforms,\n )\n ) {\n // The destinations still have to be collected. They are what stops\n // the plugin's own output being treated as a watched source, so a\n // skipped configuration that contributed none would have its files\n // rebuild the moment a watcher noticed them.\n for (const destination of declaredDestinations(declared)) {\n generatedFiles.add(destination)\n }\n\n skipped++\n continue\n }\n\n // `{ init: false }` is the escape hatch Style Dictionary documents on\n // this constructor, and it is what makes a bad configuration\n // catchable. Left to itself the constructor ends in a call to\n // `init()` whose promise it neither stores nor returns, so a config\n // that fails to load rejects a promise nobody holds: the `catch`\n // below never runs, and the host dies with a raw stack or — where an\n // `unhandledRejection` handler suppresses it — hangs on a\n // `buildStart` that never settles. `await sd.hasInitialized` cannot\n // observe it either, since that promise is only ever resolved, at the\n // tail of a successful extend.\n //\n // It is handed the configuration as an object rather than as a path\n // for the same reason: Style Dictionary imports a path with no\n // cache-busting query of its own, so under a long-lived dev server\n // every rebuild after the first built the config the process started\n // with while the watch list followed the edit.\n const sd = new StyleDictionary(await configForBuild(item), {\n init: false,\n })\n\n // One initialisation rather than two. `init()` is `extend()` with\n // `mutateOriginal`, so the old pair loaded the configuration and\n // combined every source twice — running a custom parser or\n // preprocessor twice with it — and the first of the two ran at\n // default verbosity, which is how Style Dictionary's own warnings\n // escaped this plugin's `silent`. `config` defaults to the one the\n // constructor was handed.\n //\n // `verbosity` is `undefined` unless a consumer asked for a level, and\n // Style Dictionary falls through an unset one to the configuration's\n // own `log.verbosity`. Overwriting it here is what silenced the one\n // line explaining why a build wrote nothing. `log.warnings` is not\n // touched either way: a consumer's `warnings: 'error'` turning a\n // missing output file into a thrown build is their decision.\n await namingConfig(item, index, async () =>\n sd.extend(undefined, { mutateOriginal: true, verbosity }),\n )\n\n // **Before the build, and that is the whole of it.** A token set that\n // resolved to nothing is not an error anywhere in this stack: Style\n // Dictionary writes the file with no custom properties in it, prints\n // its usual `✔︎` line at any verbosity, and returns. So a token file\n // deleted mid-session took the generated output down with it and\n // reported `Rebuilt design tokens` while doing it, and a `source`\n // matching nothing shipped an empty stylesheet from a build that\n // exited 0.\n //\n // Checked here because `buildAllPlatforms` truncates and rewrites the\n // destination: one line later the previous good output is already gone\n // and an error would be accurate and useless.\n if (sd.allTokens.length === 0) {\n // The configuration as an object, so its own patterns can be named.\n // Without a `report`, because a configuration that will not parse\n // never reaches here — the `extend` above would have thrown first.\n const asObject = await readConfigObject(item)\n const barren = asObject\n ? await patternsMatchingNothing(sourcePatternsOf(asObject))\n : []\n\n // Thrown rather than reported, so it takes the path `failOnError`\n // already owns — the same decision, made in one place, rather than a\n // second way for a build to fail.\n throw new Error(\n [\n `${describeConfig(item, index)} resolved no tokens, so its output would be emptied.`,\n barren.length > 0\n ? `These patterns matched no files: ${barren.join(', ')}`\n : `It declares no source or include patterns that matched anything.`,\n `Nothing was written. Set failOnError to false to build anyway.`,\n ].join(' '),\n )\n }\n\n // Swap in the atomic volume only now that the instance has finished\n // reading its configs and token sources, so every write below lands\n // through `rename` while the read path stays exactly as it was. Seen\n // through a layer that notes what this build writes, which the record\n // below needs: a declared file is not necessarily a written one.\n const wrote = new Set<string>()\n sd.volume = notingWrites(volume, wrote)\n\n // The files this compile is about to write, named exactly as the\n // up-to-date check names them, and only the selected platforms' — a\n // scoped build leaves the others' files, and whatever wrote them, alone.\n const writing = declaredDestinations(\n { platforms: sd.platforms },\n selectedPlatforms,\n )\n\n // Forgotten before the first write rather than overwritten after the\n // last, because a build that throws partway has already replaced some\n // of these files. A record left standing would vouch for output that\n // no longer matches the configuration it names.\n for (const destination of writing) {\n destinationRecords.delete(destination)\n }\n\n if (selectedPlatforms === undefined) {\n await namingConfig(item, index, async () => sd.buildAllPlatforms())\n } else {\n // `cache: false`, and a configuration that would not parse ahead of\n // `extend`, arrive here without the check above having run.\n checkSelection(item, index, selectedPlatforms, sd.platforms)\n\n // One after another, matching the loop this sits inside: two\n // platforms may name the same destination, and `buildAllPlatforms`\n // fanning its own out with `Promise.all` is Style Dictionary's\n // choice over configurations it owns, not this plugin's over a\n // selection a consumer wrote.\n for (const name of selectedPlatforms) {\n await namingConfig(item, index, async () => sd.buildPlatform(name))\n }\n }\n\n // Every declared platform, not only the ones this compile built. A\n // file an unselected platform wrote on an earlier build is still the\n // plugin's own output, and dropping it from this set would let a\n // watcher treat it as a token source and rebuild once for every change\n // to it. Not a loop: a scoped rebuild never rewrites that file.\n //\n // Collected on every build rather than only on the ones whose size\n // report prints it below. The set is also what keeps a rebuild from\n // being triggered by the write it just made, and a rebuild passes a\n // `context` — so gating the collection on `!context` left it empty on\n // exactly the builds a watcher is live for.\n //\n // Named by `writtenDestination`, the one place that knows where Style\n // Dictionary writes a file. Every copy of that rule this code has had\n // named files that were never written — against `root` until #362, and\n // an absolute destination until #367 — and handed them to `onBuildEnd`,\n // the size report and this very set.\n for (const platform of Object.values(sd.platforms)) {\n for (const file of platform.files ?? []) {\n if (file.destination) {\n generatedFiles.add(\n writtenDestination(platform.buildPath, file.destination),\n )\n }\n }\n }\n\n // Recorded only now, so a build that threw vouches for none of what it\n // wrote before throwing. Every configuration is recorded, a file-backed\n // one included: an object configuration naming the same file has to\n // see that something else wrote it last.\n //\n // `newestSource` goes in beside the fingerprint. It was taken before\n // this compile read anything, so a source saved while it ran is newer\n // than it, and the rebuild queued for that save is not skipped. So does\n // each file's mtime as this compile left it, byte-identical skip and\n // all: a later check trusts the record only while the file still has\n // it. A file Style Dictionary declined to write is recorded as such, so\n // a later check does not go looking for it; one it wrote and that is\n // already gone gets no record, so the next build compiles.\n //\n // Only a compile with `cache` on has a fingerprint to record. One with it\n // off has still forgotten what it rewrote, above, which is what keeps\n // every other instance from vouching for its output.\n if (fingerprint !== null) {\n for (const destination of writing) {\n const record = recordOf(\n destination,\n fingerprint,\n newestSource,\n wrote.has(destination),\n )\n if (record) {\n destinationRecords.set(destination, record)\n recorded.set(destination, record)\n }\n }\n }\n }\n\n // Replaced wholesale rather than added to, so a destination dropped from\n // a configuration stops being treated as ours and becomes watchable\n // again. A build that throws never reaches this and leaves the previous\n // set standing, which is the safe direction: the files it wrote before\n // failing are still ours.\n // Once per compile rather than per configuration, and only after every\n // configuration succeeded. A compile that throws persists nothing, which\n // is safe: whatever it rewrote no longer has the mtime its old record\n // names, so that record vouches for nothing.\n if (recordsFile !== undefined && recorded.size > 0) {\n writePersistedRecords(recordsFile, recorded)\n }\n\n generatedDestinations.clear()\n for (const destination of generatedFiles) {\n generatedDestinations.add(destination.replace(/\\\\/g, '/'))\n }\n } catch (err) {\n const duration = Date.now() - startTime\n\n // The change a rebuild followed, worded as a change rather than as the\n // culprit: after a debounced burst `context` is the last file that\n // changed, which is not necessarily the one that broke the build.\n log(\n context\n ? `Compilation failed after a change in ${context} (${duration}ms): ${errorMessage(err)}`\n : `Compilation failed after ${duration}ms: ${errorMessage(err)}`,\n 'error',\n )\n\n // Ahead of the throw decision on purpose, so the overlay sees a failure\n // whatever `failOnError` does with it. Under the dev server's default\n // the line below does not throw, and reading the outcome from a caller's\n // `catch` would see a rebuild that looked like it succeeded.\n notifyBuildOutcome(asError(err))\n\n // Ahead of the throw decision for the same reason as the line above: a\n // rebuild under the dev server's default does not throw, and a hook that\n // only fired when something else was about to fail would be silent on\n // exactly the builds a consumer is watching.\n if (onBuildError) callHook(log, 'onBuildError', onBuildError, err)\n\n // Reported, and then rethrown so the host stops. Swallowing it left\n // every target exiting 0 with the previous run's tokens still on disk\n // and in the bundle — a green build shipping stale values.\n if (failsTheBuild(failOnError, context)) throw err\n\n // Explicit, now that the reporting below sits outside the `try`. This\n // `catch` used to end the function by falling off the end of it; a\n // failure that is not rethrown would otherwise carry on to announce a\n // compile that did not happen.\n return\n }\n\n // The compile is what the overlay reflects, so this is said here rather\n // than at the end: everything below is reporting, it returns early in\n // three places, and a size table that throws must not leave a successful\n // build looking unfinished.\n notifyBuildOutcome(null)\n\n // One measurement, read by the hook below and by the reporting under it.\n const duration = Date.now() - startTime\n\n // Beside the overlay notification, and for the same reason it sits here\n // rather than at the end of the function: the reporting below returns\n // early in three places, and a build that finished has finished whether or\n // not a size table gets printed for it.\n //\n // Sorted, so two runs of one configuration hand back the same order —\n // `generatedFiles` is a set in platform-then-file order, which is stable\n // in practice and guaranteed by nothing. The paths stay platform-native:\n // this is a list a consumer is going to open files with, not one the\n // watcher compares against.\n //\n // Only the declared files that are on disk. One whose filter matched no\n // tokens is declared and never written, and a hook opening it got an ENOENT.\n if (onBuildEnd) {\n // `toSorted` is what the linter asks for and what this cannot use:\n // `lib` is ES2022 here and `toSorted` is ES2023, so it types as an error\n // even though every Node this package supports has it. The rule guards\n // against mutating an array someone else holds, and this one was built\n // from the set on the line it appears on.\n const files = Array.from(generatedFiles)\n .filter((file) => fs.existsSync(file))\n // oxlint-disable-next-line unicorn/no-array-sort\n .sort((left, right) => left.localeCompare(right))\n callHook(log, 'onBuildEnd', onBuildEnd, files, duration)\n }\n\n // The `try` ends above, and everything from here down is reporting. Style\n // Dictionary has finished writing by now and `generatedDestinations` is\n // already replaced, so nothing below can put a file on disk in doubt —\n // which is why a throw from it must not be caught as a compile failure.\n // It used to be: a fault in the padding arithmetic printed `Compilation\n // failed after 19ms` over a build whose every token file was correct, and\n // with `failOnError` defaulting to `'build'` that stopped the bundler.\n\n // Every configuration was already current, so nothing was written. Said\n // rather than left implied: a build that prints its opening line and then\n // finishes in two milliseconds reads as one that silently did nothing.\n const everythingSkipped = skipped === resolvedConfigs.length\n\n if (context) {\n log(\n everythingSkipped\n ? `Design tokens already up to date after change in ${context} (${duration}ms)`\n : `Rebuilt design tokens due to change in ${context} (${duration}ms)`,\n 'success',\n )\n return\n }\n\n // The table is skipped when nothing was written, on top of `report` and\n // `quiet`. It reads every generated file in full and gzips it, and\n // reprinting the sizes of files this build did not touch is the one case\n // where that cost buys nothing at all.\n if (report && !quiet && !everythingSkipped && generatedFiles.size > 0) {\n try {\n logTable((colour) => sizeTable({ colour, root }, generatedFiles))\n } catch (err) {\n // At `'error'`, so it is said at every level including `silent`,\n // exactly as a compile failure is — and worded so it cannot be read\n // as one. Not rethrown: the build succeeded.\n log(\n `Failed to report generated file sizes: ${errorMessage(err)}`,\n 'error',\n )\n }\n }\n\n if (everythingSkipped) {\n log(`Design tokens are already up to date (${duration}ms)`, 'success')\n return\n }\n\n log(\n skipped > 0\n ? `Compiled successfully! (${duration}ms, ${skipped} already up to date)`\n : `Compiled successfully! (${duration}ms)`,\n 'success',\n )\n}\n\n// Runs one of the consumer's `onBuild*` hooks without letting it decide the\n// fate of the build that called it.\n//\n// Two ways a hook can go wrong, and neither may propagate. A throw is caught\n// here, because a post-processing step that fails must not undo a compile the\n// plugin itself completed — the files are written and correct. A rejected\n// promise is the quieter one: the return value is deliberately not awaited,\n// so a rejection has nothing holding it and reaches the host as an unhandled\n// rejection, which under Node's default takes the process down — a dev server\n// killed from inside a hook that was only meant to reformat a file.\n//\n// Both are reported at `'error'`, so they are said at every level including\n// `silent`, and worded so neither can be read as the compile having failed.\nfunction callHook<A extends unknown[]>(\n log: PluginInstance['log'],\n name: string,\n hook: (...args: A) => Promise<void> | void,\n ...args: A\n): void {\n let result: unknown\n\n try {\n // Captured rather than dropped, because the promise an `async` hook\n // returns is the thing the check below needs. Wrapping this call in a\n // block-bodied arrow — which is what the linter asks for when the return\n // type is plain `void` — discarded it, and the rejection escaped exactly\n // as it had before any of this existed.\n result = hook(...args)\n } catch (err) {\n log(`The ${name} hook threw: ${errorMessage(err)}`, 'error')\n return\n }\n\n if (!isThenable(result)) return\n\n void Promise.resolve(result).catch((err: unknown) => {\n log(`The ${name} hook rejected: ${errorMessage(err)}`, 'error')\n })\n}\n\n// Throws when `selected` names a platform that `platforms` does not define.\n// Named, so a typo is an error rather than a platform silently not built —\n// which is what Style Dictionary's own CLI means by \"Must be defined in the\n// config\" — and one function, so the check ahead of the up-to-date skip and\n// the one on the build path say exactly the same thing.\nfunction checkSelection(\n item: ResolvedConfig,\n index: number,\n selected: string[] | undefined,\n platforms: Record<string, unknown> | undefined,\n): void {\n if (selected === undefined) return\n\n const defined = Object.keys(platforms ?? {})\n const unknown = selected.filter((name) => !defined.includes(name))\n if (unknown.length > 0) {\n throw new Error(\n `${describeConfig(item, index)} does not define the platform(s) ${unknown.join(', ')}. It defines ${defined.join(', ')}.`,\n )\n }\n}\n\n// Whether a failure in this compile should be thrown rather than only\n// reported. The two compiles are told apart by `runBuilds`'s `context`,\n// which only the rebuild paths pass.\nfunction failsTheBuild(\n failOnError: NonNullable<UnpluginStyleDictionaryOptions['failOnError']>,\n context: string | undefined,\n): boolean {\n return (\n failOnError === true ||\n (context === undefined ? failOnError === 'build' : failOnError === 'serve')\n )\n}\n\n// A hook is the consumer's code, and what it hands back is not this plugin's to\n// assume. A predicate rather than `instanceof Promise`, which answers `false`\n// for a thenable from another realm or from a promise library — exactly the\n// case where letting a rejection escape does the damage.\nfunction isThenable(value: unknown): value is PromiseLike<unknown> {\n return (\n typeof value === 'object' &&\n value !== null &&\n 'then' in value &&\n typeof value.then === 'function'\n )\n}\n\n// Runs one of Style Dictionary's own steps for a configuration, and names the\n// configuration in anything it throws. Its messages name neither the\n// configuration nor the file behind them, so with several configurations a\n// failure could have come from any of them — in the log line, the overlay and\n// `onBuildError` alike. `cause` keeps its own error reachable.\n//\n// Only Style Dictionary's steps, never the whole loop: the plugin's own errors\n// already open with `describeConfig`, and wrapping those would name the\n// configuration twice.\nasync function namingConfig<T>(\n item: ResolvedConfig,\n index: number,\n step: () => Promise<T>,\n): Promise<T> {\n try {\n return await step()\n } catch (err) {\n throw new Error(\n `${describeConfig(item, index)} failed: ${errorMessage(err)}`,\n { cause: err },\n )\n }\n}\n\n// `volume`, with every path Style Dictionary writes through it noted in\n// `into`, resolved as `writtenDestination` resolves a declared one. Each file\n// a build writes reaches `promises.writeFile` (`buildPlatform` in\n// `lib/StyleDictionary.js`) — a byte-identical one included, since the atomic\n// writer decides to skip the rename only once it has been handed the file — so\n// `into` ends up holding exactly what the build wrote, and a file it declined\n// to write never appears in it. Built per compile, over the atomic volume\n// rather than in place of it.\n//\n// The sync writer is inherited untouched. Only an action reaches it, a\n// configuration with actions is never skipped, and `tests/index.test.ts`\n// checks that an action is handed the atomic writer itself.\nfunction notingWrites(volume: typeof fs, into: Set<string>): typeof fs {\n const note = (file: unknown) => {\n if (typeof file === 'string') into.add(path.resolve(file))\n }\n\n /* oxlint-disable typescript/no-unsafe-type-assertion */\n return Object.create(volume, {\n promises: {\n value: Object.create(volume.promises, {\n writeFile: {\n value: async (...args: Parameters<typeof fs.promises.writeFile>) => {\n note(args[0])\n await volume.promises.writeFile(...args)\n },\n },\n }) as typeof fs.promises,\n },\n }) as typeof fs\n /* oxlint-enable typescript/no-unsafe-type-assertion */\n}\n\n// Which platforms this compile covers, or `undefined` for all of them.\n//\n// The array form applies to every build; the object form splits the first\n// compile from the watch rebuilds, and `context` is what tells them apart —\n// only the rebuild paths pass one. An absent key means every platform, so\n// `{ watch: ['css'] }` builds everything once and then only css.\nfunction platformsFor(\n platformsOption: UnpluginStyleDictionaryOptions['platforms'],\n context: string | undefined,\n): string[] | undefined {\n if (platformsOption === undefined) return undefined\n if (Array.isArray(platformsOption)) return platformsOption\n\n return context === undefined ? platformsOption.build : platformsOption.watch\n}\n"],"mappings":";;;;;;;;;AAmEA,eAAsB,UACpB,UACA,iBACA,SACe;CACf,MAAM,EACJ,OACA,oBACA,aACA,uBACA,KACA,UACA,oBACA,YACA,cACA,cACA,sBACA,iBACA,OACA,QACA,WACA,QACA,UACE;CAIJ,MAAM,OAAO,SAAS,KAAK;CAE3B,MAAM,YAAY,KAAK,IAAI;CAI3B,MAAM,iCAAiB,IAAI,IAAY;CAIvC,IAAI,UAAU;CAMd,IAAI,cAAc,QAAQ,qBAAqB,IAAI,IAAI,IAAI,KAAA;CAC3D,IAAI,SAAS,gBAAgB,KAAA,GAAW;EACtC,cAAc,eAAe,IAAI;EACjC,qBAAqB,IAAI,MAAM,WAAW;EAC1C,KAAK,MAAM,CAAC,aAAa,WAAW,qBAAqB,WAAW,GAClE,IAAI,CAAC,mBAAmB,IAAI,WAAW,GACrC,mBAAmB,IAAI,aAAa,MAAM;CAGhD;CAGA,MAAM,2BAAW,IAAI,IAA+B;CAEpD,IAAI;EACF,IAAI,CAAC,SACH,IAAI,8BAA8B,MAAM;EAK1C,IAAI,cAAc,SAAS,KAAK,gBAAgB,YAAY;EAO5D,KAAK,MAAM,CAAC,OAAO,SAAS,gBAAgB,QAAQ,GAAG;GASrD,MAAM,WAAW,QAAQ,MAAM,iBAAiB,IAAI,IAAI;GACxD,MAAM,oBAAoB,aAAa,iBAAiB,OAAO;GAQ/D,IAAI,UACF,eAAe,MAAM,OAAO,mBAAmB,SAAS,SAAS;GAOnE,MAAM,eAAe,WACjB,MAAM,eAAe;IAAE;IAAK;IAAM;GAAM,GAAG,MAAM,QAAQ,IACzD;GAQJ,MAAM,cAAc,WAChB,kBAAkB,MAAM,MAAM,QAAQ,IACtC;GAEJ,IACE,YACA,WACE;IAAE;IAAoB;IAAa;GAAa,GAChD,MACA,UACA,iBACF,GACA;IAKA,KAAK,MAAM,eAAe,qBAAqB,QAAQ,GACrD,eAAe,IAAI,WAAW;IAGhC;IACA;GACF;GAkBA,MAAM,KAAK,IAAI,gBAAgB,MAAM,eAAe,IAAI,GAAG,EACzD,MAAM,MACR,CAAC;GAgBD,MAAM,aAAa,MAAM,OAAO,YAC9B,GAAG,OAAO,KAAA,GAAW;IAAE,gBAAgB;IAAM;GAAU,CAAC,CAC1D;GAcA,IAAI,GAAG,UAAU,WAAW,GAAG;IAI7B,MAAM,WAAW,MAAM,iBAAiB,IAAI;IAC5C,MAAM,SAAS,WACX,MAAM,wBAAwB,iBAAiB,QAAQ,CAAC,IACxD,CAAC;IAKL,MAAM,IAAI,MACR;KACE,GAAG,eAAe,MAAM,KAAK,EAAE;KAC/B,OAAO,SAAS,IACZ,oCAAoC,OAAO,KAAK,IAAI,MACpD;KACJ;IACF,CAAC,CAAC,KAAK,GAAG,CACZ;GACF;GAOA,MAAM,wBAAQ,IAAI,IAAY;GAC9B,GAAG,SAAS,aAAa,QAAQ,KAAK;GAKtC,MAAM,UAAU,qBACd,EAAE,WAAW,GAAG,UAAU,GAC1B,iBACF;GAMA,KAAK,MAAM,eAAe,SACxB,mBAAmB,OAAO,WAAW;GAGvC,IAAI,sBAAsB,KAAA,GACxB,MAAM,aAAa,MAAM,OAAO,YAAY,GAAG,kBAAkB,CAAC;QAC7D;IAGL,eAAe,MAAM,OAAO,mBAAmB,GAAG,SAAS;IAO3D,KAAK,MAAM,QAAQ,mBACjB,MAAM,aAAa,MAAM,OAAO,YAAY,GAAG,cAAc,IAAI,CAAC;GAEtE;GAmBA,KAAK,MAAM,YAAY,OAAO,OAAO,GAAG,SAAS,GAC/C,KAAK,MAAM,QAAQ,SAAS,SAAS,CAAC,GACpC,IAAI,KAAK,aACP,eAAe,IACb,mBAAmB,SAAS,WAAW,KAAK,WAAW,CACzD;GAsBN,IAAI,gBAAgB,MAClB,KAAK,MAAM,eAAe,SAAS;IACjC,MAAM,SAAS,SACb,aACA,aACA,cACA,MAAM,IAAI,WAAW,CACvB;IACA,IAAI,QAAQ;KACV,mBAAmB,IAAI,aAAa,MAAM;KAC1C,SAAS,IAAI,aAAa,MAAM;IAClC;GACF;EAEJ;EAWA,IAAI,gBAAgB,KAAA,KAAa,SAAS,OAAO,GAC/C,sBAAsB,aAAa,QAAQ;EAG7C,sBAAsB,MAAM;EAC5B,KAAK,MAAM,eAAe,gBACxB,sBAAsB,IAAI,YAAY,QAAQ,OAAO,GAAG,CAAC;CAE7D,SAAS,KAAK;EACZ,MAAM,WAAW,KAAK,IAAI,IAAI;EAK9B,IACE,UACI,wCAAwC,QAAQ,IAAI,SAAS,OAAO,aAAa,GAAG,MACpF,4BAA4B,SAAS,MAAM,aAAa,GAAG,KAC/D,OACF;EAMA,mBAAmB,QAAQ,GAAG,CAAC;EAM/B,IAAI,cAAc,SAAS,KAAK,gBAAgB,cAAc,GAAG;EAKjE,IAAI,cAAc,aAAa,OAAO,GAAG,MAAM;EAM/C;CACF;CAMA,mBAAmB,IAAI;CAGvB,MAAM,WAAW,KAAK,IAAI,IAAI;CAe9B,IAAI,YAUF,SAAS,KAAK,cAAc,YAJd,MAAM,KAAK,cAAc,CAAC,CACrC,QAAQ,SAAS,GAAG,WAAW,IAAI,CAAC,CAAC,CAErC,MAAM,MAAM,UAAU,KAAK,cAAc,KAAK,CACL,GAAG,QAAQ;CAczD,MAAM,oBAAoB,YAAY,gBAAgB;CAEtD,IAAI,SAAS;EACX,IACE,oBACI,oDAAoD,QAAQ,IAAI,SAAS,OACzE,0CAA0C,QAAQ,IAAI,SAAS,MACnE,SACF;EACA;CACF;CAMA,IAAI,UAAU,CAAC,SAAS,CAAC,qBAAqB,eAAe,OAAO,GAClE,IAAI;EACF,UAAU,WAAW,UAAU;GAAE;GAAQ;EAAK,GAAG,cAAc,CAAC;CAClE,SAAS,KAAK;EAIZ,IACE,0CAA0C,aAAa,GAAG,KAC1D,OACF;CACF;CAGF,IAAI,mBAAmB;EACrB,IAAI,yCAAyC,SAAS,MAAM,SAAS;EACrE;CACF;CAEA,IACE,UAAU,IACN,2BAA2B,SAAS,MAAM,QAAQ,wBAClD,2BAA2B,SAAS,MACxC,SACF;AACF;AAeA,SAAS,SACP,KACA,MACA,MACA,GAAG,MACG;CACN,IAAI;CAEJ,IAAI;EAMF,SAAS,KAAK,GAAG,IAAI;CACvB,SAAS,KAAK;EACZ,IAAI,OAAO,KAAK,eAAe,aAAa,GAAG,KAAK,OAAO;EAC3D;CACF;CAEA,IAAI,CAAC,WAAW,MAAM,GAAG;CAEzB,QAAa,QAAQ,MAAM,CAAC,CAAC,OAAO,QAAiB;EACnD,IAAI,OAAO,KAAK,kBAAkB,aAAa,GAAG,KAAK,OAAO;CAChE,CAAC;AACH;AAOA,SAAS,eACP,MACA,OACA,UACA,WACM;CACN,IAAI,aAAa,KAAA,GAAW;CAE5B,MAAM,UAAU,OAAO,KAAK,aAAa,CAAC,CAAC;CAC3C,MAAM,UAAU,SAAS,QAAQ,SAAS,CAAC,QAAQ,SAAS,IAAI,CAAC;CACjE,IAAI,QAAQ,SAAS,GACnB,MAAM,IAAI,MACR,GAAG,eAAe,MAAM,KAAK,EAAE,mCAAmC,QAAQ,KAAK,IAAI,EAAE,eAAe,QAAQ,KAAK,IAAI,EAAE,EACzH;AAEJ;AAKA,SAAS,cACP,aACA,SACS;CACT,OACE,gBAAgB,SACf,YAAY,KAAA,IAAY,gBAAgB,UAAU,gBAAgB;AAEvE;AAMA,SAAS,WAAW,OAA+C;CACjE,OACE,OAAO,UAAU,YACjB,UAAU,QACV,UAAU,SACV,OAAO,MAAM,SAAS;AAE1B;AAWA,eAAe,aACb,MACA,OACA,MACY;CACZ,IAAI;EACF,OAAO,MAAM,KAAK;CACpB,SAAS,KAAK;EACZ,MAAM,IAAI,MACR,GAAG,eAAe,MAAM,KAAK,EAAE,WAAW,aAAa,GAAG,KAC1D,EAAE,OAAO,IAAI,CACf;CACF;AACF;AAcA,SAAS,aAAa,QAAmB,MAA8B;CACrE,MAAM,QAAQ,SAAkB;EAC9B,IAAI,OAAO,SAAS,UAAU,KAAK,IAAI,KAAK,QAAQ,IAAI,CAAC;CAC3D;CAGA,OAAO,OAAO,OAAO,QAAQ,EAC3B,UAAU,EACR,OAAO,OAAO,OAAO,OAAO,UAAU,EACpC,WAAW,EACT,OAAO,OAAO,GAAG,SAAmD;EAClE,KAAK,KAAK,EAAE;EACZ,MAAM,OAAO,SAAS,UAAU,GAAG,IAAI;CACzC,EACF,EACF,CAAC,EACH,EACF,CAAC;AAEH;AAQA,SAAS,aACP,iBACA,SACsB;CACtB,IAAI,oBAAoB,KAAA,GAAW,OAAO,KAAA;CAC1C,IAAI,MAAM,QAAQ,eAAe,GAAG,OAAO;CAE3C,OAAO,YAAY,KAAA,IAAY,gBAAgB,QAAQ,gBAAgB;AACzE"}
|