Skip to main content

rl_lang/docs/entries/concepts/tooling/
mod.rs

1use crate::docs::entry::{ConceptCategory, ConceptEntry, DescriptionEntry, DescriptionKind};
2
3pub static TOOLING: ConceptEntry = ConceptEntry {
4    name: "tooling",
5    descriptions: &[
6        DescriptionEntry {
7            description: "rl run <file> runs a .rl source file",
8            examples: &["rl run main.rl"],
9            kind: DescriptionKind::Explanation,
10            title: None,
11            expected_output: &[],
12        },
13        DescriptionEntry {
14            description: "rl check <file> type-checks a file and reports errors without running it",
15            examples: &["rl check main.rl"],
16            kind: DescriptionKind::Explanation,
17            title: None,
18            expected_output: &[],
19        },
20        DescriptionEntry {
21            description: "rl repl starts an interactive session",
22            examples: &["rl repl"],
23            kind: DescriptionKind::Explanation,
24            title: None,
25            expected_output: &[],
26        },
27        DescriptionEntry {
28            description: "rl dev runs the project in the current directory using rl.toml",
29            examples: &["rl dev"],
30            kind: DescriptionKind::Explanation,
31            title: None,
32            expected_output: &[],
33        },
34        DescriptionEntry {
35            description: "rl new <name> scaffolds a new project directory with rl.toml and main.rl",
36            examples: &["rl new my-project"],
37            kind: DescriptionKind::Explanation,
38            title: None,
39            expected_output: &[],
40        },
41        DescriptionEntry {
42            description: "rl docs [topic] shows language reference and stdlib documentation",
43            examples: &["rl docs", "rl docs byte"],
44            kind: DescriptionKind::Explanation,
45            title: None,
46            expected_output: &[],
47        },
48    ],
49    summary: "",
50    category: ConceptCategory::Syntax,
51    prerequisites: &[],
52    pitfalls: &[],
53    related: &[],
54    related_stdlib: &[],
55    since: None,
56};