magg 0.4.0

Sophisticated tooling for Rust developers
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

//! # `README.md` file generator for regular crates

use super::*;

/// Creates a `README.md` file for a regular crate.
pub fn get_readme_for_regular_crate(file_name: impl AsRef<Path>) -> Result<String> {
  let mut output = String::new();
  let body = utils::read_file(file_name)?;
  let parsed_toml = utils::parse_toml("Cargo.toml")?;
  let package_name = utils::get_package_name(&parsed_toml);
  let repository_url = utils::get_repository(&parsed_toml)
    .strip_suffix(".git")
    .expect("repository name does not end with '.git' suffix");
  let workflows = format!("{repository_url}/actions/workflows");
  // Write the name of the package.
  _ = writeln!(&mut output, "### {}", package_name);
  _ = writeln!(&mut output);
  // Write badges.
  _ = writeln!(&mut output, "[![crates.io][crates-badge]][crates-url]");
  _ = writeln!(&mut output, "[![coverage][cov-badge]][cov-url]");
  _ = writeln!(&mut output, "![build-linux-gnu][build-badge-linux-gnu]");
  _ = writeln!(&mut output, "![build-linux-musl][build-badge-linux-musl]");
  _ = writeln!(&mut output, "![build-macos][build-badge-macos]");
  _ = writeln!(&mut output, "![build-macos-aarch64][build-badge-macos-aarch64]");
  _ = writeln!(&mut output, "![build-windows][build-badge-windows]");
  _ = writeln!(&mut output, "[![mit-license][mit-badge]][mit-license-url]");
  _ = writeln!(&mut output, "[![apache-license][apache-badge]][apache-license-url]");
  _ = writeln!(&mut output, "[![cc][cc-badge]][cc-url]");
  _ = writeln!(&mut output, "[![mbh][mbh-badge]][mbh-url]");
  _ = writeln!(&mut output, "[![es][es-badge]][es-url]");
  _ = writeln!(&mut output);
  // Write links to badges and files.
  _ = writeln!(&mut output, "[crates-badge]: https://img.shields.io/crates/v/{package_name}.svg");
  _ = writeln!(&mut output, "[crates-url]: https://crates.io/crates/{package_name}");
  _ = writeln!(&mut output, "[cov-badge]: https://img.shields.io/badge/coverage-0%25-21b577.svg");
  _ = writeln!(&mut output, "[cov-url]: https://crates.io/crates/coverio");
  _ = writeln!(&mut output, "[build-badge-linux-gnu]: {workflows}/build-linux-gnu.yml/badge.svg");
  _ = writeln!(&mut output, "[build-badge-linux-musl]: {workflows}/build-linux-musl.yml/badge.svg");
  _ = writeln!(&mut output, "[build-badge-macos]: {workflows}/build-macos.yml/badge.svg");
  _ = writeln!(&mut output, "[build-badge-macos-aarch64]: {workflows}/build-macos-aarch64.yml/badge.svg");
  _ = writeln!(&mut output, "[build-badge-windows]: {workflows}/build-windows.yml/badge.svg");
  _ = writeln!(&mut output, "[mit-badge]: https://img.shields.io/badge/License-MIT-{LICENSE_COLOR}.svg");
  _ = writeln!(&mut output, "[mit-url]: https://opensource.org/licenses/MIT");
  _ = writeln!(&mut output, "[mit-license-url]: {repository_url}/blob/main/LICENSE-MIT");
  _ = writeln!(&mut output, "[apache-badge]: https://img.shields.io/badge/License-Apache%202.0-{LICENSE_COLOR}.svg");
  _ = writeln!(&mut output, "[apache-url]: https://www.apache.org/licenses/LICENSE-2.0");
  _ = writeln!(&mut output, "[apache-license-url]: {repository_url}/blob/main/LICENSE");
  _ = writeln!(&mut output, "[apache-notice-url]: {repository_url}/blob/main/NOTICE");
  _ = writeln!(&mut output, "[cc-badge]: https://img.shields.io/badge/Contributor%20Covenant-2.1-{LICENSE_COLOR}.svg");
  _ = writeln!(&mut output, "[cc-url]: {repository_url}/blob/main/CODE_OF_CONDUCT.md");
  _ = writeln!(&mut output, "[mbh-badge]: https://img.shields.io/badge/Made_by-HUMAN-{HUMAN_COLOR}.svg");
  _ = writeln!(&mut output, "[mbh-url]: https://github.com/DariuszDepta");
  _ = writeln!(&mut output, "[es-badge]: https://img.shields.io/badge/at-Engos_Software-{ENGOS_COLOR}.svg");
  _ = writeln!(&mut output, "[es-url]: https://engos.de");
  _ = writeln!(&mut output, "[repository-url]: {repository_url}");
  _ = writeln!(&mut output);
  // Write the content.
  _ = write!(&mut output, "{body}");
  _ = writeln!(&mut output);
  // Write license section.
  _ = writeln!(&mut output, "## License");
  _ = writeln!(&mut output);
  _ = writeln!(&mut output, "Licensed under either of");
  _ = writeln!(&mut output);
  _ = writeln!(&mut output, "- [MIT license][mit-url] (see [LICENSE-MIT][mit-license-url]) or");
  _ = writeln!(
    &mut output,
    "- [Apache License, Version 2.0][apache-url] (see [LICENSE][apache-license-url] and [NOTICE][apache-notice-url])"
  );
  _ = writeln!(&mut output);
  _ = writeln!(&mut output, "at your option.");
  _ = writeln!(&mut output);
  // Write contribution section.
  _ = writeln!(&mut output, "## Contribution");
  _ = writeln!(&mut output);
  _ = writeln!(&mut output, "Any contributions to [{package_name}][repository-url] are greatly appreciated.");
  _ = writeln!(&mut output, "All contributions intentionally submitted for inclusion in the work by you,");
  _ = writeln!(&mut output, "shall be dual licensed as above, without any additional terms or conditions.");
  Ok(output)
}