rune/cli/
ace.rs

Help
1use std::io::Write;
2use std::path::PathBuf;
3
4use crate::doc::Artifacts;
5
6use anyhow::{Context, Result};
7use clap::Parser;
8
9use crate::alloc::prelude::*;
10use crate::alloc::Vec;
11use crate::cli::naming::Naming;
12use crate::cli::{AssetKind, CommandBase, Config, Entry, EntryPoint, ExitCode, Io, SharedFlags};
13use crate::compile::FileSourceLoader;
14use crate::{Diagnostics, Options, Source, Sources};
15
16#[derive(Parser, Debug)]
17pub(super) struct Flags {
18    /// Output directory to write ace extensions to.
19    #[arg(long)]
20    output: Option<PathBuf>,
21    /// Generate .await and ? extension for functions.
22    #[arg(long)]
23    extensions: bool,
24    /// Do not include `rune-mode.js`.
25    #[arg(long)]
26    no_mode: bool,
27    /// Exit with a non-zero exit-code even for warnings
28    #[arg(long)]
29    warnings_are_errors: bool,
30}
31
32impl CommandBase for Flags {
33    #[inline]
34    fn is_workspace(&self, _: AssetKind) -> bool {
35        true
36    }
37
38    #[inline]
39    fn describe(&self) -> &str {
40        "Documenting"
41    }
42}
43
44pub(super) fn run<'p, I>(
45    io: &mut Io<'_>,
46    entry: &mut Entry<'_>,
47    c: &Config,
48    flags: &Flags,
49    shared: &SharedFlags,
50    options: &Options,
51    entries: I,
52) -> Result<ExitCode>
53where
54    I: IntoIterator<Item = EntryPoint<'p>>,
55{
56    let root = match &flags.output {
57        Some(root) => root.clone(),
58        None => match &c.manifest_root {
59            Some(path) => path.join("target").join("rune-ace"),
60            None => match std::env::var_os("CARGO_TARGET_DIR") {
61                Some(target) => {
62                    let mut target = PathBuf::from(target);
63                    target.push("rune-ace");
64                    target
65                }
66                None => {
67                    let mut target = PathBuf::new();
68                    target.push("target");
69                    target.push("rune-ace");
70                    target
71                }
72            },
73        },
74    };
75
76    writeln!(io.stdout, "Building ace autocompletion: {}", root.display())?;
77
78    let context = shared.context(entry, c, None)?;
79
80    let mut visitors = Vec::new();
81
82    let mut naming = Naming::default();
83
84    for e in entries {
85        let item = naming.item(&e)?;
86
87        let mut visitor = crate::doc::Visitor::new(&item)?;
88        let mut sources = Sources::new();
89
90        let source = match Source::from_path(e.path()) {
91            Ok(source) => source,
92            Err(error) => return Err(error).context(e.path().display().try_to_string()?),
93        };
94
95        sources.insert(source)?;
96
97        let mut diagnostics = if shared.warnings || flags.warnings_are_errors {
98            Diagnostics::new()
99        } else {
100            Diagnostics::without_warnings()
101        };
102
103        let mut source_loader = FileSourceLoader::new();
104
105        let _ = crate::prepare(&mut sources)
106            .with_context(&context)
107            .with_diagnostics(&mut diagnostics)
108            .with_options(options)
109            .with_visitor(&mut visitor)?
110            .with_source_loader(&mut source_loader)
111            .build();
112
113        diagnostics.emit(&mut io.stdout.lock(), &sources)?;
114
115        if diagnostics.has_error() || flags.warnings_are_errors && diagnostics.has_warning() {
116            return Ok(ExitCode::Failure);
117        }
118
119        visitors.try_push(visitor)?;
120    }
121
122    let mut artifacts = Artifacts::new();
123    crate::ace::build_autocomplete(&mut artifacts, &context, &visitors, flags.extensions)?;
124
125    if !flags.no_mode {
126        crate::ace::theme(&mut artifacts)?;
127    }
128
129    for asset in artifacts.assets() {
130        asset.build(&root)?;
131    }
132
133    Ok(ExitCode::Success)
134}
rune/cli/ace.rs

rune/cli/
ace.rs
