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
//! `serde` mappings for npm's `package.json` file format. //! //! This does only implement the fields defined [in the official npm documentation](https://docs.npmjs.com/files/package.json). //! It is common enough that packages define custom entries that are required by //! various tooling. #![warn( missing_copy_implementations, missing_debug_implementations, missing_docs, unsafe_code )] use serde::{Deserialize, Serialize}; use serde_json::Value; use std::{collections::BTreeMap, fmt, fs, io::Read, path::Path, str::FromStr}; mod error; pub use crate::error::Error; /// An ordered map for `bin` entries. pub type BinSet = BTreeMap<String, String>; /// An ordered map for `dependencies` entries. pub type DepsSet = BTreeMap<String, String>; /// An ordered map for `engines` entries. pub type EnginesSet = BTreeMap<String, String>; /// An ordered map for `scripts` entries. pub type ScriptsSet = BTreeMap<String, String>; /// The result type of this crate. pub type Result<T> = std::result::Result<T, Error>; /// A bug contacting form. #[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq, Serialize)] pub struct Bug { /// The email to use for contact. pub email: Option<String>, /// The url to use to submit bugs. pub url: Option<String>, } impl Bug { /// Creates a new default bug. pub fn new() -> Self { Self::default() } /// Creates a new bug with the given values. pub fn with(email: Option<String>, url: Option<String>) -> Self { Self { email, url } } } /// A person. #[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq, Serialize)] pub struct Person { /// The name of a person. pub name: String, /// The email of a person. pub email: Option<String>, /// The homepage of the person. pub url: Option<String>, } impl Person { /// Creates a default person. pub fn new() -> Self { Self::default() } /// Creates a person with a given name. pub fn with_name(name: String) -> Self { Self { name, ..Default::default() } } /// Creates a person with the given values. pub fn with(name: String, email: Option<String>, url: Option<String>) -> Self { Self { name, email, url } } } impl fmt::Display for Person { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { match (&self.name, self.email.as_ref(), self.url.as_ref()) { (name, Some(email), None) => write!(f, "{} <{}>", name, email), (name, None, Some(url)) => write!(f, "{} ({})", name, url), (name, None, None) => write!(f, "{}", name), (name, Some(email), Some(url)) => write!(f, "{} <{}> ({})", name, email, url), } } } /// A reference to a person. #[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)] #[serde(untagged)] pub enum PersonReference { /// A short reference. /// /// Short references have a fixed format of `John Doe <john@doe.dev> (https://john.doe.dev)`. Short(String), /// A full reference. /// /// This type of reference defines the parts using a struct instead of a /// shorthand string format. Full(Person), } /// A reference to a man page. #[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)] #[serde(untagged)] pub enum ManReference { /// A single man page reference. Points to one single file. Single(String), /// Multiple man pages, can contain anything from zero to n. Multiple(Vec<String>), } /// A repository. #[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq, Serialize)] pub struct Repository { /// The version control system that the repository uses. pub r#type: String, /// The url to the repository. pub url: String, /// The directory that the repository is in. Often used for monorepos. pub directory: Option<String>, } /// A repository reference. #[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)] #[serde(untagged)] pub enum RepositoryReference { /// A short reference to the repository. Has to have the syntax that `npm install` allows as well. For more information see [here](https://docs.npmjs.com/files/package.json#repository). Short(String), /// A full reference. Full(Repository), } /// The top-level `package.json` structure. #[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq, Serialize)] #[serde(rename_all = "camelCase")] pub struct Package { /// The package name. pub name: String, /// The package version. pub version: String, /// The optional package description. pub description: Option<String>, /// The optional list of keywords. #[serde(default)] pub keywords: Vec<String>, /// The optional package homepage. pub homepage: Option<String>, /// The optional bug contact form. pub bugs: Option<Bug>, /// The optional package license. pub license: Option<String>, /// The optional author. pub author: Option<PersonReference>, /// The optional list of contributors. #[serde(default)] pub contributors: Vec<PersonReference>, /// The optional list of files to include. Each entry defines a regex /// pattern. #[serde(default)] pub files: Vec<String>, /// The optional package main entry file. pub main: Option<String>, /// The optional package browser entry file. /// /// This is usually defined in libraries that are meant to be consumed by /// browsers. These Thoes can refer to objects that are not available inside /// a `nodejs` environment (like `window`). pub browser: Option<String>, /// The optional set of binary definitions. #[serde(default)] pub bin: BinSet, /// The optional list of man page references. pub man: Option<ManReference>, /// The optional repository reference. //#[serde(flatten)] pub repository: Option<RepositoryReference>, /// The optional list of script entries. #[serde(default)] pub scripts: ScriptsSet, /// The optional list of dependencies. #[serde(default)] pub dependencies: DepsSet, /// The optional list of development dependencies. #[serde(default)] pub dev_dependencies: DepsSet, /// The optional list of peer dependencies. #[serde(default)] pub peer_dependencies: DepsSet, /// The optional list of bundled dependencies. #[serde(default)] pub bundled_dependencies: DepsSet, /// The optional list of optional dependencies. #[serde(default)] pub optional_dependencies: DepsSet, /// The optional list of engine entries. #[serde(default)] pub engines: EnginesSet, /// The package privacy. #[serde(default)] pub private: bool, /// The OS' that the package can run on. #[serde(default)] pub os: Vec<String>, /// The CPU architectures that the package can run on. #[serde(default)] pub cpu: Vec<String>, /// The optional config object. pub config: Option<Value>, /// Other custom fields that have been defined inside the `package.json` /// file. #[serde(flatten)] pub others: BTreeMap<String, Value>, } impl Package { /// Creates a new default package. pub fn new() -> Self { Self::default() } /// Deserializes a `Package` from a file path. pub fn from_path(path: impl AsRef<Path>) -> Result<Self> { let content = fs::read(path.as_ref())?; Self::from_slice(content.as_slice()) } /// Deserializes a `Package` from an IO stream. pub fn from_reader<R: Read>(r: R) -> Result<Self> { Ok(serde_json::from_reader(r)?) } /// Deserializes a `Package` from bytes. pub fn from_slice(v: &[u8]) -> Result<Self> { Ok(serde_json::from_slice(v)?) } } impl FromStr for Package { type Err = Error; /// Deserializes a `Package` from a string. fn from_str(s: &str) -> std::result::Result<Self, Self::Err> { Ok(serde_json::from_str(s)?) } } #[cfg(test)] mod tests { use super::Person; #[test] fn test_person_display() { let person = Person { name: "John Doe".to_string(), email: Some("john@doe.dev".to_string()), url: Some("https://john.doe.dev".to_string()), }; let expected = "John Doe <john@doe.dev> (https://john.doe.dev)"; assert_eq!(expected, person.to_string()); } }