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 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184
//! <div align="center"> //! <h1>🩺 doctor</h1> //! <p> //! <strong>Fast and flexible low level parser for JavaDoc-style doc comments.</strong> //! </p> //! <p> //! <a href="https://crates.io/crates/doctor"><img alt="crates.io" src="https://meritbadge.herokuapp.com/doctor"/></a> //! <a href="https://docs.rs/doctor"><img alt="docs.rs" src="https://docs.rs/doctor/badge.svg"/></a> //! </p> //! </div> //! //! ## Example //! //! ```rust //! use doctor::parse; //! use doctor::ast::{DocComment, Description, BodyItem, BlockTag, InlineTag}; //! //! assert_eq!( //! parse( //! r#"/** //! * This is a doc comment. //! * It contains an {@inlineTag with some body} in its description. //! * //! * @blockTag1 //! * @blockTag2 with body text //! * @blockTag3 with body text and {@inlineTag} //! */"# //! ), //! Ok(DocComment { //! description: Some(Description { //! body_items: vec![ //! BodyItem::TextSegment("This is a doc comment.\n"), //! BodyItem::TextSegment("It contains an "), //! BodyItem::InlineTag(InlineTag { //! name: "inlineTag", //! body_lines: vec!["with some body"], //! }), //! BodyItem::TextSegment("in its description.\n"), //! BodyItem::TextSegment("\n"), //! ] //! }), //! block_tags: vec![ //! BlockTag { //! name: "blockTag1", //! body_items: vec![] //! }, //! BlockTag { //! name: "blockTag2", //! body_items: vec![BodyItem::TextSegment("with body text\n"),] //! }, //! BlockTag { //! name: "blockTag3", //! body_items: vec![ //! BodyItem::TextSegment("with body text and "), //! BodyItem::InlineTag(InlineTag { //! name: "inlineTag", //! body_lines: vec![] //! }), //! BodyItem::TextSegment("\n"), //! ] //! }, //! ] //! }) //! ); //! ``` //! For additional info check the [documentation](https://docs.rs/doctor). //! //! ## 🔮 Design Goals //! //! - The crate is agnostic from the concrete set of valid tags so that more high-level parsers (JSDoc, TSDoc, etc.) can be built on top of it. //! - The parser tries to allocate as little memory as possible to ensure great performance, //! so the AST format is designed to use slices of the input data as much as possible. //! //! ## 👯 Contributing //! //! Please check [the contributing documentation](./CONTRIBUTING.md) //! #![warn(clippy::all, clippy::pedantic, clippy::nursery, clippy::cargo)] pub mod ast; pub mod error; mod parsers; use nom::error::convert_error; use nom::Finish; use ast::DocComment; use error::Error; #[cfg(feature = "serde")] #[macro_use] extern crate serde; /// Parses `input` into a `DocComment` struct representing the doc comment's AST. /// /// # Examples /// /// ``` /// use doctor::parse; /// use doctor::ast::{DocComment, Description, BodyItem, InlineTag, BlockTag}; /// /// assert_eq!( /// parse(r#"/** /// * This is a doc comment. /// * It contains an {@inlineTag with some body} in its description. /// * /// * @blockTag1 /// * @blockTag2 with body text /// * @blockTag3 with body text and {@inlineTag} /// */"# /// ), /// Ok(DocComment { /// description: Some(Description { /// body_items: vec![ /// BodyItem::TextSegment("This is a doc comment.\n"), /// BodyItem::TextSegment("It contains an "), /// BodyItem::InlineTag(InlineTag { /// name: "inlineTag", /// body_lines: vec!["with some body"], /// }), /// BodyItem::TextSegment("in its description.\n"), /// BodyItem::TextSegment("\n"), /// ] /// }), /// block_tags: vec![ /// BlockTag { /// name: "blockTag1", /// body_items: vec![] /// }, /// BlockTag { /// name: "blockTag2", /// body_items: vec![BodyItem::TextSegment("with body text\n"),] /// }, /// BlockTag { /// name: "blockTag3", /// body_items: vec![ /// BodyItem::TextSegment("with body text and "), /// BodyItem::InlineTag(InlineTag { /// name: "inlineTag", /// body_lines: vec![] /// }), /// BodyItem::TextSegment("\n"), /// ] /// }, /// ] /// }), /// ); /// ``` /// /// # Errors /// /// If `input` is not a valid doc comment, an error explaining where the parsing failed is returned. /// pub fn parse(input: &str) -> Result<DocComment, Error> { parsers::doc_comment(input) .finish() .map(|(_, doc)| doc) .map_err(|err| Error::ParseError(convert_error(input, err))) } #[cfg(test)] mod tests { use super::*; #[test] fn test_parse_invalid() { assert_eq!( parse("/** Comment */ not comment"), Err(Error::ParseError( r#"0: at line 1, in Eof: /** Comment */ not comment ^ 1: at line 1, in doc_comment: /** Comment */ not comment ^ "# .to_owned() )) ) } }