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 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307
use crate::{
function::FunctionMetadata,
module::ModuleDocumentation, glossary::{ModuleGlossary, generate_module_glossary},
};
use super::{error::AutodocsError, generate_module_documentation};
pub const RHAI_FUNCTION_INDEX_PATTERN: &str = "# rhai-autodocs:index:";
/// Types of markdown processor where the documentation generated will be hosted.
#[derive(Default)]
pub enum MarkdownProcessor {
/// Generate documentation for mdbook: <https://rust-lang.github.io/mdBook/>
MdBook,
/// Generate documentation for docusaurus. <https://docusaurus.io/>
#[default]
Docusaurus,
}
#[derive(Default)]
/// Options to configure documentation generation.
pub struct Options {
pub(crate) functions_order: FunctionOrder,
pub(crate) sections_format: SectionFormat,
pub(crate) include_standard_packages: bool,
pub(crate) markdown_processor: MarkdownProcessor,
}
/// Create new options used to configure docs generation.
pub fn options() -> Options {
Options::default()
}
impl Options {
/// Include the standard package functions and modules documentation
/// in the generated documentation markdown.
pub fn include_standard_packages(mut self, include_standard_packages: bool) -> Self {
self.include_standard_packages = include_standard_packages;
self
}
/// Order functions in a specific way.
/// See [`FunctionOrder`] for more details.
pub fn order_functions_with(mut self, functions_order: FunctionOrder) -> Self {
self.functions_order = functions_order;
self
}
/// Format doc comments 'sections', markdown that starts with the `#` character,
/// with special formats.
/// See [`SectionFormat`] for more details.
pub fn format_sections_with(mut self, sections_format: SectionFormat) -> Self {
self.sections_format = sections_format;
self
}
/// Generate markdown code compatible for a specific markdown processor.
/// See [`MarkdownProcessor`] for more details.
pub fn for_markdown_processor(mut self, markdown_processor: MarkdownProcessor) -> Self {
self.markdown_processor = markdown_processor;
self
}
/// Generate documentation based on an engine instance.
/// Make sure all the functions, operators, plugins, etc. are registered inside this instance.
///
/// # Result
/// * A vector of documented modules.
///
/// # Errors
/// * Failed to generate function metadata as json.
/// * Failed to parse module metadata.
pub fn generate(self, engine: &rhai::Engine) -> Result<ModuleDocumentation, AutodocsError> {
generate_module_documentation(engine, &self)
}
/// Generate documentation based on an engine instance and a list of all functions signature.
/// Make sure all the functions, operators, plugins, etc. are registered inside this instance.
///
/// # Result
/// * A vector of documented modules and the glossary.
///
/// # Errors
/// * Failed to generate function metadata as json.
/// * Failed to parse module metadata.
pub fn generate_with_glossary(&self, engine: &rhai::Engine) -> Result<(ModuleDocumentation, ModuleGlossary), AutodocsError> {
Ok((
generate_module_documentation(engine, self)?,
generate_module_glossary(engine, self)?
))
}
}
#[derive(Default)]
/// Select in which order each functions will be displayed.
pub enum FunctionOrder {
/// Display functions by alphabetical order.
#[default]
Alphabetical,
/// Display functions by index using a pre-processing comment with the `# rhai-autodocs:index:<number>` syntax.
/// The `# rhai-autodocs:index:<number>` line will be removed in the final generated markdown.
///
/// # Example
///
/// ```ignore
/// /// Function that will appear first in docs.
/// ///
/// /// # rhai-autodocs:index:1
/// #[rhai_fn(global)]
/// pub fn my_function1() {}
///
/// /// Function that will appear second in docs.
/// ///
/// /// # rhai-autodocs:index:2
/// #[rhai_fn(global)]
/// pub fn my_function2() {}
/// ```
///
/// Adding, removing or re-ordering your functions from your api can be a chore
/// because you have to update all indexes by hand. Thankfully, you will found
/// a python script in the `scripts` folder of the `rhai-autodocs` repository
/// that will update the indexes by hand just for you.
///
/// The script generates a .autodocs file from your original source file,
/// make sure to check that it did not mess with your source code using
/// a diff tool.
ByIndex,
}
impl FunctionOrder {
/// Order functions following the [`FunctionOrder`] option.
pub(crate) fn order_function_groups<'a>(
&'_ self,
module_namespace: &str,
mut function_groups: Vec<(String, Vec<&'a FunctionMetadata>)>,
) -> Result<Vec<(String, Vec<&'a FunctionMetadata>)>, AutodocsError> {
match self {
FunctionOrder::Alphabetical => {
function_groups.sort_by(|(a, _), (b, _)| a.cmp(b));
Ok(function_groups)
}
FunctionOrder::ByIndex => {
let mut ordered = function_groups.clone();
'groups: for (function, polymorphisms) in &function_groups {
for comments in polymorphisms
.iter()
.filter_map(|item| item.doc_comments.as_ref())
{
if let Some((_, index)) = comments
.iter()
.find_map(|line| line.rsplit_once(RHAI_FUNCTION_INDEX_PATTERN))
{
let index = index
.parse::<usize>()
.map_err(|err| AutodocsError::PreProcessing(format!("failed to parsed order metadata: {err}")))?;
if let Some(slot) = ordered.get_mut(index - 1) {
*slot = (function.clone(), polymorphisms.clone());
} else {
return Err(AutodocsError::PreProcessing(format!(
"`# rhai-autodocs:index:?` index is out of bounds for the function `{function}`. It is probably because you set `# rhai-autodocs:index:?` for functions that are polymorphes of each other. Try to set your documentation only on one function of the group and add the `#[doc(hidden)]` pre-processor to the rest of the functions."
)));
}
continue 'groups;
}
}
return Err(AutodocsError::PreProcessing(format!(
"missing order metadata in function {module_namespace}/{function}")
));
}
Ok(ordered)
}
}
}
}
/// Options to format the display of sections marked with the `#`
/// tag in markdown.
#[derive(Default)]
pub enum SectionFormat {
/// Display sections the same as Rust doc comments, using the
/// default markdown titles.
#[default]
Rust,
/// Display sections using tabs that wraps all underlying
/// documentation in them.
///
/// NOTE: [`SectionFormat::fmt_sections`] is called after [`remove_test_code`],
/// so checking for code blocks and `#` line start is not required because it
/// was supposed to be removed.
Tabs,
}
impl SectionFormat {
pub(crate) fn fmt_sections(
&self,
function_name: &str,
markdown_processor: &MarkdownProcessor,
docs: String,
) -> String {
match self {
SectionFormat::Rust => format!(
r#"
<details>
<summary markdown="span"> details </summary>
{docs}
</details>
"#
),
SectionFormat::Tabs => {
match markdown_processor {
MarkdownProcessor::MdBook => {
let mut sections = vec![];
let mut tab_content = docs.lines().fold(
format!(
r#"
<div group="{function_name}" id="{function_name}-description" style="display: block;" markdown="span" class="tabcontent">
"#
),
|mut state, line| {
if let Some((_, section)) = line.split_once("# ") {
sections.push(section);
state.push_str("\n</div>\n");
state.push_str(&format!(
r#"
<div group="{function_name}" id="{function_name}-{section}" class="tabcontent">
"#
));
} else {
state.push_str(line);
state.push('\n');
}
state
},
);
tab_content += "</div>\n";
sections.into_iter().fold(
format!(
r#"
<div class="tab">
<button
group="{function_name}"
id="link-{function_name}-description"
class="tablinks active"
onclick="openTab(event, '{function_name}', 'description')">
Description
</button>"#
),
|state, section| {
state
+ format!(
r#"
<button
group="{function_name}"
id="link-{function_name}-{section}"
class="tablinks"
onclick="openTab(event, '{function_name}', '{section}')">
{section}
</button>"#
)
.as_str()
},
) + "</div>\n"
+ tab_content.as_str()
},
MarkdownProcessor::Docusaurus => {
let mut content = "<Tabs>\n<TabItem value=\"Description\" default>\n".to_string();
for line in docs.lines() {
if let Some((_, section)) = line.split_once("# ") {
content.push_str("</TabItem>\n\n");
content.push_str(&format!("<TabItem value=\"{section}\" default>\n"));
} else {
content.push_str(
// Removing rust links wrapped in the '<>' characters because they
// are treated as components.
&line.replace(['<', '>'], "")
);
content.push('\n');
}
}
content += "\n</TabItem>\n</Tabs>\n";
content
}
}
}
}
}
}