cargo-telar 0.2.3

Cargo subcommand for Telar apps: dev server with hot reload, and packaging into native installers.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
use super::*;
use geometry_core::Color;
use theme_core::{ThemeTokens, contrast_shortfalls};

fn temp_dir(name: &str) -> PathBuf {
    let dir = std::env::temp_dir().join(format!("cargo_telar_new_{name}_{}", std::process::id()));
    let _ = std::fs::remove_dir_all(&dir);
    std::fs::create_dir_all(&dir).unwrap();
    dir
}

fn generated_manifest(target: Target) -> toml::Table {
    toml::from_str(&manifest("my-app", target, WebRenderer::default()))
        .expect("generated manifest is not valid TOML")
}

#[test]
fn the_gitignore_covers_the_generated_telar_directory_at_any_depth() {
    let files = scaffold_files("my-app", Target::Web, WebRenderer::default());
    let (_, gitignore) = files
        .iter()
        .find(|(path, _)| *path == ".gitignore")
        .expect("a .gitignore is scaffolded");
    assert!(
        gitignore.lines().any(|line| line == ".telar/"),
        "`app!` also writes `src/.telar/`, which a root-anchored `/.telar` leaves tracked: {gitignore:?}"
    );
}

#[test]
fn every_target_writes_itself_as_the_default_feature() {
    for target in [Target::Desktop, Target::Tui, Target::Web, Target::Android] {
        let manifest = generated_manifest(target);
        let features = manifest["features"].as_table().expect("features table");
        let default = features["default"].as_array().expect("default array");
        assert_eq!(
            default[0].as_str(),
            Some(target.feature(WebRenderer::default())),
            "default does not name the chosen target"
        );
        // Every target stays one word away, whichever one the project started on.
        for name in ["desktop", "tui", "web", "android"] {
            assert!(features.contains_key(name), "`{name}` is missing");
        }
    }
}

#[test]
fn the_telar_dependency_names_no_target_of_its_own() {
    let manifest = generated_manifest(Target::Tui);
    let telar = &manifest["dependencies"]["telar"];
    assert_eq!(telar["default-features"].as_bool(), Some(false));
    let features: Vec<_> = telar["features"]
        .as_array()
        .expect("features array")
        .iter()
        .filter_map(|f| f.as_str())
        .collect();
    for target in ["desktop", "tui", "web", "android"] {
        assert!(
            !features.contains(&target),
            "`{target}` belongs under [features], not on the dependency"
        );
    }
}

#[test]
fn the_catalogue_is_its_own_dependency_with_no_group_named() {
    let manifest = generated_manifest(Target::Desktop);
    let dependencies = &manifest["dependencies"];
    let telar_features: Vec<_> = dependencies["telar"]["features"]
        .as_array()
        .expect("features array")
        .iter()
        .filter_map(|f| f.as_str())
        .collect();
    assert_eq!(telar_features, ["runtime"]);
    let components = &dependencies["telar-components"];
    assert_eq!(components["version"].as_str(), Some(TELAR_VERSION));
    assert_eq!(components["default-features"].as_bool(), Some(false));
    assert!(
        components.get("features").is_none(),
        "the scaffold's page draws only buttons, which every build of the catalogue has"
    );
}

/// `cargo telar dev` and `cargo telar preview` turn the overlay on only for a package that declares it, so a new project that did not would start its first dev session without one.
#[test]
fn the_devtools_are_an_optional_dependency_dev_sessions_turn_on() {
    for target in [Target::Desktop, Target::Tui, Target::Web, Target::Android] {
        let dir = temp_dir(&format!("devtools_{}", target_name(target)));
        std::fs::write(
            dir.join("Cargo.toml"),
            manifest("my-app", target, WebRenderer::default()),
        )
        .unwrap();
        let declared =
            telar_project::declares_optional_dependency(&dir, telar_project::DEVTOOLS_PACKAGE);
        let _ = std::fs::remove_dir_all(&dir);
        assert!(declared, "{}", target_name(target));
    }
    let manifest = generated_manifest(Target::Desktop);
    assert_eq!(
        manifest["dependencies"]["telar-devtools"]["version"].as_str(),
        Some(TELAR_VERSION),
        "plugins share the workspace version in lockstep"
    );
}

