@ehildt/depbadge 1.0.6 → 1.0.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +7 -7
- package/dist/index.mjs +4 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
# DEPBADGE
|
|
2
2
|
|
|
3
|
-
Depbadge is a CLI tool that automatically generates and maintains dependency and status badges for your project documentation —
|
|
3
|
+
Depbadge is a CLI tool that automatically generates and maintains dependency and status badges for your project documentation — perfect for keeping your badges consistent and up-to-date.
|
|
4
4
|
|
|
5
|
-
It reads your project’s manifest and produces Shields-based badges rendered dynamically via Shields.io, fully compatible with
|
|
5
|
+
It reads your project’s manifest and produces Shields-based badges rendered dynamically via Shields.io, fully compatible with GitHub, GitLab, and other platforms. All layout, grouping, styling, and badge composition are defined in a depbadgerc.yml configuration file, making the output deterministic, reproducible, and fully automated.
|
|
6
6
|
|
|
7
|
-
Depbadge handles both dependency badges and third-party status badges (e.g., releases, container metrics, coverage), injecting them into your target documentation file (default README.md) so your badges are always accurate
|
|
7
|
+
Depbadge handles both dependency badges and third-party status badges (e.g., releases, container metrics, coverage), injecting them directly into your target documentation file (default README.md) so your badges are always accurate. It also supports generating previews and structured definitions for inspection or CI/CD workflows.
|
|
8
8
|
|
|
9
9
|
By automating badge generation, Depbadge solves common problems: outdated badges, inconsistent styling, and manual maintenance overhead — keeping your documentation visually consistent and trustworthy.
|
|
10
10
|
|
|
@@ -24,10 +24,10 @@ By automating badge generation, Depbadge solves common problems: outdated badges
|
|
|
24
24
|
<!-- DEPBADGE:START -->
|
|
25
25
|
<div align="center">
|
|
26
26
|
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
27
|
+

|
|
28
|
+

|
|
29
|
+

|
|
30
|
+

|
|
31
31
|
|
|
32
32
|
</div>
|
|
33
33
|
|
package/dist/index.mjs
CHANGED
|
@@ -4919,7 +4919,7 @@ function mapCodecovStatusBadgeToMarkdown(badge) {
|
|
|
4919
4919
|
const label = badge.name;
|
|
4920
4920
|
const user = encodeLabel2(badge.user ?? "library");
|
|
4921
4921
|
const repo = encodeLabel2(badge.repo);
|
|
4922
|
-
const provider = encodeLabel2(
|
|
4922
|
+
const provider = encodeLabel2("github");
|
|
4923
4923
|
const flag = encodeLabel2(badge.flag ?? "c");
|
|
4924
4924
|
const url = `https://img.shields.io/codecov/${flag}/${provider}/${user}/${repo}?${urlSearchParams}`;
|
|
4925
4925
|
return badge?.link ? `[](${badge.link})` : ``;
|
|
@@ -4937,7 +4937,7 @@ var mapStatusBadgesToMarkdown = useCtxCallback(
|
|
|
4937
4937
|
)
|
|
4938
4938
|
);
|
|
4939
4939
|
|
|
4940
|
-
// src/depbadgerc/output-markdown-preview.
|
|
4940
|
+
// src/depbadgerc/output-markdown-preview.ts
|
|
4941
4941
|
init_esm_shims();
|
|
4942
4942
|
var outputMarkdownPreview = useCtxCallback(
|
|
4943
4943
|
(store, type2, badgeMarkdownMap, dir = ".depbadge") => {
|
|
@@ -5226,10 +5226,10 @@ function readDepbadgeRC(path4 = "depbadgerc.yml") {
|
|
|
5226
5226
|
const rc = jsYaml.load(fs2.readFileSync(filePath, "utf8"));
|
|
5227
5227
|
return rc;
|
|
5228
5228
|
}
|
|
5229
|
-
var
|
|
5229
|
+
var getDepbadgeRC = () => withDefaults(readDepbadgeRC());
|
|
5230
5230
|
|
|
5231
5231
|
// src/depbadgerc/depbadgerc.store.ts
|
|
5232
|
-
var rcCtx = useCtxStore(
|
|
5232
|
+
var rcCtx = useCtxStore(getDepbadgeRC(), {
|
|
5233
5233
|
processManifest,
|
|
5234
5234
|
getDependencies,
|
|
5235
5235
|
getStatusBadges,
|