knave 0.13.2

A Lisp programming language for humans and agents that infers types and ownership and compiles to readable Rust
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

use std::io;
use std::path::{Path, PathBuf};

use super::doc_folder::DocFolder;
use super::doc_pages::{DocumentedModules, EntryProgram};
use super::exit_status::ExitStatus;
use super::located_project::LocatedProject;
use super::program_file::ProgramFile;
use super::source_walk::SourceWalk;
use super::terminal::Terminal;
use crate::modules::{ModuleSources, PublicPrelude};

pub struct DocWriteCommand {
    output: Option<PathBuf>,
    scope: DocScope,
}

pub enum DocScope {
    Project,
    Prelude,
}

impl DocWriteCommand {
    pub const DEFAULT_FOLDER: &'static str = "doc";

    pub fn new(output: Option<PathBuf>, scope: DocScope) -> Self {
        Self { output, scope }
    }

    pub fn run(self, terminal: &mut Terminal) -> ExitStatus {
        match self.write(terminal) {
            Ok(status) | Err(status) => status,
        }
    }

    fn write(&self, terminal: &mut Terminal) -> Result<ExitStatus, ExitStatus> {
        let (folder, modules) = match self.scope {
            DocScope::Project => self.project_target(terminal)?,
            DocScope::Prelude => self.prelude_target(),
        };
        let folder = DocFolder::new(folder).writable()?;
        let pages = modules.pages(terminal)?;
        Ok(folder.replace_pages(&pages))
    }

    fn project_target(
        &self,
        terminal: &mut Terminal,
    ) -> Result<(PathBuf, DocumentedModules), ExitStatus> {
        let project =
            LocatedProject::search_from(Path::new(Terminal::WORKING_DIRECTORY), terminal)?
                .ok_or_else(LocatedProject::report_no_path)?;
        let folder = self.folder_in(project.root());
        let file = project.file_within(project.source_root().join(DocumentedModules::CALL_SOURCE));
        let modules = SourceWalk::of(&project).module_paths(terminal)?;
        let entry = project.entry();
        let text = Self::entry_text(entry.path())?;
        let entry = EntryProgram::new(entry, text);
        Ok((folder, DocumentedModules::new(file, entry, modules)))
    }

    fn entry_text(path: &Path) -> Result<String, ExitStatus> {
        match ModuleSources::read_file(path) {
            Ok(text) => Ok(text),
            Err(error) if error.kind() == io::ErrorKind::NotFound => Ok(String::new()),
            Err(error) => Err(Terminal::report_unreadable(path, &error)),
        }
    }

    fn prelude_target(&self) -> (PathBuf, DocumentedModules) {
        let root = LocatedProject::canonical_root(Path::new(Terminal::WORKING_DIRECTORY))
            .unwrap_or_default();
        let file = ProgramFile::beside_itself(PathBuf::from(DocumentedModules::CALL_SOURCE));
        let empty_entry = EntryProgram::new(file.clone(), String::new());
        let modules = DocumentedModules::new(file, empty_entry, PublicPrelude::paths());
        (self.folder_in(&root), modules)
    }

    fn folder_in(&self, root: &Path) -> PathBuf {
        self.output
            .clone()
            .unwrap_or_else(|| root.join(Self::DEFAULT_FOLDER))
    }
}