mantra-rust-macros

该crate提供过程宏，用于使用 mantra 跟踪需求。它还提供通过日志获取需求覆盖率的功能。

跟踪

可以使用属性宏 req 或函数式宏 reqcov 创建需求跟踪。有关如何使用 req 或 reqcov 指定需求ID，请参阅 mantra-lang-tracing。

属性宏可以在允许属性宏的任何地方设置。目前，只有在函数上设置宏时才会生成覆盖率日志。

示例

use mantra_rust_macros::{req, reqcov};

/// Coverage log is generated
#[req(fn_trace)]
fn some_fn() {
    // coverage log is generated
    reqcov!(function_like_trace);
}

#[req(const_trace)]
const SOME_CONST: usize = 1;

#[req(type_trace)]
type SomeType = bool;

#[req(struct_trace)]
struct SomeStruct {
    /// Attribute macros cannot be set for fields.
    some_field: bool,
}

#[req(mod_trace)]
mod some_mod {}

#[req(trait_trace)]
trait SomeTrait {
    #[req(trait_type_trace)]
    type A;

    /// Coverage log is generated
    #[req(trait_fn_default_trace)]
    fn some_trait_fn() {}
}

自动文档

使用 #[req()] 属性设置的需求将生成文档中的 Requirements 部分。需求ID表示为项目符号列表条目。如果设置了环境变量 MANTRA_REQUIREMENT_BASE_URL，则所有ID都将转换为带有变量内容的链接。

/// Documentation for IDs is automatically generated.
#[req(req_1, req_2)]
fn some_fn() {}

Documentation for IDs is automatically generated.

# Requirements

- [req_1](https://github.com/mhatzl/mantra/wiki/5-Requirements/req_1)
- [req_2](https://github.com/mhatzl/mantra/wiki/5-Requirements/req_2)

#[req(fn_trace)]
fn some_fn() {}

mantra: req-id=`fn_trace`; file='<resolved by file!()>'; line='<resolved by line!()>';