cosy 0.1.0

A parser for Cosense/Scrapbox markup syntax that produces a typed AST
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

use crate::ast::{Block, BlockContent, ShellPrompt};
use winnow::Result as PResult;
use winnow::ascii::{line_ending, till_line_ending};
use winnow::combinator::opt;
use winnow::error::ContextError;
use winnow::prelude::*;
use winnow::token::any;

pub fn parse_commandline<T>(input: &mut &str, indent: usize) -> PResult<Block<T>> {
    // Determine prompt from the first character.
    let prompt = match input.chars().next() {
        Some('$') => ShellPrompt::Dollar,
        Some('%') => ShellPrompt::Percent,
        _ => return Err(ContextError::new()),
    };

    // Consume the prompt character
    let _ = any.parse_next(input)?;
    // Consume mandatory space
    let _ = any.parse_next(input)?;

    let content = till_line_ending.parse_next(input)?;
    let _ = opt(line_ending).parse_next(input)?;

    Ok(Block {
        indent,
        content: BlockContent::CommandLine {
            prompt,
            command: content.to_string(),
        },
    })
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::ast::*;

    #[test]
    fn parse_commandline_basic_with_newline() {
        let mut input = "$ cargo build\n";
        let result = parse_commandline::<()>(&mut input, 0);
        assert!(result.is_ok());
        let block = result.unwrap();
        assert_eq!(block.indent, 0);
        assert_eq!(
            block.content,
            BlockContent::CommandLine {
                prompt: ShellPrompt::Dollar,
                command: "cargo build".to_string(),
            }
        );
    }

    #[test]
    fn parse_commandline_no_newline() {
        let mut input = "$ ls -la";
        let result = parse_commandline::<()>(&mut input, 0);
        assert!(result.is_ok());
        let block = result.unwrap();
        assert_eq!(
            block.content,
            BlockContent::CommandLine {
                prompt: ShellPrompt::Dollar,
                command: "ls -la".to_string(),
            }
        );
    }

    #[test]
    fn parse_commandline_empty_command() {
        let mut input = "$ \n";
        let result = parse_commandline::<()>(&mut input, 0);
        assert!(result.is_ok());
        let block = result.unwrap();
        assert_eq!(
            block.content,
            BlockContent::CommandLine {
                prompt: ShellPrompt::Dollar,
                command: "".to_string(),
            }
        );
    }

    #[test]
    fn parse_commandline_indented() {
        let mut input = "$ echo hello\n";
        let result = parse_commandline::<()>(&mut input, 2);
        assert!(result.is_ok());
        let block = result.unwrap();
        assert_eq!(block.indent, 2);
        assert_eq!(
            block.content,
            BlockContent::CommandLine {
                prompt: ShellPrompt::Dollar,
                command: "echo hello".to_string(),
            }
        );
    }

    #[test]
    fn parse_csh_commandline_basic() {
        let mut input = "% ls -la\n";
        let result = parse_commandline::<()>(&mut input, 0);
        assert!(result.is_ok());
        let block = result.unwrap();
        assert_eq!(
            block.content,
            BlockContent::CommandLine {
                prompt: ShellPrompt::Percent,
                command: "ls -la".to_string(),
            }
        );
    }

    #[test]
    fn parse_csh_commandline_indented() {
        let mut input = "% echo hello\n";
        let result = parse_commandline::<()>(&mut input, 1);
        assert!(result.is_ok());
        let block = result.unwrap();
        assert_eq!(block.indent, 1);
        assert_eq!(
            block.content,
            BlockContent::CommandLine {
                prompt: ShellPrompt::Percent,
                command: "echo hello".to_string(),
            }
        );
    }

    #[test]
    fn parse_commandline_special_chars_not_parsed() {
        let mut input = "$ git commit -m \"[fix] bug\"\n";
        let result = parse_commandline::<()>(&mut input, 0);
        assert!(result.is_ok());
        let block = result.unwrap();
        assert_eq!(
            block.content,
            BlockContent::CommandLine {
                prompt: ShellPrompt::Dollar,
                command: "git commit -m \"[fix] bug\"".to_string(),
            }
        );
    }
}