/// `cargo telar preview` turns the workshop on only for a package that declares it, and `cargo telar doctor` points at the same dependency.
#[test]
fn the_workshop_is_an_optional_dependency_previews_turn_on() {
    for target in [Target::Desktop, Target::Tui, Target::Web, Target::Android] {
        let dir = temp_dir(&format!("workshop_{}", target_name(target)));
        std::fs::write(
            dir.join("Cargo.toml"),
            manifest("my-app", target, WebRenderer::default()),
        )
        .unwrap();
        let declared =
            telar_project::declares_optional_dependency(&dir, telar_project::WORKSHOP_PACKAGE);
        let _ = std::fs::remove_dir_all(&dir);
        assert!(declared, "{}", target_name(target));
    }
    let manifest = generated_manifest(Target::Desktop);
    assert_eq!(
        manifest["dependencies"]["telar-workshop"]["version"].as_str(),
        Some(TELAR_VERSION)
    );
}

#[test]
fn every_rsx_file_sees_the_catalogue() {
    for target in [Target::Desktop, Target::Tui, Target::Web, Target::Android] {
        let config = toml::from_str::<toml::Table>(&config("my-app", target))
            .expect("generated telar.toml is not valid TOML");
        assert_eq!(
            config["telar"]["prelude"].as_array().map(Vec::as_slice),
            Some([toml::Value::from("telar_components")].as_slice())
        );
    }
}

#[test]
fn the_generated_config_parses() {
    for target in [Target::Desktop, Target::Tui, Target::Web, Target::Android] {
        toml::from_str::<toml::Table>(&config("my-app", target))
            .expect("generated telar.toml is not valid TOML");
    }
}

#[test]
fn a_name_that_would_not_compile_is_refused() {
    assert!(
        validate_name("my-app").is_ok(),
        "a hyphen is fine in a crate name"
    );
    assert!(
        validate_name("my_app2").is_ok(),
        "and so are underscores and digits"
    );
    assert!(
        validate_name("").is_err(),
        "an empty name is not a crate name"
    );
    assert!(
        validate_name("2fast").is_err(),
        "a leading digit is not a Rust identifier"
    );
    assert!(validate_name("my app").is_err(), "a space is not allowed");
    assert!(validate_name("my.app").is_err(), "nor is a dot");
}

#[test]
fn every_tooling_feature_is_named_where_the_lockfile_sees_it() {
    for target in [Target::Desktop, Target::Tui, Target::Web, Target::Android] {
        let manifest = generated_manifest(target);
        let features = manifest["features"].as_table().expect("features table");
        let tooling: Vec<_> = features["tooling"]
            .as_array()
            .expect("tooling array")
            .iter()
            .filter_map(|f| f.as_str())
            .collect();
        assert_eq!(tooling, crate::runner::config::TOOLING_FEATURES);
        assert!(
            !features["default"]
                .as_array()
                .expect("default array")
                .iter()
                .any(|f| f.as_str() == Some("tooling")),
            "`tooling` exists for the lockfile, never for a build"
        );
    }
}

#[test]
fn a_web_project_starts_on_the_document_renderer() {
    let manifest =
        toml::from_str::<toml::Table>(&manifest("my-app", Target::Web, WebRenderer::Dom))
            .expect("generated manifest is not valid TOML");
    let features = manifest["features"].as_table().expect("features table");
    let default = features["default"].as_array().expect("default array");
    assert_eq!(default[0].as_str(), Some("web-dom"));
    assert!(
        features.contains_key("web-dom"),
        "`web-dom` needs its own entry, whichever renderer is the default"
    );
}

#[test]
fn the_canvas_renderer_writes_web_as_the_default() {
    let manifest =
        toml::from_str::<toml::Table>(&manifest("my-app", Target::Web, WebRenderer::Canvas))
            .expect("generated manifest is not valid TOML");
    let features = manifest["features"].as_table().expect("features table");
    let default = features["default"].as_array().expect("default array");
    assert_eq!(default[0].as_str(), Some("web"));
}

#[test]
fn only_the_web_target_gets_a_profile_web() {
    for target in [Target::Desktop, Target::Tui, Target::Web, Target::Android] {
        let manifest = generated_manifest(target);
        let has_profile_web = manifest
            .get("profile")
            .and_then(|p| p.as_table())
            .is_some_and(|p| p.contains_key("web"));
        assert_eq!(
            has_profile_web,
            target == Target::Web,
            "[profile.web] should exist for a web target only"
        );
    }
}

