Skip to main content

max / makeover-build

35.9 KB · 961 lines History Blame Raw
1 //! Checks that a hand-written frontend still agrees with the crate that
2 //! generates its siblings.
3 //!
4 //! The generated files cannot drift: they ask makeover-geometry for the answer.
5 //! The hand-written ones state it, and a stylesheet or a script that disagrees
6 //! with the crate is not an error at any point -- it is a rule that quietly
7 //! stops matching where it used to. Cheaper to read a panic naming the line.
8 //!
9 //! Deliberately assertions and not substitutions. A JS or CSS file that has to
10 //! be generated to be correct stops being readable on its own, and it is worth
11 //! something that you can still open the frontend in a browser and have it
12 //! work.
13
14 use std::path::{Path, PathBuf};
15
16 use makeover_geometry::{Density, SizeClass};
17 use makeover_webview::Emit;
18
19 /// The declaration this check reads. Shared vocabulary, not a parameter: two
20 /// apps and a server naming the same string want the same name for it.
21 const CONST_NAME: &str = "TOUCH_DENSITY";
22
23 /// The capability sniffs the media query replaced, so neither can come back by
24 /// copy-paste.
25 ///
26 /// Both ask the hardware what it has rather than what is pointing at the
27 /// screen, so both say yes to a touchscreen laptop driving a mouse.
28 const SNIFFS: &[&str] = &["ontouchstart", "maxTouchPoints"];
29
30 /// Fail the build if a JS copy of the touch-density query has drifted from
31 /// [`Density::Touch`].
32 ///
33 /// Every `.js` file under `js_dir`, recursively, must state the crate's own
34 /// media condition in a `const TOUCH_DENSITY = '...'`, at least one file must
35 /// declare it, and no file may name a capability sniff.
36 ///
37 /// The string is the crate's and no app gets a say in it, which is why this
38 /// check takes no policy argument. The generated `geometry.css` already keys
39 /// its touch gap overrides on the same condition, so the gestures and the
40 /// spacing agree by construction rather than by two people remembering.
41 ///
42 /// Emits `cargo:rerun-if-changed` for every file it read.
43 ///
44 /// # Panics
45 ///
46 /// If `js_dir` cannot be read, if no declaration is found, or if any file
47 /// disagrees with the crate. A build script has nowhere useful to return an
48 /// error to, and a frontend that disagrees with its own stylesheet is worse
49 /// than a failed build.
50 pub fn check_touch_density(js_dir: impl AsRef<Path>) {
51 let js_dir = js_dir.as_ref();
52 let want = Density::Touch.media_condition();
53 let mut wrong: Vec<String> = Vec::new();
54 let mut found = 0usize;
55
56 let files = js_files(js_dir);
57 for path in &files {
58 let src = std::fs::read_to_string(path).expect("read js file");
59 let name = path
60 .strip_prefix(js_dir)
61 .unwrap_or(path)
62 .display()
63 .to_string();
64
65 for (offset, literal) in touch_density_literals(&src) {
66 found += 1;
67 if literal != want {
68 wrong.push(format!(
69 " {name}:{} {CONST_NAME} = '{literal}'",
70 line_of(&src, offset)
71 ));
72 }
73 }
74
75 for needle in SNIFFS {
76 if let Some(offset) = src.find(needle) {
77 wrong.push(format!(
78 " {name}:{} {needle} -- device sniff, not a density question",
79 line_of(&src, offset)
80 ));
81 }
82 }
83 }
84
85 assert!(
86 found > 0,
87 "no {CONST_NAME} literal found under {}.\n\n\
88 A frontend that asks whether it is being touched states\n\
89 makeover_geometry::Density::Touch's media condition in a const of that\n\
90 name, and this check exists to keep every copy equal to it. If the\n\
91 const was renamed, rename it back rather than dropping the check; if\n\
92 this frontend genuinely asks no density question, drop the call.",
93 js_dir.display()
94 );
95
96 assert!(
97 wrong.is_empty(),
98 "hand-written touch detection disagrees with makeover_geometry::Density.\n\n\
99 Density::Touch.media_condition() is: {want}\n\n\
100 Wrong:\n{}\n\n\
101 Fix the JS to state the crate's string. Never widen it to catch a\n\
102 device the query misses: density is what is pointing at the screen,\n\
103 and a laptop with a touchscreen and a mouse is a pointer device.",
104 wrong.join("\n")
105 );
106
107 for path in &files {
108 println!("cargo:rerun-if-changed={}", path.display());
109 }
110 }
111
112 /// Every `.js` file under `dir`, recursively, sorted.
113 fn js_files(dir: &Path) -> Vec<PathBuf> {
114 files_with_extension(dir, "js")
115 }
116
117 /// Every file under `dir` with extension `ext`, recursively, sorted.
118 ///
119 /// Recursive because a consumer's frontend is not always one flat directory:
120 /// the Tauri apps keep `js/*.js`, the server keeps subdirectories under
121 /// `static/`, and a check that silently skipped the nested half would report
122 /// clean on the files most likely to have been copied.
123 fn files_with_extension(dir: &Path, ext: &str) -> Vec<PathBuf> {
124 let mut out = Vec::new();
125 let mut stack = vec![dir.to_path_buf()];
126 while let Some(d) = stack.pop() {
127 for entry in std::fs::read_dir(&d)
128 .unwrap_or_else(|e| panic!("read {}: {e}", d.display()))
129 .flatten()
130 {
131 let path = entry.path();
132 if path.is_dir() {
133 stack.push(path);
134 } else if path.extension().is_some_and(|x| x == ext) {
135 out.push(path);
136 }
137 }
138 }
139 out.sort();
140 out
141 }
142
143 /// `(byte offset of the declaration, the literal's contents)` for every
144 /// `const TOUCH_DENSITY = '...'` in a JS source.
145 fn touch_density_literals(src: &str) -> Vec<(usize, &str)> {
146 let mut out = Vec::new();
147 let mut at = 0;
148 while let Some(i) = src[at..].find(CONST_NAME) {
149 let start = at + i;
150 at = start + CONST_NAME.len();
151 // Only the declaration states the string; a use site reads the const.
152 let Some(rest) = src[at..].strip_prefix(" = ") else {
153 continue;
154 };
155 let open = at + " = ".len();
156 let Some(quote @ ('\'' | '"')) = rest.chars().next() else {
157 continue;
158 };
159 let body = open + 1;
160 if let Some(j) = src[body..].find(quote) {
161 out.push((start, &src[body..body + j]));
162 at = body + j + 1;
163 }
164 }
165 out
166 }
167
168 fn line_of(src: &str, offset: usize) -> usize {
169 src[..offset].matches('\n').count() + 1
170 }
171
172 /// Fail the build if a hand-written breakpoint has drifted from [`SizeClass`].
173 ///
174 /// Every pixel width named by a media query under `frontend/css` or
175 /// `frontend/js`, recursively, must be a [`SizeClass`] boundary or one of
176 /// `tuning_widths`.
177 ///
178 /// Without this, moving `SizeClass::Medium::min_px` regenerates the emitted
179 /// stylesheets and silently leaves every hand-written query behind, and what
180 /// you get is not an error but a stylesheet that disagrees with itself at the
181 /// old boundary.
182 ///
183 /// `tuning_widths` is the one thing an app gets a say in, which is why this
184 /// takes a parameter where [`check_touch_density`] does not. A shell boundary
185 /// is a [`SizeClass`] edge and belongs to makeover-geometry; a tuning width is
186 /// a point inside a shell where something reflows without the shell changing --
187 /// a dashboard dropping from three columns to two, a pane's width cap ending.
188 /// Nothing switches shells at one, so it should not move when a size class
189 /// does. Pass `&[]` if the app has none, and treat every addition as owing a
190 /// note saying what it tunes: the list is where a genuine boundary goes to hide
191 /// from this check.
192 ///
193 /// The generated stylesheets are scanned too, and pass by construction: they
194 /// ask makeover-geometry for the number rather than stating it. Scanning them
195 /// costs nothing and means a consumer never has to name which files are
196 /// hand-written.
197 ///
198 /// Emits `cargo:rerun-if-changed` for every file it read.
199 ///
200 /// # Panics
201 ///
202 /// If `frontend/css` or `frontend/js` cannot be read, or if any width is
203 /// neither a size-class boundary nor a declared tuning width. A build script
204 /// has nowhere useful to return an error to.
205 pub fn check_breakpoints(frontend: impl AsRef<Path>, tuning_widths: &[u16]) {
206 let frontend = frontend.as_ref();
207 let mut files = files_with_extension(&frontend.join("css"), "css");
208 files.extend(js_files(&frontend.join("js")));
209 check_paths(&files, tuning_widths, Some(frontend));
210 }
211
212 /// [`check_breakpoints`] against a named list of files rather than a tree.
213 ///
214 /// For a frontend whose generated and hand-written files share a directory, so
215 /// there is nothing to point a directory scan at: the MNW server keeps both
216 /// under `static/` alongside a bundler's output, and bundled third-party CSS
217 /// is exactly the place a width nobody chose would come from.
218 ///
219 /// The cost is that the list is hand-maintained, and a stylesheet nobody adds
220 /// to it is unchecked rather than failing. Prefer [`check_breakpoints`] where
221 /// the layout allows it.
222 ///
223 /// A `.js` path is parsed as script and anything else as stylesheet, which is
224 /// the only difference: a media condition is parenthesised in both.
225 ///
226 /// # Panics
227 ///
228 /// If a listed file cannot be read -- a listed path that no longer exists is a
229 /// check silently covering less than it says -- or if any width is neither a
230 /// size-class boundary nor a declared tuning width.
231 pub fn check_breakpoints_files<P: AsRef<Path>>(paths: &[P], tuning_widths: &[u16]) {
232 let paths: Vec<PathBuf> = paths.iter().map(|p| p.as_ref().to_path_buf()).collect();
233 check_paths(&paths, tuning_widths, None);
234 }
235
236 /// The check itself. `root`, when given, is stripped from reported paths.
237 fn check_paths(paths: &[PathBuf], tuning_widths: &[u16], root: Option<&Path>) {
238 let allowed = allowed_widths(tuning_widths);
239 let mut stale: Vec<String> = Vec::new();
240
241 for path in paths {
242 let raw = std::fs::read_to_string(path)
243 .unwrap_or_else(|e| panic!("read {}: {e}", path.display()));
244 let name = match root {
245 Some(root) => display_name(root, path),
246 None => path.display().to_string(),
247 };
248
249 if path.extension().is_some_and(|x| x == "js") {
250 // No declarations in JS, so any parenthesised width is a query.
251 for (offset, px) in js_widths(&raw) {
252 if !allowed.contains(&px) {
253 stale.push(format!(" {name}:{} ({px}px)", line_of(&raw, offset)));
254 }
255 }
256 continue;
257 }
258
259 // Comments first: a note about a breakpoint that used to be here is
260 // prose, not a rule, and should not fail a build.
261 let src = strip_block_comments(&raw);
262 for (offset, condition) in media_conditions(&src) {
263 for px in media_widths(condition) {
264 if !allowed.contains(&px) {
265 stale.push(format!(
266 " {name}:{} @media{condition} ({px}px)",
267 line_of(&src, offset)
268 ));
269 }
270 }
271 }
272 }
273
274 assert!(
275 stale.is_empty(),
276 "hand-written breakpoints disagree with makeover_geometry::SizeClass.\n\n\
277 Allowed: {allowed:?}\n\
278 ({:?} come from SizeClass; {tuning_widths:?} were passed as tuning widths.)\n\n\
279 Stale:\n{}\n\n\
280 If a size class moved, update these to match. If one of these is a new\n\
281 tuning width inside the wide shell rather than a shell boundary, add it\n\
282 to the caller's tuning list with a note saying what it tunes.\n\n\
283 Best of all, make the rule dimensional so it needs no threshold: a grid\n\
284 wants repeat(auto-fit, minmax(<content floor>, 1fr)) and a size wants\n\
285 clamp(). A threshold is for what appears and disappears.",
286 allowed
287 .iter()
288 .filter(|px| !tuning_widths.contains(px))
289 .collect::<Vec<_>>(),
290 stale.join("\n")
291 );
292
293 for path in paths {
294 println!("cargo:rerun-if-changed={}", path.display());
295 }
296 }
297
298 /// A path as the frontend sees it, for an error a reader can act on.
299 fn display_name(frontend: &Path, path: &Path) -> String {
300 path.strip_prefix(frontend)
301 .unwrap_or(path)
302 .display()
303 .to_string()
304 }
305
306 /// Every width a hand-written media query is allowed to name.
307 ///
308 /// Read out of [`SizeClass::media_condition`] rather than typed, which is the
309 /// whole point: that is the one place the numbers come from, and a bump in
310 /// makeover-geometry has to reach the stylesheet through here.
311 fn allowed_widths(tuning_widths: &[u16]) -> Vec<u16> {
312 let mut widths: Vec<u16> = SizeClass::all()
313 .iter()
314 .flat_map(|c| media_widths(&c.media_condition()))
315 .collect();
316 widths.extend_from_slice(tuning_widths);
317 widths.sort_unstable();
318 widths.dedup();
319 widths
320 }
321
322 /// The pixel values in a media condition, in the order they appear.
323 fn media_widths(condition: &str) -> Vec<u16> {
324 let mut out = Vec::new();
325 let mut rest = condition;
326 while let Some(i) = rest.find("-width:") {
327 rest = &rest[i + "-width:".len()..];
328 let digits: String = rest
329 .trim_start()
330 .chars()
331 .take_while(char::is_ascii_digit)
332 .collect();
333 if let Ok(px) = digits.parse() {
334 out.push(px);
335 }
336 }
337 out
338 }
339
340 /// `(byte offset of the `@media`, the condition text before the `{`)`.
341 fn media_conditions(css: &str) -> Vec<(usize, &str)> {
342 let mut out = Vec::new();
343 let mut at = 0;
344 while let Some(i) = css[at..].find("@media") {
345 let start = at + i;
346 let after = start + "@media".len();
347 match css[after..].find('{') {
348 Some(j) => {
349 out.push((start, &css[after..after + j]));
350 at = after + j;
351 }
352 None => break,
353 }
354 }
355 out
356 }
357
358 /// `(byte offset, pixel value)` for every `(max-width: Npx)` in a JS source.
359 ///
360 /// The parentheses are the whole test, and they have to be: a media condition
361 /// is always parenthesized and a CSS declaration never is, so `'max-width:
362 /// 320px'` in an inline-style string is not a breakpoint and must not read as
363 /// one. goingson's shared-updater.js builds exactly that, and the first version
364 /// of this check failed the build on it.
365 fn js_widths(src: &str) -> Vec<(usize, u16)> {
366 let mut out = Vec::new();
367 for pat in ["(max-width:", "(min-width:"] {
368 let mut at = 0;
369 while let Some(i) = src[at..].find(pat) {
370 let start = at + i;
371 let rest = src[start + pat.len()..].trim_start();
372 let digits: String = rest.chars().take_while(char::is_ascii_digit).collect();
373 if let Ok(px) = digits.parse()
374 && rest[digits.len()..].starts_with("px)")
375 {
376 out.push((start, px));
377 }
378 at = start + pat.len();
379 }
380 }
381 out
382 }
383
384 /// Replace every `/* ... */` with spaces, so byte offsets still line up.
385 fn strip_block_comments(css: &str) -> String {
386 let bytes = css.as_bytes();
387 let mut out = String::with_capacity(css.len());
388 let mut i = 0;
389 while i < bytes.len() {
390 if bytes[i..].starts_with(b"/*") {
391 let end = css[i..].find("*/").map_or(bytes.len(), |j| i + j + 2);
392 for c in css[i..end].chars() {
393 out.push(if c == '\n' { '\n' } else { ' ' });
394 }
395 i = end;
396 } else {
397 let c = css[i..].chars().next().unwrap();
398 out.push(c);
399 i += c.len_utf8();
400 }
401 }
402 out
403 }
404
405 /// Fail the build if a hand-written stylesheet takes a property the generated
406 /// one already sets on the same class.
407 ///
408 /// The generated sheet sits in `@layer makeover`. Unlayered app CSS beats a
409 /// layer by construction, whatever the specificity, so an app declaration for a
410 /// property makeover already sets does not merge with it: it wins, silently,
411 /// and the design system's version of that component stops applying. Both
412 /// sort-caret defects found on 2026-08-11 were this, and both were live for
413 /// months because nothing looked.
414 ///
415 /// # Why properties and not class names
416 ///
417 /// A shared class name is not by itself a divergence, and the first run of this
418 /// check against goingson is what settled it: nine classes are shared and every
419 /// one is deliberate. `.badge` sets shape in the app and colour in the
420 /// generated sheet, and the app's own comment beside it reads "Fill, edge and
421 /// text colour come from the generated .badge in layout.css. Do not add
422 /// background, border or box-shadow here." That arrangement is correct, so a
423 /// check on names would have asked for it to be deleted. On properties, the
424 /// comment becomes the check.
425 ///
426 /// # The exception list
427 ///
428 /// `allowed` is `(class, property)` pairs this app has reviewed and kept. There
429 /// are legitimate ones: the sort caret's reserved gap is `content` on
430 /// `.table-heading`'s unsorted arm and the generated caret is `content` on the
431 /// sorted arm, which is a pairing rather than a collision. Deciding that here
432 /// would need a selector matcher, and a check that guesses wrong about
433 /// specificity fails correct builds -- so the app declares it instead, the same
434 /// shape as quasi-webview's `RENDERER_OWN`.
435 ///
436 /// A pair that stops colliding fails too. A licence nobody is using is where
437 /// the next real collision lands and reads as company.
438 ///
439 /// `frontend` is the directory holding `css/`. `generated` names the sheets
440 /// this crate writes, relative to `frontend/css`, which are skipped: the
441 /// generated file setting a generated property is the point.
442 ///
443 /// Emits `cargo:rerun-if-changed` for every file it read.
444 ///
445 /// # Panics
446 ///
447 /// If `frontend/css` cannot be read, if any hand-written sheet takes a
448 /// generated property without declaring it, or if a declared pair no longer
449 /// collides. A build script has nowhere useful to return an error to, and an
450 /// app quietly overriding its own design system is worse than a failed build.
451 pub fn check_vocabulary(
452 frontend: impl AsRef<Path>,
453 opts: &Emit,
454 generated: &[&str],
455 allowed: &[(&str, &str)],
456 ) {
457 let frontend = frontend.as_ref();
458 let css = frontend.join("css");
459 let files: Vec<PathBuf> = files_with_extension(&css, "css")
460 .into_iter()
461 .filter(|p| {
462 let name = p.strip_prefix(&css).unwrap_or(p).display().to_string();
463 !generated.contains(&name.as_str())
464 })
465 .collect();
466 check_vocabulary_paths(&files, opts, Some(frontend), allowed);
467 }
468
469 /// [`check_vocabulary`] against a named list of files rather than a tree.
470 ///
471 /// For a frontend whose generated and hand-written sheets share a directory, so
472 /// a directory scan has nothing to point at. Same trade as
473 /// [`check_breakpoints_files`]: the list is hand-maintained, and a stylesheet
474 /// nobody adds to it is unchecked rather than failing.
475 ///
476 /// # Panics
477 ///
478 /// As [`check_vocabulary`].
479 pub fn check_vocabulary_files<P: AsRef<Path>>(paths: &[P], opts: &Emit, allowed: &[(&str, &str)]) {
480 let paths: Vec<PathBuf> = paths.iter().map(|p| p.as_ref().to_path_buf()).collect();
481 check_vocabulary_paths(&paths, opts, None, allowed);
482 }
483
484 /// The check itself. `root`, when given, is stripped from reported paths.
485 fn check_vocabulary_paths(
486 paths: &[PathBuf],
487 opts: &Emit,
488 root: Option<&Path>,
489 allowed: &[(&str, &str)],
490 ) {
491 let generated =
492 makeover_webview::vocabulary::declarations_by_class(&makeover_webview::stylesheet(opts));
493 let mut clashes: Vec<String> = Vec::new();
494 let mut seen: Vec<(String, String)> = Vec::new();
495
496 for path in paths {
497 println!("cargo::rerun-if-changed={}", path.display());
498 let raw = std::fs::read_to_string(path)
499 .unwrap_or_else(|e| panic!("read {}: {e}", path.display()));
500 let name = match root {
501 Some(root) => display_name(root, path),
502 None => path.display().to_string(),
503 };
504 // Read the app's sheet the same way the crate reads its own, or the two
505 // sides are not comparable.
506 let local = makeover_webview::vocabulary::declarations_by_class(&raw);
507 for (class, properties) in &local {
508 let Some(theirs) = generated.get(class) else {
509 continue;
510 };
511 for property in properties.intersection(theirs) {
512 seen.push((class.clone(), property.clone()));
513 if allowed.contains(&(class.as_str(), property.as_str())) {
514 continue;
515 }
516 clashes.push(format!(" {name} .{class} {{ {property} }}"));
517 }
518 }
519 }
520
521 assert!(
522 clashes.is_empty(),
523 "{} hand-written declaration(s) take a property the generated stylesheet \
524 already sets on the same class. App CSS is unlayered and beats \
525 @layer makeover, so each of these wins over the design system \
526 silently:\n{}\n\nDelete the declaration, or, if it is a deliberate pairing \
527 on a different selector arm, add (class, property) to this check's \
528 allowed list and say why beside it. Count the consumers before deciding \
529 a divergence is worth keeping.",
530 clashes.len(),
531 clashes.join("\n")
532 );
533
534 let stale: Vec<&(&str, &str)> = allowed
535 .iter()
536 .filter(|(class, property)| {
537 !seen.contains(&((*class).to_string(), (*property).to_string()))
538 })
539 .collect();
540 assert!(
541 stale.is_empty(),
542 "the allowed list declares {stale:?}, which no longer collides with \
543 anything. Delete the entries: an exception nobody is using is where the \
544 next real collision lands and reads as company."
545 );
546 }
547
548 /// Warn when the generated vocabulary has grown dead, and fail when it grows
549 /// deader than the recorded high-water mark.
550 ///
551 /// A generated class no markup emits is a rule shipped to every user for
552 /// nothing, and the proportion was large when it was first measured: 42% of the
553 /// vocabulary unused in goingson, 67% in the MNW server, 84% in Balanced
554 /// Breakfast. Those are not failures on their own or no app would build. What
555 /// this converts is the direction: dead vocabulary becoming a number in a build
556 /// script means a change that worsens it stops being something somebody
557 /// notices.
558 ///
559 /// One-sided, the same shape as the MNW server's `frontend_globals` seal:
560 /// exceeding `high_water` fails, coming in under it warns and asks for the seal
561 /// to be lowered. A build that fails because dead CSS was deleted would teach
562 /// the wrong lesson.
563 ///
564 /// `markup` is every file that can carry a class: templates, `.js`, `.html`,
565 /// and any Rust that writes markup. A class is counted as used if its name
566 /// appears in any of them, which is deliberately generous. A stricter reading
567 /// would need to know how each app builds its class strings, and a check that
568 /// guesses wrong fails a correct build.
569 ///
570 /// # Panics
571 ///
572 /// If a listed file cannot be read, or if more classes are unused than
573 /// `high_water`.
574 pub fn check_vocabulary_use<P: AsRef<Path>>(markup: &[P], opts: &Emit, high_water: usize) {
575 let generated = makeover_webview::vocabulary::names(opts);
576 let mut haystack = String::new();
577 for path in markup {
578 let path = path.as_ref();
579 println!("cargo::rerun-if-changed={}", path.display());
580 haystack.push_str(
581 &std::fs::read_to_string(path)
582 .unwrap_or_else(|e| panic!("read {}: {e}", path.display())),
583 );
584 haystack.push('\n');
585 }
586
587 let unused: Vec<&String> = generated
588 .iter()
589 .filter(|class| !haystack.contains(class.as_str()))
590 .collect();
591
592 assert!(
593 unused.len() <= high_water,
594 "{} of {} generated classes are emitted by no markup, above the recorded {}. \
595 The vocabulary grew or the markup stopped using it:\n{}",
596 unused.len(),
597 generated.len(),
598 high_water,
599 unused
600 .iter()
601 .map(|c| format!(" .{c}"))
602 .collect::<Vec<_>>()
603 .join("\n")
604 );
605
606 if unused.len() < high_water {
607 println!(
608 "cargo::warning=dead makeover vocabulary is down to {} from a sealed {}; \
609 lower the seal so it cannot grow back",
610 unused.len(),
611 high_water
612 );
613 }
614 }
615
616 #[cfg(test)]
617 mod tests {
618 use super::*;
619
620 fn scratch(name: &str) -> PathBuf {
621 let dir =
622 std::env::temp_dir().join(format!("makeover-drift-{}-{name}", std::process::id()));
623 let _ = std::fs::remove_dir_all(&dir);
624 std::fs::create_dir_all(&dir).expect("create scratch");
625 dir
626 }
627
628 fn write(dir: &Path, name: &str, src: &str) {
629 if let Some(parent) = dir.join(name).parent() {
630 std::fs::create_dir_all(parent).unwrap();
631 }
632 std::fs::write(dir.join(name), src).unwrap();
633 }
634
635 fn declaring() -> String {
636 format!(
637 "const {CONST_NAME} = '{}';\n",
638 Density::Touch.media_condition()
639 )
640 }
641
642 #[test]
643 fn the_crates_own_string_passes() {
644 let dir = scratch("ok");
645 write(&dir, "touch.js", &declaring());
646 check_touch_density(&dir);
647 }
648
649 #[test]
650 #[should_panic(expected = "disagrees with makeover_geometry::Density")]
651 fn a_drifted_literal_fails() {
652 let dir = scratch("drift");
653 write(&dir, "touch.js", &declaring());
654 write(
655 &dir,
656 "haptics.js",
657 &format!("const {CONST_NAME} = '(pointer: coarse)';\n"),
658 );
659 check_touch_density(&dir);
660 }
661
662 #[test]
663 #[should_panic(expected = "device sniff")]
664 fn the_sniff_cannot_come_back() {
665 let dir = scratch("sniff");
666 write(&dir, "touch.js", &declaring());
667 write(&dir, "legacy.js", "if ('ontouchstart' in window) {}\n");
668 check_touch_density(&dir);
669 }
670
671 #[test]
672 #[should_panic(expected = "no TOUCH_DENSITY literal found")]
673 fn a_frontend_that_states_nothing_fails() {
674 let dir = scratch("empty");
675 write(&dir, "app.js", "export const x = 1;\n");
676 check_touch_density(&dir);
677 }
678
679 #[test]
680 fn a_use_site_is_not_a_declaration() {
681 // The const is read far more often than it is declared, and a read
682 // states no string. Counting one as a declaration would make the
683 // `found > 0` assertion pass on a frontend that only imports it.
684 let src =
685 format!("import {{ {CONST_NAME} }} from './touch.js';\nmatchMedia({CONST_NAME});\n");
686 assert!(touch_density_literals(&src).is_empty());
687 }
688
689 #[test]
690 fn nested_files_are_read() {
691 // The server keeps its scripts in subdirectories, and the nested half
692 // is the half most likely to be a copy.
693 let dir = scratch("nested");
694 write(&dir, "touch.js", &declaring());
695 write(&dir, "screens/legacy.js", "navigator.maxTouchPoints > 0;\n");
696 let files = js_files(&dir);
697 assert_eq!(files.len(), 2);
698 }
699
700 #[test]
701 fn a_non_js_file_is_ignored() {
702 let dir = scratch("nonjs");
703 write(&dir, "touch.js", &declaring());
704 write(&dir, "styles.css", "body { }\n");
705 assert_eq!(js_files(&dir).len(), 1);
706 }
707
708 fn frontend(name: &str) -> PathBuf {
709 let dir = scratch(name);
710 std::fs::create_dir_all(dir.join("css")).unwrap();
711 std::fs::create_dir_all(dir.join("js")).unwrap();
712 dir
713 }
714
715 /// A width every size class agrees is a boundary.
716 fn boundary() -> u16 {
717 SizeClass::Medium.min_px()
718 }
719
720 #[test]
721 fn the_crates_own_boundaries_pass() {
722 let dir = frontend("bp-ok");
723 write(
724 &dir,
725 "css/styles.css",
726 &format!("@media (min-width: {}px) {{ body {{ }} }}\n", boundary()),
727 );
728 check_breakpoints(&dir, &[]);
729 }
730
731 #[test]
732 #[should_panic(expected = "disagree with makeover_geometry::SizeClass")]
733 fn a_stale_css_width_fails() {
734 let dir = frontend("bp-css");
735 write(&dir, "css/styles.css", "@media (max-width: 768px) { }\n");
736 check_breakpoints(&dir, &[]);
737 }
738
739 #[test]
740 #[should_panic(expected = "disagree with makeover_geometry::SizeClass")]
741 fn a_stale_js_width_fails() {
742 let dir = frontend("bp-js");
743 write(&dir, "js/shell.js", "matchMedia('(max-width: 768px)');\n");
744 check_breakpoints(&dir, &[]);
745 }
746
747 #[test]
748 fn a_declared_tuning_width_passes() {
749 let dir = frontend("bp-tuning");
750 write(&dir, "css/styles.css", "@media (min-width: 1400px) { }\n");
751 check_breakpoints(&dir, &[1400]);
752 }
753
754 #[test]
755 fn a_width_in_a_comment_is_prose() {
756 // The note explaining which breakpoint used to be here is not a rule,
757 // and failing a build on documentation would teach people to delete it.
758 let dir = frontend("bp-comment");
759 write(
760 &dir,
761 "css/styles.css",
762 "/* was @media (max-width: 768px) until the size classes landed */\n",
763 );
764 check_breakpoints(&dir, &[]);
765 }
766
767 #[test]
768 fn an_unparenthesized_width_is_not_a_breakpoint() {
769 // A JS string building an inline style states `max-width: 320px` with
770 // no parentheses. It is a declaration, not a query, and the first
771 // version of this check failed the build on one.
772 let dir = frontend("bp-inline");
773 write(
774 &dir,
775 "js/style.js",
776 "el.style.cssText = 'max-width: 320px; display: block';\n",
777 );
778 check_breakpoints(&dir, &[]);
779 }
780
781 #[test]
782 fn nested_css_is_read() {
783 // Same argument as the touch check: the nested half is the half most
784 // likely to be a copy.
785 let dir = frontend("bp-nested");
786 write(
787 &dir,
788 "css/screens/detail.css",
789 "@media (max-width: 768px) { }\n",
790 );
791 let found = std::panic::catch_unwind(|| check_breakpoints(&dir, &[]));
792 assert!(found.is_err(), "a nested stylesheet must be scanned");
793 }
794
795 #[test]
796 fn a_named_list_is_checked() {
797 let dir = frontend("bp-list");
798 write(&dir, "css/style.css", "@media (max-width: 768px) { }\n");
799 let listed = dir.join("css/style.css");
800 let err =
801 std::panic::catch_unwind(|| check_breakpoints_files(&[&listed], &[])).unwrap_err();
802 let msg = err.downcast_ref::<String>().expect("String payload");
803 assert!(msg.contains("style.css:1"), "got: {msg}");
804 }
805
806 #[test]
807 #[should_panic(expected = "read ")]
808 fn a_listed_file_that_is_gone_fails() {
809 // The list is hand-maintained, so a path that stopped existing is a
810 // check quietly covering less than it claims. Louder than skipping it.
811 let dir = frontend("bp-missing");
812 check_breakpoints_files(&[dir.join("css/never-written.css")], &[]);
813 }
814
815 #[test]
816 fn a_listed_js_file_is_parsed_as_script() {
817 // The unparenthesized-declaration rule is what separates the two, and
818 // picking the parser off the extension is the whole difference.
819 let dir = frontend("bp-list-js");
820 write(
821 &dir,
822 "js/style.js",
823 "el.style.cssText = 'max-width: 320px';\n",
824 );
825 check_breakpoints_files(&[dir.join("js/style.js")], &[]);
826 }
827
828 #[test]
829 fn the_error_names_the_file_and_line() {
830 let dir = frontend("bp-message");
831 write(
832 &dir,
833 "css/styles.css",
834 "body { }\n@media (max-width: 768px) { }\n",
835 );
836 let err = std::panic::catch_unwind(|| check_breakpoints(&dir, &[])).unwrap_err();
837 let msg = err
838 .downcast_ref::<String>()
839 .expect("panic payload is a String");
840 assert!(msg.contains("css/styles.css:2"), "got: {msg}");
841 }
842
843 #[test]
844 fn a_rule_restating_a_generated_class_fails_and_names_it() {
845 let dir = scratch("vocab-clash");
846 // `.card` is makeover's. An app rule for it beats the generated one,
847 // because app CSS is unlayered and the generated sheet is not.
848 write(
849 &dir,
850 "css/styles.css",
851 "body { color: red; }\n.card { box-shadow: none; }\n",
852 );
853 let err = std::panic::catch_unwind(|| check_vocabulary(&dir, &Emit::default(), &[], &[]))
854 .unwrap_err();
855 let msg = err
856 .downcast_ref::<String>()
857 .expect("panic payload is a String");
858 assert!(msg.contains(".card"), "got: {msg}");
859 assert!(msg.contains("box-shadow"), "got: {msg}");
860 assert!(msg.contains("css/styles.css"), "got: {msg}");
861 }
862
863 #[test]
864 fn an_app_class_of_its_own_is_left_alone() {
865 let dir = scratch("vocab-clean");
866 write(
867 &dir,
868 "css/styles.css",
869 ".task-list-container { overflow: auto; }\n.day-plan-slot { height: 1rem; }\n",
870 );
871 check_vocabulary(&dir, &Emit::default(), &[], &[]);
872 }
873
874 #[test]
875 fn the_generated_sheet_is_skipped_rather_than_reported_against_itself() {
876 let dir = scratch("vocab-generated");
877 let opts = Emit::default();
878 write(&dir, "css/layout.css", &makeover_webview::stylesheet(&opts));
879 // Without the skip this is the loudest failure possible: every class in
880 // the vocabulary, reported as a clash with the vocabulary.
881 check_vocabulary(&dir, &opts, &["layout.css"], &[]);
882 }
883
884 #[test]
885 fn a_prefixed_app_is_checked_against_its_own_prefix() {
886 let dir = scratch("vocab-prefix");
887 let opts = Emit {
888 class_prefix: "mo-",
889 ..Emit::default()
890 };
891 // Bare `.card` is the app's own class once the generated sheet writes
892 // `.mo-card`, so this has to pass.
893 write(&dir, "css/styles.css", ".card { box-shadow: none; }\n");
894 check_vocabulary(&dir, &opts, &[], &[]);
895
896 let dir = scratch("vocab-prefix-clash");
897 write(&dir, "css/styles.css", ".mo-card { box-shadow: none; }\n");
898 assert!(std::panic::catch_unwind(|| check_vocabulary(&dir, &opts, &[], &[])).is_err());
899 }
900
901 #[test]
902 fn a_class_shared_without_a_shared_property_is_left_alone() {
903 let dir = scratch("vocab-additive");
904 // What goingson actually does: the generated `.badge` sets the text
905 // colour and the app sets the shape. Same class, no argument.
906 write(
907 &dir,
908 "css/styles.css",
909 ".badge { padding: 2px; border-radius: 3px; font-weight: 600; }\n",
910 );
911 check_vocabulary(&dir, &Emit::default(), &[], &[]);
912 }
913
914 #[test]
915 fn a_reviewed_pair_passes_and_stops_passing_when_it_stops_colliding() {
916 let dir = scratch("vocab-allowed");
917 write(&dir, "css/styles.css", ".card { box-shadow: none; }\n");
918 check_vocabulary(&dir, &Emit::default(), &[], &[("card", "box-shadow")]);
919
920 // The same licence against a sheet that no longer collides has to fail,
921 // or the list only ever grows.
922 let dir = scratch("vocab-allowed-stale");
923 write(&dir, "css/styles.css", ".card { padding: 2px; }\n");
924 let err = std::panic::catch_unwind(|| {
925 check_vocabulary(&dir, &Emit::default(), &[], &[("card", "box-shadow")]);
926 })
927 .unwrap_err();
928 let msg = err
929 .downcast_ref::<String>()
930 .expect("panic payload is a String");
931 assert!(msg.contains("no longer collides"), "got: {msg}");
932 }
933
934 #[test]
935 fn dead_vocabulary_above_the_seal_fails_and_below_it_passes() {
936 let dir = scratch("vocab-seal");
937 let opts = Emit::default();
938 let all = makeover_webview::vocabulary::names(&opts).len();
939 // Markup naming nothing: every class is unused.
940 write(&dir, "index.html", "<div></div>\n");
941 let markup = [dir.join("index.html")];
942
943 check_vocabulary_use(&markup, &opts, all);
944 assert!(
945 std::panic::catch_unwind(|| check_vocabulary_use(&markup, &opts, all - 1)).is_err(),
946 "a vocabulary deader than the seal has to fail"
947 );
948 }
949
950 #[test]
951 fn both_quote_styles_read() {
952 let want = Density::Touch.media_condition();
953 for q in ['\'', '"'] {
954 let src = format!("const {CONST_NAME} = {q}{want}{q};\n");
955 let found = touch_density_literals(&src);
956 assert_eq!(found.len(), 1);
957 assert_eq!(found[0].1, want);
958 }
959 }
960 }
961