readmer 0.0.5

Compose README.md files from Liquid or Jinja2 templates.
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
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

// This is free and unencumbered software released into the public domain.

use alloc::{collections::BTreeMap, string::String, vec::Vec};
use serde::{Deserialize, Serialize};
use serde_json::Value;
use serde_with::{
    OneOrMany,
    formats::{PreferMany, PreferOne},
    serde_as,
};

pub type Map<K, V> = BTreeMap<K, V>;

/// See: <https://dart.dev/tools/pub/pubspec>
#[serde_as]
#[derive(Clone, Debug, Default, Eq, Hash, PartialEq, Deserialize, Serialize)]
#[serde(default, tag = "@type")]
pub struct Pubspec {
    /// See: <https://dart.dev/tools/pub/pubspec#name>
    pub name: PackageName,

    /// See: <https://dart.dev/tools/pub/pubspec#version>
    #[serde(skip_serializing_if = "Option::is_none")]
    pub version: Option<Version>,

    /// See: <https://dart.dev/tools/pub/pubspec#description>
    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,

    /// See: <https://dart.dev/tools/pub/pubspec#homepage>
    #[serde(skip_serializing_if = "Option::is_none")]
    pub homepage: Option<Url>,

    /// See: <https://dart.dev/tools/pub/pubspec#repository>
    #[serde(skip_serializing_if = "Option::is_none")]
    pub repository: Option<Url>,

    /// See: <https://dart.dev/tools/pub/pubspec#issue-tracker>
    #[serde(skip_serializing_if = "Option::is_none")]
    pub issue_tracker: Option<Url>,

    /// See: <https://dart.dev/tools/pub/pubspec#documentation>
    #[serde(skip_serializing_if = "Option::is_none")]
    pub documentation: Option<Url>,

    /// See: <https://dart.dev/tools/pub/pubspec#dependencies>
    #[serde(skip_serializing_if = "Option::is_none")]
    pub dependencies: Option<Map<String, Dependency>>,

    /// See: <https://dart.dev/tools/pub/pubspec#dependencies>
    #[serde(skip_serializing_if = "Option::is_none")]
    pub dev_dependencies: Option<Map<String, Dependency>>,

    /// See: <https://dart.dev/tools/pub/pubspec#dependencies>
    #[serde(skip_serializing_if = "Option::is_none")]
    pub dependency_overrides: Option<Map<String, Dependency>>,

    /// See: <https://dart.dev/tools/pub/pubspec#sdk-constraints>
    #[serde(skip_serializing_if = "Option::is_none")]
    pub environment: Option<Environment>,

    /// See: <https://dart.dev/tools/pub/pubspec#executables>
    #[serde(skip_serializing_if = "Option::is_none")]
    pub executables: Option<Map<String, Option<String>>>,

    /// See: <https://dart.dev/tools/pub/pubspec#platforms>
    #[serde(skip_serializing_if = "Option::is_none")]
    pub platforms: Option<Map<String, Option<()>>>,

    /// See: <https://dart.dev/tools/pub/pubspec#publish_to>
    #[serde(skip_serializing_if = "Option::is_none")]
    pub publish_to: Option<String>,

    /// See: <https://dart.dev/tools/pub/pubspec#funding>
    #[serde(skip_serializing_if = "Option::is_none")]
    pub funding: Option<Vec<Url>>,

    /// See: <https://dart.dev/tools/pub/pubspec#false_secrets>
    #[serde(skip_serializing_if = "Option::is_none")]
    pub false_secrets: Option<Vec<String>>,

    /// See: <https://dart.dev/tools/pub/pubspec#screenshots>
    #[serde(skip_serializing_if = "Option::is_none")]
    pub screenshots: Option<Vec<Screenshot>>,

    /// See: <https://dart.dev/tools/pub/pubspec#topics>
    #[serde(skip_serializing_if = "Option::is_none")]
    pub topics: Option<Vec<String>>,

    /// See: <https://dart.dev/tools/pub/pubspec#ignored_advisories>
    #[serde(skip_serializing_if = "Option::is_none")]
    pub ignored_advisories: Option<Vec<String>>,

    /// See: <https://dart.dev/tools/pub/pubspec#hooks>
    #[serde(skip_serializing_if = "Option::is_none")]
    pub hooks: Option<Map<String, Hook>>,
}

/// See: <https://dart.dev/tools/pub/pubspec#dependencies>
pub type Dependency = VersionConstraint;

/// See: <https://dart.dev/tools/pub/pubspec#sdk-constraints>
#[derive(Clone, Debug, Default, Eq, Hash, PartialEq, Deserialize, Serialize)]
#[serde(default)]
pub struct Environment {
    pub sdk: VersionConstraint,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub flutter: Option<VersionConstraint>,
}

/// See: <https://dart.dev/tools/hooks#hook-configuration>
pub type Hook = Map<String, String>; // TODO

/// See: <https://dart.dev/tools/pub/pubspec#name>
pub type PackageName = String;

/// See: <https://dart.dev/tools/pub/pubspec#screenshots>
#[derive(Clone, Debug, Default, Eq, Hash, PartialEq, Deserialize, Serialize)]
#[serde(default)]
pub struct Screenshot {
    pub path: String,
    pub description: String,
}

/// See: <https://dart.dev/tools/pub/pubspec#version>
pub type Version = String;

/// See: <https://dart.dev/tools/pub/dependencies#version-constraints>
pub type VersionConstraint = String;

/// See: <https://dart.dev/tools/pub/pubspec#repository>
pub type Url = String;