#[test]
fn profile_web_matches_the_one_release_web_builds_are_checked_against() {
    let manifest = generated_manifest(Target::Web);
    let profile = manifest["profile"]["web"]
        .as_table()
        .expect("[profile.web] table");
    assert_eq!(profile["inherits"].as_str(), Some("release"));
    assert_eq!(profile["opt-level"].as_str(), Some("z"));
    assert_eq!(profile["panic"].as_str(), Some("abort"));
}

#[test]
fn init_scaffolds_into_a_directory_that_already_has_unrelated_files() {
    let dir = temp_dir("init_nonempty");
    std::fs::write(dir.join("README.md"), "hello\n").unwrap();
    std::fs::create_dir_all(dir.join(".git")).unwrap();

    let files = scaffold_files("my-app", Target::Desktop, WebRenderer::default());
    assert!(
        conflicts_in(&dir, &files).is_empty(),
        "an unrelated README and .git should never conflict with the scaffold"
    );
    write_all(&dir, &files);
    assert!(dir.join("Cargo.toml").exists());
    assert!(dir.join("README.md").exists(), "unrelated file is kept");
}

#[test]
fn init_refuses_to_overwrite_a_file_it_would_itself_write() {
    let dir = temp_dir("init_conflict");
    std::fs::write(dir.join("Cargo.toml"), "[package]\nname = \"other\"\n").unwrap();
    std::fs::create_dir_all(dir.join("src")).unwrap();
    std::fs::write(dir.join("src/lib.rs"), "// mine\n").unwrap();

    let files = scaffold_files("my-app", Target::Desktop, WebRenderer::default());
    let conflicts = conflicts_in(&dir, &files);
    assert!(conflicts.contains(&"Cargo.toml"));
    assert!(conflicts.contains(&"src/lib.rs"));
    assert!(
        !conflicts.contains(&"telar.toml"),
        "a file that is not there yet is not a conflict"
    );

    let original = std::fs::read_to_string(dir.join("Cargo.toml")).unwrap();
    assert_eq!(
        original, "[package]\nname = \"other\"\n",
        "an existing Cargo.toml is refused, never merged or overwritten"
    );
}

#[test]
fn init_derives_the_package_name_from_the_current_directory_when_the_path_is_a_dot() {
    let name = name_from_path(Path::new("."), || Some(PathBuf::from("/wherever/my-app")));
    assert_eq!(name.as_deref(), Some("my-app"));
}

#[test]
fn a_real_path_names_itself_without_asking_for_the_current_directory() {
    let name = name_from_path(Path::new("projects/my-app"), || {
        panic!("a non-dot path should never need the current directory")
    });
    assert_eq!(name.as_deref(), Some("my-app"));
}

/// A library published with cargo's default file list ships no `.telar/`, and a crate no build can compile; the scaffold has to start with the list `cargo telar package` checks against.
#[test]
fn a_library_scaffold_includes_the_artifact_it_ships() {
    let files = library_files("my-kit");
    let manifest = files
        .iter()
        .find(|(path, _)| *path == "Cargo.toml")
        .map(|(_, content)| toml::from_str::<toml::Table>(content).expect("valid TOML"))
        .expect("a Cargo.toml is scaffolded");
    let include: Vec<&str> = manifest["package"]["include"]
        .as_array()
        .expect("an include list")
        .iter()
        .filter_map(|entry| entry.as_str())
        .collect();
    assert_eq!(include, telar_project::library_include());
    assert_eq!(
        manifest["dependencies"]["telar"]["version"].as_str(),
        Some(format!("={TELAR_VERSION}").as_str()),
        "a library's artifact is accepted only by the telar it was transpiled for"
    );
}

/// Without the macro `cargo telar test` has no test to run in a library, and refuses the run.
#[test]
fn a_library_scaffold_has_its_previews_tested() {
    let files = library_files("my-kit");
    let lib_rs = files
        .iter()
        .find(|(path, _)| *path == "src/lib.rs")
        .map(|(_, content)| content.as_str())
        .expect("a src/lib.rs is scaffolded");
    assert_eq!(lib_rs.matches("telar::library_previews!();").count(), 1);
}

