#badge #svg #logo #shield #graphics

bin+lib rsbadges

在 Rust 中舒适安全地创建代码徽章

6 个稳定版本

1.1.5 2023 年 5 月 26 日
1.1.4 2022 年 12 月 2 日
1.1.3 2022 年 10 月 14 日
1.1.2 2022 年 8 月 23 日
1.1.1 2021 年 2 月 25 日

命令行界面 中排名 #160

Download history 2/week @ 2024-04-14 7/week @ 2024-04-21 25/week @ 2024-04-28 1/week @ 2024-05-26 1/week @ 2024-06-09 7/week @ 2024-06-23 101/week @ 2024-06-30 114/week @ 2024-07-28

每月下载 201

BSD-3-Clause

415KB
930

RSBadges

在 Rust 中舒适安全地创建代码徽章

平面 平面方形 塑料 ForTheBadge 社交
flat flat_square plastic for_the_badge social

RSBadges 是一个 Rust 友好的徽章生成器。界面力求简洁,同时提供功能丰富的 API。徽章的标签(左侧)和消息(右侧)都可以完全自定义,可以

  • 设置文本
  • 使用任何有效的 CSS 颜色代码设置颜色
  • 将链接嵌入到每一侧或整个徽章的链接
  • 从本地源或 URL 添加一个 logo(SVG 格式)
  • 直接将 logo 的数据嵌入徽章中
  • 设置徽章样式,如 Shields.io 所述

RSBadges 可以用作 API 或命令行界面(CLI)。请参阅文档以获取有关参数和功能的更多详细信息。


API

首先,实例化一个 Badge 结构体来设置徽章 SVG 的所有泛型选项。然后,这个填充完整的 Badge 被封装在 Style 枚举中,表示最终生成的徽章样式。

use rsbadges::{Badge, Style};
let badge = Badge {
    label_text: String::from("Custom_label"),
    msg_text: String::from("Custom_msg"),
    label_color: String::from("red"),
    ..Badge::default()
};
// Create a plastic badge using the data created above.
let badge_style = Style::Plastic(badge);

徽章和样式一起足以告诉 RSBadges 如何构建正确的徽章,它通过 generate_svg() 来实现。

let badge_svg = badge_style.generate_svg().unwrap();

生成的 SVG 字符串可以使用方便的函数 save_svg() 保存到文件。

rsbadges::save_svg("~/Downloads/badge.svg", &badge_svg);

有关徽章和样式类型,请参阅文档。


CLI

CLI 包含 API 中的所有自定义选项,以及一些针对命令行使用和评估的改进,例如

  • 在创建后打开创建的徽章 SVG
  • 指定 SVG 的保存目录

有效的参数格式与 API 中找到的格式相同(请参阅徽章类型文档)。如果出错,RSBadges 也会通知您。

简短 默认
-a --标签 <字符串> "test"
-b --标签-颜色 <css_color> "#555"
-c --标签-link<url> ""
-x --消息 <字符串> "test"
-y --消息-颜色 <css_color> "#007ec6"
-z --消息-link<url> ""
-l --logo<url 或本地路径> ""
-f --save-to-svg-at <filepath/file.svg> ""
-s --style<plastic,flat,flatsquare,forthebadge,social> "flat"
-o --open-in-browser false
-h --帮助 false
-e --embed-logo false

使用 -h 标志运行 CLI,以查看所有可能的参数和标志。

依赖项

~5–15MB
~203K SLoC