ef700b0 · htmlang · git.iko.soy

git.iko.soy/htmlang

on master help sign in

Remove @assert and @warn

ef700b0iko2 weeks ago

DESIGN.md+1−6

compare with master

unifiedsplit

@@ -331,11 +331,6 @@ as `var(--name)` in the generated CSS:

331@el [background $--brand] Themed

332```

333

334−### Checks

335−

336−`@assert CONDITION` fails the build when false. `@warn MESSAGE` emits a

337−warning.

338−

339## Expressions

334## Expressions

340

335

341Conditions and computed values (`@let x = ...`) are expressions:

336Conditions and computed values (`@let x = ...`) are expressions:

@@ -482,7 +477,7 @@ removed form with its replacement.

482| `@scope`, `@starting-style`, `@css-property` | The CSS rule in `@style` |

477| `@scope`, `@starting-style`, `@css-property` | The CSS rule in `@style` |

483| `@lang`, `@favicon`, `@canonical`, `@base` | `@page [lang ..., favicon ..., canonical ..., base ...] Title` |

478| `@lang`, `@favicon`, `@canonical`, `@base` | `@page [lang ..., favicon ..., canonical ..., base ...] Title` |

484| `@og KEY VALUE` | `@meta og:KEY VALUE` |

479| `@og KEY VALUE` | `@meta og:KEY VALUE` |

485−| `@debug`, `@log` | `@warn` |

480+| `@assert`, `@warn`, `@debug`, `@log` | Nothing (the lines are removed) |

486| `@defer` | Its content, directly |

481| `@defer` | Its content, directly |

487| `@col`, `@p`, `@img`, `@li`, `@btn`, `@ul`, `@divider`, `@opt` | `@column`, `@paragraph`, `@image`, `@item`, `@button`, `@list`, `@hr`, `@option` |

482| `@col`, `@p`, `@img`, `@li`, `@btn`, `@ul`, `@divider`, `@opt` | `@column`, `@paragraph`, `@image`, `@item`, `@button`, `@list`, `@hr`, `@option` |

488| `type email`, `id main` (HTML attributes written as styles) | `type=email`, `id=main` |

483| `type email`, `id main` (HTML attributes written as styles) | `type=email`, `id=main` |

crates/htmlang-core/src/parser.rs+4−35

@@ -497,22 +497,6 @@ impl Evaluator {

497

498

499

500− // --- @assert directive (compile-time assertions) ---

501−

502− if let Some(rest) = content.strip_prefix("@assert ") {

503− let rest = rest.trim();

504− if !ctx.condition(rest, line_num) {

505− ctx.diagnostics.push(Diagnostic {

506− line: line_num,

507− column: None,

508− message: format!("assertion failed: {}", rest),

509− severity: Severity::Error,

510− source_line: Some(content.clone()),

511− });

512− }

513− return Ok(None);

514− }

515−

516 if let Some(rest) = content.strip_prefix("@include ") {

500 if let Some(rest) = content.strip_prefix("@include ") {

517 let rest = rest.trim();

501 let rest = rest.trim();

518 let (filename, alias) = if let Some((file_part, alias_part)) = rest.rsplit_once(" as ")

502 let (filename, alias) = if let Some((file_part, alias_part)) = rest.rsplit_once(" as ")

@@ -871,21 +855,6 @@ impl Evaluator {

871

855

872 // --- @each loop ---

856 // --- @each loop ---

873

857

874− // --- @warn / @debug ---

875−

876− if let Some(rest) = content.strip_prefix("@warn ") {

877− let msg = substitute_vars(rest.trim(), &ctx.variables);

878− ctx.diagnostics.push(Diagnostic {

879− line: line_num,

880− column: None,

881− message: msg,

882− severity: Severity::Warning,

883− source_line: Some(content.clone()),

884− });

885− return Ok(None);

886− }

887−

888−

889 // --- @keyframes directive ---

858 // --- @keyframes directive ---

890

859

891 if let Some(rest) = content.strip_prefix("@keyframes ") {

860 if let Some(rest) = content.strip_prefix("@keyframes ") {

@@ -1546,8 +1515,6 @@ const KNOWN_DIRECTIVES: &[&str] = &[

1546 "meta",

1515 "meta",

1547 "head",

1516 "head",

1548 "style",

1517 "style",

1549− "warn",

1550− "assert",

1551 "markdown",

1518 "markdown",

1552 "data",

1519 "data",

1553];

1520];

@@ -1614,7 +1581,7 @@ const REMOVED_SYNTAX: &[(&str, &str)] = &[

1614 ("@canonical", "use `@page [canonical ...] Title`"),

1581 ("@canonical", "use `@page [canonical ...] Title`"),

1615 ("@base", "use `@page [base ...] Title`"),

1582 ("@base", "use `@page [base ...] Title`"),

1616 ("@og", "use `@meta og:NAME VALUE`"),

1583 ("@og", "use `@meta og:NAME VALUE`"),

1617− ("@debug", "use `@warn`"),

1584+ ("@debug", "removed: a layout needs no compile-time messages"),

1618 ("@svg", "use `@image [inline] file.svg`"),

1585 ("@svg", "use `@image [inline] file.svg`"),

1619 ("@match", "use `@if $x == a` / `@else if $x == b` / `@else`"),

1586 ("@match", "use `@if $x == a` / `@else if $x == b` / `@else`"),

1620 ("@case", "use `@if $x == a` / `@else if $x == b` / `@else`"),

1587 ("@case", "use `@if $x == a` / `@else if $x == b` / `@else`"),

@@ -1645,7 +1612,9 @@ const REMOVED_SYNTAX: &[(&str, &str)] = &[

1645 "put each locale's strings in a JSON file and use `@data $t locales/$lang.json`",

1612 "put each locale's strings in a JSON file and use `@data $t locales/$lang.json`",

1646 ),

1613 ),

1647 ("@defer", "remove it: the content is already in the page"),

1614 ("@defer", "remove it: the content is already in the page"),

1648− ("@log", "use `@warn`"),

1615+ ("@log", "removed: a layout needs no compile-time messages"),

1616+ ("@warn", "removed: a layout needs no compile-time messages"),

1617+ ("@assert", "removed: a layout needs no compile-time checks"),

1649 (

1618 (

1650 "@component",

1619 "@component",

1651 "use `@let`: an `@style` block in a function body is scoped to it",

1620 "use `@let`: an `@style` block in a function body is scoped to it",

crates/htmlang-core/src/syntax.rs+1−1

@@ -232,7 +232,7 @@ fn build(lines: &[Line], pos: &mut usize, parent: Option<usize>, plain: bool) ->

232

233/// Whether the lines indented under `text` belong to it.

234fn takes_body(text: &str) -> bool {

235− const ONE_LINE: &[&str] = &["@page", "@meta", "@warn", "@assert", "@data", "@include"];

235+ const ONE_LINE: &[&str] = &["@page", "@meta", "@data", "@include"];

236 let name = text.split([' ', '[']).next().unwrap_or("");

237 (text.starts_with('@') || text.starts_with('[')) && !ONE_LINE.contains(&name)

238}

examples/demo.hl+1−2

@@ -162,9 +162,8 @@

162 ]

163 $i

164

165− -- @if / @else if / @else (with @assert to verify at compile time)

165+ -- @if / @else if / @else

166 @let count 3

167− @assert $count == 3

168 @row [spacing 6, align-items center]

167 @row [spacing 6, align-items center]

169 @text [bold, min-width 64] Count:

168 @text [bold, min-width 64] Count:

170 @if $count == 0

169 @if $count == 0

src/bin/htmlang_lsp/docs.rs−2

@@ -108,8 +108,6 @@ pub(crate) const DIRECTIVES: &[Doc] = &[

108 "Repeats its body for each item of a list or range; `$_index` counts from 0.",

109 "@each $item in apple, banana\n @text $item\n@each $i in 1..10 step 2\n @text $i",

110 ),

111− doc("assert", "Fails the build when the condition is false.", "@assert $spacing == 16"),

112− doc("warn", "Emits a compile-time warning.", "@warn Remember to set a title"),

113 doc("data", "Loads a JSON file as variables.", "@data site.json"),

111 doc("data", "Loads a JSON file as variables.", "@data site.json"),

114];

112];

115

113

src/upgrade.rs+15−17

@@ -204,6 +204,17 @@ pub fn upgrade(input: &str) -> Upgrade {

204 continue;

205 }

206

207+ // Directives removed without a replacement: drop the line

208+ if attr_depth == 0

209+ && ["@assert ", "@warn ", "@debug ", "@log ", "@deprecated "]

210+ .iter()

211+ .any(|d| trimmed.starts_with(d) && !user_defined.contains(&&d[1..d.len() - 1]))

212+ {

213+ changes += 1;

214+ i += 1;

215+ continue;

216+ }

217+

207 // --- Line rewrites ---

218 // --- Line rewrites ---

208 let mut new_line = line.to_string();

219 let mut new_line = line.to_string();

209 if attr_depth == 0 {

220 if attr_depth == 0 {

@@ -688,16 +699,6 @@ fn rewrite_directive_line(

688 .unwrap_or(value);

699 .unwrap_or(value);

689 return format!("{pad}@meta og:{} {}", key, value);

700 return format!("{pad}@meta og:{} {}", key, value);

690 }

701 }

691− if let Some(rest) = trimmed.strip_prefix("@debug ") {

692− return format!("{pad}@warn {}", rest);

693− }

694− if let Some(rest) = trimmed.strip_prefix("@log ") {

695− let shown: Vec<String> = rest

696− .split_whitespace()

697− .map(|v| format!("{} = ${}", v.trim_start_matches('$'), v.trim_start_matches('$')))

698− .collect();

699− return format!("{pad}@warn {}", shown.join(", "));

700− }

701 // `@let x = $a ~ " " ~ $b` → `@let x "$a $b"` (`~` was removed:

702 // `@let x = $a ~ " " ~ $b` → `@let x "$a $b"` (`~` was removed:

702 // interpolated strings do the same)

703 // interpolated strings do the same)

703 if let Some(rest) = trimmed.strip_prefix("@let ")

704 if let Some(rest) = trimmed.strip_prefix("@let ")

@@ -805,9 +806,6 @@ fn rewrite_directive_line(

805 {pad}@head\n{pad} <link rel=\"preload\" href=\"{url}\" as=\"font\" crossorigin>"

806 {pad}@head\n{pad} <link rel=\"preload\" href=\"{url}\" as=\"font\" crossorigin>"

806 );

807 );

807 }

808 }

808− if trimmed.starts_with("@deprecated ") {

809− return String::new();

810− }

811 if trimmed.starts_with("@breakpoint ") {

809 if trimmed.starts_with("@breakpoint ") {

812 manual.push((

810 manual.push((

813 idx + 1,

811 idx + 1,

@@ -1209,7 +1207,7 @@ fn rename_filters(line: &str) -> String {

1209}

1207}

1210

1208

1211/// Turn `$name|filter:arg|...` chains into function calls: bare in

1209/// Turn `$name|filter:arg|...` chains into function calls: bare in

1212−/// expressions (`@if`, `@else if`, `@assert`, `@let x = ...`), and as

1210+/// expressions (`@if`, `@else if`, `@let x = ...`), and as

1213/// `${...}` interpolation everywhere else.

1211/// `${...}` interpolation everywhere else.

1214fn convert_filters(line: &str) -> String {

1212fn convert_filters(line: &str) -> String {

1215 let line = rename_filters(line);

1213 let line = rename_filters(line);

@@ -1217,7 +1215,7 @@ fn convert_filters(line: &str) -> String {

1217 return line;

1215 return line;

1218 }

1216 }

1219 let trimmed = line.trim_start();

1217 let trimmed = line.trim_start();

1220− let expression_line = ["@if ", "@else if ", "@assert "]

1218+ let expression_line = ["@if ", "@else if "]

1221 .iter()

1219 .iter()

1222 .any(|p| trimmed.starts_with(p))

1220 .any(|p| trimmed.starts_with(p))

1223 || trimmed

1221 || trimmed

@@ -1469,7 +1467,7 @@ mod tests {

1469 "@page [lang en, favicon /f.png] Home\n@text hi\n"

1467 "@page [lang en, favicon /f.png] Home\n@text hi\n"

1470 );

1468 );

1471 assert_eq!(up("@og title \"My Page\""), "@meta og:title My Page");

1469 assert_eq!(up("@og title \"My Page\""), "@meta og:title My Page");

1472− assert_eq!(up("@debug hi $x\n@log $a $b"), "@warn hi $x\n@warn a = $a, b = $b");

1470+ assert_eq!(up("@debug hi $x\n@log $a $b\n@assert $x == 1\n@warn hi\n@text x"), "@text x");

1473 assert_eq!(up("@component card $t\n @text $t"), "@let card $t\n @text $t");

1471 assert_eq!(up("@component card $t\n @text $t"), "@let card $t\n @text $t");

1474 assert_eq!(up("@el [color $on ? green : gray]"), "@el [color if($on, green, gray)]");

1472 assert_eq!(up("@el [color $on ? green : gray]"), "@el [color if($on, green, gray)]");

1475 let r = upgrade("@lang en\n@text hi");

1473 let r = upgrade("@lang en\n@text hi");

@@ -1554,7 +1552,7 @@ mod tests {

1554 up("@font-face Inter fonts/inter.woff2"),

1552 up("@font-face Inter fonts/inter.woff2"),

1555 "@style\n @font-face { font-family: 'Inter'; src: url('fonts/inter.woff2') format('woff2'); font-display: swap; }\n@head\n <link rel=\"preload\" href=\"fonts/inter.woff2\" as=\"font\" crossorigin>"

1553 "@style\n @font-face { font-family: 'Inter'; src: url('fonts/inter.woff2') format('woff2'); font-display: swap; }\n@head\n <link rel=\"preload\" href=\"fonts/inter.woff2\" as=\"font\" crossorigin>"

1556 );

1554 );

1557− assert_eq!(up("@deprecated old\n@let x 1"), "\n@let x 1");

1555+ assert_eq!(up("@deprecated old\n@let x 1"), "@let x 1");

1558 assert_eq!(upgrade("@breakpoint tablet 600").manual.len(), 1);

1556 assert_eq!(upgrade("@breakpoint tablet 600").manual.len(), 1);

1559 }

1557 }

1560

1558

tests/snapshots.rs−110

@@ -920,33 +920,6 @@ fn css_scroll_snap_align() {

920 assert!(output.contains("scroll-snap-align:center"));

921}

922

923−// ---------------------------------------------------------------------------

924−// Feature tests: @warn / @debug

925−// ---------------------------------------------------------------------------

926−

927−#[test]

928−fn warn_produces_diagnostic() {

929− let diags = parse_diagnostics("@warn Something is wrong");

930− assert!(

931− diags.iter().any(|d| d.message == "Something is wrong"

932− && d.severity == htmlang::parser::Severity::Warning),

933− "expected @warn diagnostic, got: {:?}",

934− diags

935− );

936−}

937−

938−#[test]

939−fn warn_substitutes_variables() {

940− let diags = parse_diagnostics("@let name test\n@warn Missing $name value");

941− assert!(

942− diags

943− .iter()

944− .any(|d| d.message.contains("Missing test value")),

945− "expected substituted @warn, got: {:?}",

946− diags

947− );

948−}

949−

950// ---------------------------------------------------------------------------

923// ---------------------------------------------------------------------------

951// Feature tests: image optimization hints

924// Feature tests: image optimization hints

952// ---------------------------------------------------------------------------

925// ---------------------------------------------------------------------------

@@ -3694,64 +3667,6 @@ fn no_warning_used_mixin() {

3694 );

3667 );

3695}

3668}

3696

3669

3697−// ---------------------------------------------------------------------------

3698−// @assert directive

3699−// ---------------------------------------------------------------------------

3700−

3701−#[test]

3702−fn snapshot_assert_directive() {

3703− snapshot_test("assert_directive");

3704−}

3705−

3706−#[test]

3707−fn assert_passes_no_error() {

3708− let diags = parse_diagnostics("@let x hello\n@assert $x == hello\n@el [padding 10]");

3709− assert!(

3710− !diags

3711− .iter()

3712− .any(|d| d.severity == htmlang::parser::Severity::Error),

3713− "passing assertion should produce no error, got: {:?}",

3714− diags

3715− );

3716−}

3717−

3718−#[test]

3719−fn assert_fails_produces_error() {

3720− let diags = parse_diagnostics("@let x hello\n@assert $x == world");

3721− assert!(

3722− diags

3723− .iter()

3724− .any(|d| d.severity == htmlang::parser::Severity::Error

3725− && d.message.contains("assertion failed")),

3726− "failing assertion should produce error, got: {:?}",

3727− diags

3728− );

3729−}

3730−

3731−#[test]

3732−fn assert_not_equal() {

3733− let diags = parse_diagnostics("@let x hello\n@assert $x != world\n@el");

3734− assert!(

3735− !diags

3736− .iter()

3737− .any(|d| d.severity == htmlang::parser::Severity::Error),

3738− "!= assertion should pass when values differ, got: {:?}",

3739− diags

3740− );

3741−}

3742−

3743−#[test]

3744−fn assert_truthy() {

3745− let diags = parse_diagnostics("@let x true\n@assert $x\n@el");

3746− assert!(

3747− !diags

3748− .iter()

3749− .any(|d| d.severity == htmlang::parser::Severity::Error),

3750− "truthy assertion should pass, got: {:?}",

3751− diags

3752− );

3753−}

3754−

3755// ---------------------------------------------------------------------------

3670// ---------------------------------------------------------------------------

3756// clamp() / min() / max() CSS functions

3671// clamp() / min() / max() CSS functions

3757// ---------------------------------------------------------------------------

3672// ---------------------------------------------------------------------------

@@ -4173,16 +4088,6 @@ fn test_error_circular_include() {

4173 );

4088 );

4174}

4089}

4175

4090

4176−#[test]

4177−fn test_error_assert_failure() {

4178− let diags = parse_diagnostics("@let x 5\n@assert $x == 10");

4179− assert!(

4180− diags.iter().any(|d| d.message.contains("assertion failed")

4181− && d.severity == htmlang::parser::Severity::Error),

4182− "should report assertion failure as error"

4183− );

4184−}

4185−

4186#[test]

4091#[test]

4187fn test_error_duplicate_attribute() {

4092fn test_error_duplicate_attribute() {

4188 let diags = parse_diagnostics("@el [padding 10, padding 20]\n Hello");

4093 let diags = parse_diagnostics("@el [padding 10, padding 20]\n Hello");

@@ -4250,21 +4155,6 @@ fn test_spread_define() {

4250 );

4155 );

4251}

4156}

4252

4157

4253−#[test]

4254−fn test_log_directive() {

4255− // @log should not produce errors and should be consumed without output nodes

4256− let result = htmlang::parser::parse("@let x hello\n@warn x = $x\n@text $x");

4257− assert!(

4258− result

4259− .diagnostics

4260− .iter()

4261− .all(|d| d.severity != htmlang::parser::Severity::Error),

4262− "@warn should = $should, not = $not, produce = $produce, errors = $errors"

4263− );

4264− let html = htmlang::codegen::generate(&result.document);

4265− assert!(!html.contains("@log"), "@warn should = $should, not = $not, appear = $appear, in = $in, output = $output");

4266−}

4267−

4268#[test]

4158#[test]

4269fn test_short_class_names() {

4159fn test_short_class_names() {

4270 let html = compile("@el [padding 10]\n @el [padding 20]\n Hello");

4160 let html = compile("@el [padding 10]\n @el [padding 20]\n Hello");

tests/snapshots/assert_directive.hldeleted−10

@@ -1,10 +0,0 @@

1−@page Assert Test

2−

3−@let spacing 16

4−@let primary #3b82f6

5−

6−@assert $spacing == 16

7−@assert $primary != red

8−

9−@el [padding $spacing, color $primary]

10− Assertions passed

tests/snapshots/assert_directive.htmldeleted−1

@@ -1 +0,0 @@

1−<!DOCTYPE html><html><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1"><title>Assert Test</title><style>@layer hl-reset,htmlang;@layer hl-reset{*,*::before,*::after{box-sizing:border-box}body{margin:0;font-family:system-ui,-apple-system,sans-serif}img{display:block}a{text-decoration:none;color:inherit}}@layer htmlang{.a{display:flex;flex-direction:column;padding:16px;color:#3b82f6;}}</style></head><body><div class="a"><span>Assertions passed</span></div></body></html>