asimov-cli 25.4.0

ASIMOV Command-Line Interface (CLI)
Documentation 
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

// This is free and unencumbered software released into the public domain.

use crate::{BoxError, StandardOptions};
use std::fs::exists;
use tracing::{error, warn};

pub async fn check(_flags: &StandardOptions) -> Result<(), BoxError> {
    if !exists(".asimov")? {
        error!("Missing ASIMOV configuration directory `{}/`.", ".asimov");
    }

    if !exists(".asimov/module.yaml")? {
        error!("Missing ASIMOV manifest file `{}`.", ".asimov/module.yaml");
    }

    if !exists(".cargo")? {
        warn!("Missing Cargo configuration directory `{}/`.", ".cargo");
    }

    if !exists(".cargo/config.toml")? {
        warn!(
            "Missing Cargo configuration file `{}`.",
            ".cargo/config.toml"
        );
    }

    for path in [".gitattributes", ".gitignore"] {
        if !exists(path)? {
            warn!("Missing Git configuration file `{}`.", path);
        }
    }

    for path in [".github", ".github/workflows"] {
        if !exists(path)? {
            warn!("Missing GitHub configuration directory `{}/`.", path);
        }
    }

    if !exists(".github/dependabot.yaml")? {
        warn!(
            "Missing Dependabot configuration file `{}`.",
            ".github/dependabot.yaml"
        );
    }

    for path in [
        ".github/workflows/ci.yaml",
        ".github/workflows/release.yaml",
    ] {
        if !exists(path)? {
            warn!("Missing GitHub Actions workflow file `{}`.", path);
        }
    }

    if !exists(".config")? {
        warn!("Missing general configuration directory `{}/`.", ".config");
    }

    if !exists(".config/mise.toml")? {
        warn!("Missing mise configuration file `{}`.", ".config/mise.toml");
    }

    if !exists(".config/readmer/")? {
        warn!(
            "Missing Readmer configuration directory `{}`.",
            ".config/readmer/"
        );
    }

    if !exists(".rustfmt.toml")? {
        warn!("Missing Rustfmt configuration file `{}`.", ".rustfmt.toml");
    }

    if !exists("AUTHORS")? {
        warn!("Missing authors file `{}`.", "AUTHORS");
    }

    if !exists("Cargo.toml")? {
        error!("Missing Cargo manifest file `{}`.", "Cargo.toml");
    }

    if !exists("CHANGES.md")? {
        warn!("Missing changelog file `{}`.", "CHANGES.md");
    }

    if !exists("Makefile")? {
        warn!("Missing Makefile `{}`.", "Makefile");
    }

    if !exists("README.md")? {
        warn!("Missing README file `{}`.", "README.md");
    }

    if !exists("UNLICENSE")? {
        warn!("Missing license file `{}`.", "UNLICENSE");
    }

    if !exists("VERSION")? {
        warn!("Missing version file `{}`.", "VERSION");
    }

    if !exists("etc/")? {
        warn!("Missing et cetera directory `{}`.", "etc/");
    }

    if !exists("src/")? {
        error!("Missing source code directory `{}`.", "src/");
    }

    Ok(())
}