badges - npm Package Compare versions

Comparing version 4.34.0 to 4.35.0-next.1700274317.a451d109f498cf27fb5ba86c39d6b5a0d8e07e49

compiled-types/badges.d.ts

@@ -353,2 +353,16 @@ export interface twitterOptions {
 }
+export interface discordOptions {
+    /** The discord server id */
+    discordServerID: string;
+    /** The discord server invite code or url */
+    discordServerInvite?: string;
+}
+/** Discord Badge */
+export declare function discord({ discordServerID, discordServerInvite, }: discordOptions): string;
+export interface TwitchOptions {
+    /** The Twitch username */
+    twitchUsername: string;
+}
+/** Twitch Badge */
+export declare function twitch({ twitchUsername }: TwitchOptions): string;
 export interface gabeaconOptions {
@@ -355,0 +369,0 @@ /**  The google analytics tracing id (e.g. UA-XXXXX-XX) */

edition-browsers/badges.js

@@ -510,6 +510,37 @@ // Import
     const alt = 'Slack community badge';
-    const title = "Join this project's slack community";
+    const title = "Join this project's community on Slack";
     return badge({ image, alt, url, title });
 }
 slackin.badgeCategory = 'social';
+/** Discord Badge */
+export function discord({ discordServerID, discordServerInvite, }) {
+    // Check
+    if (!discordServerID)
+        throw new Error('discordServerID is missing');
+    discordServerInvite = (discordServerInvite || '')
+        .replace('https://discord.com/invite/', '')
+        .replace('https://discord.gg/', '');
+    // Create
+    const image = `https://img.shields.io/discord/${discordServerID}?logo=discord&label=discord`;
+    const url = discordServerInvite
+        ? `https://discord.gg/${discordServerInvite}`
+        : `https://discord.com/channels/${discordServerID}`;
+    const alt = 'Discord server badge';
+    const title = "Join this project's community on Discord";
+    return badge({ image, alt, url, title });
+}
+slackin.badgeCategory = 'social';
+/** Twitch Badge */
+export function twitch({ twitchUsername }) {
+    // Check
+    if (!twitchUsername)
+        throw new Error('twitchUsername is missing');
+    // Create
+    const image = `https://img.shields.io/twitch/status/${twitchUsername}?logo=twitch`;
+    const url = `https://www.twitch.tv/${twitchUsername}`;
+    const alt = 'Twitch community badge';
+    const title = "Join this project's community on Twitch";
+    return badge({ image, alt, url, title });
+}
+slackin.badgeCategory = 'social';
 /**
@@ -516,0 +547,0 @@ * Google Analytics Beacon Badge

edition-es2022-esm/badges.js

@@ -510,6 +510,37 @@ // Import
     const alt = 'Slack community badge';
-    const title = "Join this project's slack community";
+    const title = "Join this project's community on Slack";
     return badge({ image, alt, url, title });
 }
 slackin.badgeCategory = 'social';
+/** Discord Badge */
+export function discord({ discordServerID, discordServerInvite, }) {
+    // Check
+    if (!discordServerID)
+        throw new Error('discordServerID is missing');
+    discordServerInvite = (discordServerInvite || '')
+        .replace('https://discord.com/invite/', '')
+        .replace('https://discord.gg/', '');
+    // Create
+    const image = `https://img.shields.io/discord/${discordServerID}?logo=discord&label=discord`;
+    const url = discordServerInvite
+        ? `https://discord.gg/${discordServerInvite}`
+        : `https://discord.com/channels/${discordServerID}`;
+    const alt = 'Discord server badge';
+    const title = "Join this project's community on Discord";
+    return badge({ image, alt, url, title });
+}
+slackin.badgeCategory = 'social';
+/** Twitch Badge */
+export function twitch({ twitchUsername }) {
+    // Check
+    if (!twitchUsername)
+        throw new Error('twitchUsername is missing');
+    // Create
+    const image = `https://img.shields.io/twitch/status/${twitchUsername}?logo=twitch`;
+    const url = `https://www.twitch.tv/${twitchUsername}`;
+    const alt = 'Twitch community badge';
+    const title = "Join this project's community on Twitch";
+    return badge({ image, alt, url, title });
+}
+slackin.badgeCategory = 'social';
 /**
@@ -516,0 +547,0 @@ * Google Analytics Beacon Badge

edition-es2022/badges.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.quorafollow = exports.githubstar = exports.githubfollow = exports.twitterfollow = exports.twittertweet = exports.facebookfollow = exports.facebooklike = exports.hackernewssubmit = exports.redditsubmit = exports.googleplusone = exports.gabeacon = exports.slackin = exports.slackinscript = exports.boostlab = exports.thanksapp = exports.liberapay = exports.buymeacoffee = exports.wishlist = exports.bitcoin = exports.crypto = exports.paypal = exports.flattr = exports.gratipay = exports.opencollective = exports.patreon = exports.thanksdev = exports.githubsponsors = exports.sixtydevstips = exports.githubworkflow = exports.waffle = exports.bithound = exports.codeclimate = exports.coveralls = exports.codeship = exports.travisci = exports.saucelabs = exports.saucelabsbm = exports.nodeico = exports.daviddmdev = exports.daviddm = exports.npmdownloads = exports.npmversion = exports.shields = exports.badge = void 0;
+exports.quorafollow = exports.githubstar = exports.githubfollow = exports.twitterfollow = exports.twittertweet = exports.facebookfollow = exports.facebooklike = exports.hackernewssubmit = exports.redditsubmit = exports.googleplusone = exports.gabeacon = exports.twitch = exports.discord = exports.slackin = exports.slackinscript = exports.boostlab = exports.thanksapp = exports.liberapay = exports.buymeacoffee = exports.wishlist = exports.bitcoin = exports.crypto = exports.paypal = exports.flattr = exports.gratipay = exports.opencollective = exports.patreon = exports.thanksdev = exports.githubsponsors = exports.sixtydevstips = exports.githubworkflow = exports.waffle = exports.bithound = exports.codeclimate = exports.coveralls = exports.codeship = exports.travisci = exports.saucelabs = exports.saucelabsbm = exports.nodeico = exports.daviddmdev = exports.daviddm = exports.npmdownloads = exports.npmversion = exports.shields = exports.badge = void 0;
 // Import
@@ -545,3 +545,3 @@ const querystring_1 = require("querystring");
     const alt = 'Slack community badge';
-    const title = "Join this project's slack community";
+    const title = "Join this project's community on Slack";
     return badge({ image, alt, url, title });
@@ -551,2 +551,35 @@ }
 slackin.badgeCategory = 'social';
+/** Discord Badge */
+function discord({ discordServerID, discordServerInvite, }) {
+    // Check
+    if (!discordServerID)
+        throw new Error('discordServerID is missing');
+    discordServerInvite = (discordServerInvite || '')
+        .replace('https://discord.com/invite/', '')
+        .replace('https://discord.gg/', '');
+    // Create
+    const image = `https://img.shields.io/discord/${discordServerID}?logo=discord&label=discord`;
+    const url = discordServerInvite
+        ? `https://discord.gg/${discordServerInvite}`
+        : `https://discord.com/channels/${discordServerID}`;
+    const alt = 'Discord server badge';
+    const title = "Join this project's community on Discord";
+    return badge({ image, alt, url, title });
+}
+exports.discord = discord;
+slackin.badgeCategory = 'social';
+/** Twitch Badge */
+function twitch({ twitchUsername }) {
+    // Check
+    if (!twitchUsername)
+        throw new Error('twitchUsername is missing');
+    // Create
+    const image = `https://img.shields.io/twitch/status/${twitchUsername}?logo=twitch`;
+    const url = `https://www.twitch.tv/${twitchUsername}`;
+    const alt = 'Twitch community badge';
+    const title = "Join this project's community on Twitch";
+    return badge({ image, alt, url, title });
+}
+exports.twitch = twitch;
+slackin.badgeCategory = 'social';
 /**
@@ -553,0 +586,0 @@ * Google Analytics Beacon Badge

package.json

 {
   "name": "badges",
-  "version": "4.34.0",
+  "version": "4.35.0-next.1700274317.a451d109f498cf27fb5ba86c39d6b5a0d8e07e49",
   "description": "The definitive collection of badges for rendering",
@@ -208,7 +208,7 @@ "homepage": "https://github.com/bevry/badges",
     "@bevry/update-contributors": "^1.23.0",
-    "@types/node": "^20.9.0",
+    "@types/node": "^20.9.1",
     "@typescript-eslint/eslint-plugin": "^6.11.0",
     "@typescript-eslint/parser": "^6.11.0",
     "assert-helpers": "^11.4.0",
-    "eslint": "^8.53.0",
+    "eslint": "^8.54.0",
     "eslint-config-bevry": "^4.0.0",
@@ -219,8 +219,8 @@ "eslint-config-prettier": "^9.0.0",
     "prettier": "^3.1.0",
-    "projectz": "^3.0.0",
+    "projectz": "^3.1.0",
     "surge": "^0.23.1",
     "typedoc": "^0.25.3",
     "typescript": "5.2.2",
-    "valid-directory": "^4.2.0",
-    "valid-module": "^2.2.0"
+    "valid-directory": "^4.4.0",
+    "valid-module": "^2.3.0"
   },
@@ -266,2 +266,2 @@ "scripts": {
   }
-}
+}

README.md

@@ -184,3 +184,3 @@ <!-- TITLE/ -->
 <script type="module">
-    import * as pkg from '//cdn.skypack.dev/badges@^4.34.0'
+    import * as pkg from '//cdn.skypack.dev/badges@^4.35.0'
 </script>
@@ -193,3 +193,3 @@ ```
 <script type="module">
-    import * as pkg from '//unpkg.com/badges@^4.34.0'
+    import * as pkg from '//unpkg.com/badges@^4.35.0'
 </script>
@@ -202,3 +202,3 @@ ```
 <script type="module">
-    import * as pkg from '//dev.jspm.io/badges@4.34.0'
+    import * as pkg from '//dev.jspm.io/badges@4.35.0'
 </script>
@@ -205,0 +205,0 @@ ```

SECURITY.md

@@ -5,3 +5,3 @@ # Security Policy
 
-This project meets standardized secure software development practices, including 2FA for all members, password managers with monitoring, secure secret retrieval instead of storage. [Learn more about our practices.](https://tidelift.com/funding/github/npm/badges)
+This project meets standardized secure software development practices, including 2FA for all members, password managers with monitoring, secure secret retrieval instead of storage. [Learn about our practices.](https://tidelift.com/funding/github/npm/badges)
 
@@ -12,5 +12,5 @@ ## Supported Versions
 
-[Refer to supported ecosystem versions: `Editions` section in `README.md`.](https://github.com/bevry/badges/blob/master/README.md#Editions)
+[Refer to supported ecosystem versions: `Editions` section in `README.md`](https://github.com/bevry/badges/blob/master/README.md#Editions)
 
-[Refer to automated support of ecosystem versions: `boundation` entries in `HISTORY.md`.](https://github.com/bevry/badges/blob/master/HISTORY.md)
+[Refer to automated support of ecosystem versions: `boundation` entries in `HISTORY.md`](https://github.com/bevry/badges/blob/master/HISTORY.md)
 
@@ -17,0 +17,0 @@ Besides testing and verification, out CI also [auto-merges](https://docs.github.com/en/code-security/dependabot/working-with-dependabot/automating-dependabot-with-github-actions) [Dependabot security updates](https://docs.github.com/en/code-security/dependabot/dependabot-security-updates/about-dependabot-security-updates) and [auto-publishes](https://github.com/bevry-actions/npm) successful builds of the [`master` branch](https://github.com/bevry/wait/actions?query=branch%3Amaster) to the [`next` version tag](https://www.npmjs.com/package/badges?activeTab=versions), offering immediate resolutions before scheduled maintenance releases.

source/badges.ts

@@ -839,3 +839,3 @@ // Import
 	const alt = 'Slack community badge'
-	const title = "Join this project's slack community"
+	const title = "Join this project's community on Slack"
 	return badge({ image, alt, url, title })
@@ -845,2 +845,48 @@ }
 
+export interface discordOptions {
+	/** The discord server id */
+	discordServerID: string
+	/** The discord server invite code or url */
+	discordServerInvite?: string
+}
+/** Discord Badge */
+export function discord({
+	discordServerID,
+	discordServerInvite,
+}: discordOptions): string {
+	// Check
+	if (!discordServerID) throw new Error('discordServerID is missing')
+	discordServerInvite = (discordServerInvite || '')
+		.replace('https://discord.com/invite/', '')
+		.replace('https://discord.gg/', '')
+
+	// Create
+	const image = `https://img.shields.io/discord/${discordServerID}?logo=discord&label=discord`
+	const url = discordServerInvite
+		? `https://discord.gg/${discordServerInvite}`
+		: `https://discord.com/channels/${discordServerID}`
+	const alt = 'Discord server badge'
+	const title = "Join this project's community on Discord"
+	return badge({ image, alt, url, title })
+}
+slackin.badgeCategory = 'social'
+
+export interface TwitchOptions {
+	/** The Twitch username */
+	twitchUsername: string
+}
+/** Twitch Badge */
+export function twitch({ twitchUsername }: TwitchOptions): string {
+	// Check
+	if (!twitchUsername) throw new Error('twitchUsername is missing')
+
+	// Create
+	const image = `https://img.shields.io/twitch/status/${twitchUsername}?logo=twitch`
+	const url = `https://www.twitch.tv/${twitchUsername}`
+	const alt = 'Twitch community badge'
+	const title = "Join this project's community on Twitch"
+	return badge({ image, alt, url, title })
+}
+slackin.badgeCategory = 'social'
+
 export interface gabeaconOptions {
@@ -847,0 +893,0 @@ /**  The google analytics tracing id (e.g. UA-XXXXX-XX) */

New alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

199062

increased by3.28%

Lines of code

3964

increased by3.96%

Worsened metrics

Number of low quality alerts

1

increased byInfinity%

No dependency changes