doc-type 0.1.2

A small Rust crate for generating documents from your types
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

use self::types::FormatError;
use crate::ts::types::FormattedType;
use specta::ts::ExportConfiguration;
use specta::{NamedType, Type};

pub mod types;

/// Creates a String formatted to the target language
///
/// The type needs to implement [`specta::Type`], the easiest way to do this is
/// to add a `#[derive(Type)]` to your struct/enum
/// # Examples
/// ```
///  use specta::Type;
///
///  #[derive(Type)]
///  struct Foo {
///      name: String,
///      age: u32,
///  }
///  assert_eq!(
///      generate_typedoc::<Foo>(),
///      Ok("type Foo = { name: string; age: number }".to_string())
///  )
/// ```
pub fn generate_typedoc<T: Type + NamedType>() -> Result<FormattedType, FormatError> {
    let export_str = specta::ts::export::<T>(&ExportConfiguration::default()).unwrap();
    Ok(FormattedType(export_str))
}

#[cfg(test)]
mod tests {
    use crate::{generate_typedoc, ts::types::TrimFunctions};
    use specta::Type;

    #[derive(Type)]
    struct Tuple(i32);

    #[derive(Type)]
    struct Normal {
        _id: i32,
        _name: String,
    }

    #[test]
    fn tuple() {
        let a = generate_typedoc::<Normal>().unwrap();
        let t = generate_typedoc::<Tuple>().unwrap();
        dbg!(&a);
        dbg!(&a.trim_export());
        dbg!(&a.trim_export().replace_equals());
        dbg!(&a.trim_export().replace_equals().remove_type_word());
        dbg!(t);
    }
}