#[test]
fn a_library_scaffold_declares_itself_a_library_and_transpiles() {
    let dir = temp_dir("library");
    let files = library_files("my-kit");
    write_all(&dir, &files);
    let manifest =
        telar_project::TelarManifest::load(&dir).expect("the scaffolded telar.toml parses");
    let transpiled = super::super::transpile::transpile_member(&dir, "test", TELAR_VERSION);
    let index = telar_project::read_build_index(&dir, telar_project::BuildFlavour::Plain);
    let _ = std::fs::remove_dir_all(&dir);

    assert!(manifest.telar.library);
    assert!(transpiled, "the scaffolded component transpiles");
    assert_eq!(index.expect("a Plain index").entries.len(), 1);
}

#[test]
fn a_library_takes_no_target() {
    use clap::Parser;
    let parse = |args: &[&str]| {
        super::super::cli::Cli::try_parse_from(
            std::iter::once("cargo-telar").chain(args.iter().copied()),
        )
    };
    assert!(parse(&["new", "kit", "--lib"]).is_ok());
    assert!(parse(&["new", "kit", "--lib", "--target", "web"]).is_err());
    assert!(parse(&["init", "--lib"]).is_ok());
}

fn scaffold_theme() -> String {
    scaffold_files("my-app", Target::Web, WebRenderer::default())
        .into_iter()
        .find(|(path, _)| *path == "src/theme.rs")
        .map(|(_, source)| source)
        .expect("the scaffold writes src/theme.rs")
}

fn theme_color(source: &str, mode: &str, field: &str) -> Color {
    let start = source
        .find(&format!("pub fn {mode}() -> Self"))
        .expect("the theme defines the mode");
    let body = &source[start..];
    let body = &body[..body.find("\n    }\n").expect("the mode ends")];
    let value = body
        .lines()
        .find_map(|line| line.trim().strip_prefix(&format!("{field}: ")))
        .expect("the mode sets the field")
        .trim_end_matches(',');
    if value == "Color::WHITE" {
        return Color::WHITE;
    }
    let channels: Vec<f32> = value
        .strip_prefix("Color::rgba(")
        .and_then(|args| args.strip_suffix(')'))
        .expect("the field is a literal Color::rgba")
        .split(',')
        .map(|channel| channel.trim().parse().expect("a number"))
        .collect();
    let [r, g, b, a] = channels[..] else {
        panic!("{field} has {} channels, not four", channels.len());
    };
    Color::rgba(r, g, b, a)
}

/// One mode of the scaffold's theme, read back from the source it writes: every colour the scaffold sets answers its token, and the rest follow from them as they do for an application's own theme.
struct ScaffoldMode {
    source: String,
    mode: &'static str,
}

impl ScaffoldMode {
    fn color(&self, field: &str) -> Color {
        theme_color(&self.source, self.mode, field)
    }
}

impl ThemeTokens for ScaffoldMode {
    fn primary(&self) -> Color {
        self.color("primary")
    }
    fn on_primary(&self) -> Color {
        self.color("on_primary")
    }
    fn surface(&self) -> Color {
        self.color("surface")
    }
    fn surface_alt(&self) -> Color {
        self.color("surface_alt")
    }
    fn border(&self) -> Color {
        self.color("border")
    }
    fn ink(&self) -> Color {
        self.color("ink")
    }
    fn muted(&self) -> Color {
        self.color("muted")
    }
    fn success(&self) -> Color {
        self.color("success")
    }
    fn warning(&self) -> Color {
        self.color("warning")
    }
    fn error(&self) -> Color {
        self.color("error")
    }
    fn on_error(&self) -> Color {
        self.color("on_error")
    }
    fn info(&self) -> Color {
        self.color("info")
    }
}

#[test]
fn the_scaffold_theme_reaches_every_minimum_of_the_contrast_table_in_both_modes() {
    let source = scaffold_theme();
    let shortfalls: Vec<String> = ["light", "dark"]
        .into_iter()
        .flat_map(|mode| {
            contrast_shortfalls(ScaffoldMode {
                source: source.clone(),
                mode,
            })
            .into_iter()
            .map(move |shortfall| format!("{mode}: {shortfall}"))
        })
        .collect();
    assert!(shortfalls.is_empty(), "{shortfalls:#?}");
}