badges - npm Package Compare versions

Comparing version 4.27.0 to 4.28.0-next.1679639918.7888b4b698a8624d753d087c0967c5a9cdf392b7

compiled-types/badges.d.ts

@@ -1,22 +0,22 @@
-interface twitterOptions {
+export interface twitterOptions {
     /**  The twitter username to tweet at */
     twitterUsername: string;
 }
-interface homepageOptions {
+export interface homepageOptions {
     /** The page url that the badge will be for */
     homepage: string;
 }
-interface githubUsernameOptions {
+export interface githubUsernameOptions {
     /** The github username to use */
     githubUsername: string;
 }
-interface githubSlugOptions {
+export interface githubSlugOptions {
     /** The github slug of the project (e.g. bevry/badges) */
     githubSlug: string;
 }
-interface npmOptions {
+export interface npmOptions {
     /** The npm package name */
     npmPackageName: string;
 }
-interface badgeOptions {
+export interface badgeOptions {
     /** The URL to the image **/
@@ -36,3 +36,3 @@ image?: string;
 }
-interface shieldsOptions {
+export interface shieldsOptions {
     /** The text for the left side of the badge */
@@ -56,3 +56,3 @@ left: string;
 }
-interface npmversionOptions {
+export interface npmversionOptions {
     /** The repository slug (username/reponame) */
@@ -81,6 +81,8 @@ npmPackageName: string;
 }
-interface nodeicoOptions extends npmOptions {
-    /** See https://nodei.co for options
-    defined as either a string param1=&param2=
-    or an object {param1: '', param2: ''} that will be serialized to param1=&param2= etc. */
+export interface nodeicoOptions extends npmOptions {
+    /**
+     * See https://nodei.co for options
+     * defined as either a string `param1=&param2=`
+     * or an object `{param1: '', param2: ''}` that will be serialized to `param1=&param2=` etc.
+     */
     nodeicoQueryString?: string | {
@@ -95,3 +97,3 @@ [index: string]: any;
 }
-interface saucelabsOptions {
+export interface saucelabsOptions {
     /** The username of the sauncelabs account to use */
@@ -113,3 +115,3 @@ saucelabsUsername: string;
 }
-interface travisOptions extends githubSlugOptions {
+export interface travisOptions extends githubSlugOptions {
     /** The TLD to use for travis, use "com" if you have moved to travis-ci.com instead of travis-ci.org */
@@ -123,3 +125,3 @@ travisTLD?: string;
 }
-interface codeshipOptions {
+export interface codeshipOptions {
     /** The UUID for a specific project, which is available on the General tab in your project settings */
@@ -155,3 +157,3 @@ codeshipProjectUUID: string;
 }
-interface githubworkflowOptions extends githubSlugOptions {
+export interface githubworkflowOptions extends githubSlugOptions {
     /** The name or location of the workflow file to show the badge for */
@@ -170,3 +172,3 @@ githubWorkflow: string;
 /** At least one of the properties must be provided */
-interface sixtydevOptions {
+export interface sixtydevOptions {
     /** The 60devs username to donate to */
@@ -183,3 +185,3 @@ sixtydevstipsID?: string;
 /** At least one of the properties must be provided */
-interface githubsponsorsOptions {
+export interface githubsponsorsOptions {
     /** The url to the GitHub donate page */
@@ -198,3 +200,17 @@ githubSponsorsURL?: string;
 /** At least one of the properties must be provided */
-interface patreonOptions {
+export interface thanksdevOptions {
+    /** The url to the ThanksDev donate page */
+    thanksdevURL?: string;
+    /** The GitHub username to donate to */
+    thanksdevGithubUsername?: string;
+    /** The GitHub username fallback to donate to */
+    githubUsername?: string;
+}
+/** ThanksDev Badge */
+export declare function thanksdev({ thanksdevURL, thanksdevGithubUsername, githubUsername, }: thanksdevOptions): string;
+export declare namespace thanksdev {
+    var badgeCategory: string;
+}
+/** At least one of the properties must be provided */
+export interface patreonOptions {
     /** The Patreon username to donate to */
@@ -211,3 +227,3 @@ patreonUsername?: string;
 /** At least one of the properties must be provided */
-interface opencollectiveOptions {
+export interface opencollectiveOptions {
     /** The Open Collective username to donate to */
@@ -224,3 +240,3 @@ opencollectiveUsername?: string;
 /** At least one of the properties must be provided */
-interface gratipayOptions {
+export interface gratipayOptions {
     /** The Gratipay username to donate to */
@@ -237,3 +253,3 @@ gratipayUsername?: string;
 /** At least one of the properties must be provided */
-interface flattrOptions {
+export interface flattrOptions {
     /** The Flattr code to donate to (e.g. 344188/balupton-on-Flattr) */
@@ -252,3 +268,3 @@ flattrCode?: string;
 /** At least one of the properties must be provided */
-interface paypalOptions {
+export interface paypalOptions {
     /**  The url to the paypal donate page */
@@ -266,3 +282,3 @@ paypalURL?: string;
 }
-interface cryptoOptions {
+export interface cryptoOptions {
     /** The url to the crypto donation page */
@@ -283,3 +299,3 @@ cryptoURL: string;
 }
-interface wishlistOptions {
+export interface wishlistOptions {
     /** The url to the wishlist page */
@@ -294,3 +310,3 @@ wishlistURL: string;
 /** At least one of the properties must be provided */
-interface buymeacoffeeOptions {
+export interface buymeacoffeeOptions {
     /**  The Buy Me A Coffee username to donate to */
@@ -307,3 +323,3 @@ buymeacoffeeUsername?: string;
 /** At least one of the properties must be provided */
-interface liberapayOptions {
+export interface liberapayOptions {
     /** The Liberapay username to donate to */
@@ -320,3 +336,3 @@ liberapayUsername?: string;
 /** At least one of the properties must be provided */
-interface thanksappOptions {
+export interface thanksappOptions {
     /** The repository slug (username/reponame) */
@@ -341,3 +357,3 @@ npmPackageName?: string;
 }
-interface slackinOptions {
+export interface slackinOptions {
     /** The slackin url (e.g. https://slack.bevry.me) */
@@ -357,3 +373,3 @@ slackinURL: string;
 }
-interface gabeaconOptions {
+export interface gabeaconOptions {
     /**  The google analytics tracing id (e.g. UA-XXXXX-XX) */
@@ -390,3 +406,3 @@ gaTrackingID: string;
 }
-interface facebooklikeOptions extends homepageOptions {
+export interface facebooklikeOptions extends homepageOptions {
     /** The facebook application id that the badge is for, defaults to the environment variable `FACEBOOK_APPLICATION_ID` */
@@ -401,3 +417,3 @@ facebookApplicationID?: string;
 }
-interface facebookfollowOptions {
+export interface facebookfollowOptions {
     /** The facebook username to follow */
@@ -438,3 +454,3 @@ facebookUsername: string;
 }
-interface quoraOptions {
+export interface quoraOptions {
     /**  The quora user to follow */
@@ -453,3 +469,2 @@ quoraUsername: string;
 }
-export {};
 //# sourceMappingURL=badges.d.ts.map

compiled-types/index.d.ts

@@ -15,6 +15,6 @@ import * as badges from './badges.js';
 }
-export declare type BadgeEntry = string | [string, object];
-export declare type BadgeEntries = BadgeEntry[];
-export declare type BadgesList = BadgeEntries;
-export declare type BadgesOptions = RenderOptions;
+export type BadgeEntry = string | [string, object];
+export type BadgeEntries = BadgeEntry[];
+export type BadgesList = BadgeEntries;
+export type BadgesOptions = RenderOptions;
 export interface BadgesConfig {
@@ -21,0 +21,0 @@ [key: string]: any;

edition-browsers/badges.js

@@ -283,2 +283,17 @@ // Import
 githubsponsors.badgeCategory = 'funding';
+/** ThanksDev Badge */
+export function thanksdev({ thanksdevURL, thanksdevGithubUsername, githubUsername, }) {
+    if (!thanksdevURL) {
+        if (!thanksdevGithubUsername && !githubUsername)
+            throw new Error('thanksdevGithubUsername and githubUsername are missing');
+        thanksdevURL = `https://thanks.dev/u/gh/${thanksdevGithubUsername || githubUsername}`;
+    }
+    // Create
+    const image = 'https://img.shields.io/badge/thanksdev-donate-yellow.svg';
+    const url = thanksdevURL;
+    const alt = 'ThanksDev donate button';
+    const title = 'Donate to this project using ThanksDev';
+    return badge({ image, alt, url, title });
+}
+thanksdev.badgeCategory = 'funding';
 /** Patreon Badge */
@@ -285,0 +300,0 @@ export function patreon({ patreonUsername, patreonURL, }) {

edition-deno/badges.ts

@@ -12,3 +12,3 @@ // Import
 
-interface twitterOptions {
+export interface twitterOptions {
 	/**  The twitter username to tweet at */
@@ -18,3 +18,3 @@ twitterUsername: string
 
-interface homepageOptions {
+export interface homepageOptions {
 	/** The page url that the badge will be for */
@@ -24,3 +24,3 @@ homepage: string
 
-interface githubUsernameOptions {
+export interface githubUsernameOptions {
 	/** The github username to use */
@@ -30,3 +30,3 @@ githubUsername: string
 
-interface githubSlugOptions {
+export interface githubSlugOptions {
 	/** The github slug of the project (e.g. bevry/badges) */
@@ -36,3 +36,3 @@ githubSlug: string
 
-interface npmOptions {
+export interface npmOptions {
 	/** The npm package name */
@@ -42,3 +42,3 @@ npmPackageName: string
 
-interface badgeOptions {
+export interface badgeOptions {
 	/** The URL to the image **/
@@ -73,3 +73,3 @@ image?: string
 
-interface shieldsOptions {
+export interface shieldsOptions {
 	/** The text for the left side of the badge */
@@ -110,3 +110,3 @@ left: string
 
-interface npmversionOptions {
+export interface npmversionOptions {
 	/** The repository slug (username/reponame) */
@@ -171,6 +171,8 @@ npmPackageName: string
 
-interface nodeicoOptions extends npmOptions {
-	/** See https://nodei.co for options
-	defined as either a string param1=&param2=
-	or an object {param1: '', param2: ''} that will be serialized to param1=&param2= etc. */
+export interface nodeicoOptions extends npmOptions {
+	/**
+	 * See https://nodei.co for options
+	 * defined as either a string `param1=&param2=`
+	 * or an object `{param1: '', param2: ''}` that will be serialized to `param1=&param2=` etc.
+	 */
 	nodeicoQueryString?: string | { [index: string]: any }
@@ -210,3 +212,3 @@ }
 
-interface saucelabsOptions {
+export interface saucelabsOptions {
 	/** The username of the sauncelabs account to use */
@@ -260,3 +262,3 @@ saucelabsUsername: string
 
-interface travisOptions extends githubSlugOptions {
+export interface travisOptions extends githubSlugOptions {
 	/** The TLD to use for travis, use "com" if you have moved to travis-ci.com instead of travis-ci.org */
@@ -289,3 +291,3 @@ travisTLD?: string
 
-interface codeshipOptions {
+export interface codeshipOptions {
 	/** The UUID for a specific project, which is available on the General tab in your project settings */
@@ -373,3 +375,3 @@ codeshipProjectUUID: string
 
-interface githubworkflowOptions extends githubSlugOptions {
+export interface githubworkflowOptions extends githubSlugOptions {
 	/** The name or location of the workflow file to show the badge for */
@@ -414,3 +416,3 @@ githubWorkflow: string
 /** At least one of the properties must be provided */
-interface sixtydevOptions {
+export interface sixtydevOptions {
 	/** The 60devs username to donate to */
@@ -443,3 +445,3 @@ sixtydevstipsID?: string
 /** At least one of the properties must be provided */
-interface githubsponsorsOptions {
+export interface githubsponsorsOptions {
 	/** The url to the GitHub donate page */
@@ -476,3 +478,35 @@ githubSponsorsURL?: string
 /** At least one of the properties must be provided */
-interface patreonOptions {
+export interface thanksdevOptions {
+	/** The url to the ThanksDev donate page */
+	thanksdevURL?: string
+	/** The GitHub username to donate to */
+	thanksdevGithubUsername?: string
+	/** The GitHub username fallback to donate to */
+	githubUsername?: string
+}
+/** ThanksDev Badge */
+export function thanksdev({
+	thanksdevURL,
+	thanksdevGithubUsername,
+	githubUsername,
+}: thanksdevOptions): string {
+	if (!thanksdevURL) {
+		if (!thanksdevGithubUsername && !githubUsername)
+			throw new Error('thanksdevGithubUsername and githubUsername are missing')
+		thanksdevURL = `https://thanks.dev/u/gh/${
+			thanksdevGithubUsername || githubUsername
+		}`
+	}
+
+	// Create
+	const image = 'https://img.shields.io/badge/thanksdev-donate-yellow.svg'
+	const url = thanksdevURL
+	const alt = 'ThanksDev donate button'
+	const title = 'Donate to this project using ThanksDev'
+	return badge({ image, alt, url, title })
+}
+thanksdev.badgeCategory = 'funding'
+
+/** At least one of the properties must be provided */
+export interface patreonOptions {
 	/** The Patreon username to donate to */
@@ -504,3 +538,3 @@ patreonUsername?: string
 /** At least one of the properties must be provided */
-interface opencollectiveOptions {
+export interface opencollectiveOptions {
 	/** The Open Collective username to donate to */
@@ -534,3 +568,3 @@ opencollectiveUsername?: string
 /** At least one of the properties must be provided */
-interface gratipayOptions {
+export interface gratipayOptions {
 	/** The Gratipay username to donate to */
@@ -562,3 +596,3 @@ gratipayUsername?: string
 /** At least one of the properties must be provided */
-interface flattrOptions {
+export interface flattrOptions {
 	/** The Flattr code to donate to (e.g. 344188/balupton-on-Flattr) */
@@ -598,3 +632,3 @@ flattrCode?: string
 /** At least one of the properties must be provided */
-interface paypalOptions {
+export interface paypalOptions {
 	/**  The url to the paypal donate page */
@@ -638,3 +672,3 @@ paypalURL?: string
 
-interface cryptoOptions {
+export interface cryptoOptions {
 	/** The url to the crypto donation page */
@@ -666,3 +700,3 @@ cryptoURL: string
 
-interface wishlistOptions {
+export interface wishlistOptions {
 	/** The url to the wishlist page */
@@ -686,3 +720,3 @@ wishlistURL: string
 /** At least one of the properties must be provided */
-interface buymeacoffeeOptions {
+export interface buymeacoffeeOptions {
 	/**  The Buy Me A Coffee username to donate to */
@@ -717,3 +751,3 @@ buymeacoffeeUsername?: string
 /** At least one of the properties must be provided */
-interface liberapayOptions {
+export interface liberapayOptions {
 	/** The Liberapay username to donate to */
@@ -746,3 +780,3 @@ liberapayUsername?: string
 /** At least one of the properties must be provided */
-interface thanksappOptions {
+export interface thanksappOptions {
 	/** The repository slug (username/reponame) */
@@ -806,3 +840,3 @@ npmPackageName?: string
 
-interface slackinOptions {
+export interface slackinOptions {
 	/** The slackin url (e.g. https://slack.bevry.me) */
@@ -836,3 +870,3 @@ slackinURL: string
 
-interface gabeaconOptions {
+export interface gabeaconOptions {
 	/**  The google analytics tracing id (e.g. UA-XXXXX-XX) */
@@ -897,3 +931,3 @@ gaTrackingID: string
 
-interface facebooklikeOptions extends homepageOptions {
+export interface facebooklikeOptions extends homepageOptions {
 	/** The facebook application id that the badge is for, defaults to the environment variable `FACEBOOK_APPLICATION_ID` */
@@ -923,3 +957,3 @@ facebookApplicationID?: string
 
-interface facebookfollowOptions {
+export interface facebookfollowOptions {
 	/** The facebook username to follow */
@@ -1010,3 +1044,3 @@ facebookUsername: string
 
-interface quoraOptions {
+export interface quoraOptions {
 	/**  The quora user to follow */
@@ -1013,0 +1047,0 @@ quoraUsername: string

LICENSE.md

@@ -11,14 +11,92 @@ <!-- LICENSEFILE/ -->
 
-<ul><li><a href="http://spdx.org/licenses/MIT.html">MIT License</a></li></ul>
+<ul><li><a href="http://spdx.org/licenses/Artistic-2.0.html">Artistic License 2.0</a></li></ul>
 
-<h2>MIT License</h2>
+<h2>The Artistic License 2.0</h2>
 
 <pre>
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+Copyright (c) 2000-2006, The Perl Foundation.
 
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+Preamble
+
+This license establishes the terms under which a given free software Package may be copied, modified, distributed, and/or redistributed. The intent is that the Copyright Holder maintains some artistic control over the development of that Package while still keeping the Package available as open source and free software.
+
+You are always permitted to make arrangements wholly outside of this license directly with the Copyright Holder of a given Package.  If the terms of this license do not permit the full use that you propose to make of the Package, you should contact the Copyright Holder and seek a different licensing arrangement.
+
+Definitions
+
+     "Copyright Holder" means the individual(s) or organization(s) named in the copyright notice for the entire Package.
+
+     "Contributor" means any party that has contributed code or other material to the Package, in accordance with the Copyright Holder's procedures.
+
+     "You" and "your" means any person who would like to copy, distribute, or modify the Package.
+
+     "Package" means the collection of files distributed by the Copyright Holder, and derivatives of that collection and/or of those files. A given Package may consist of either the Standard Version, or a Modified Version.
+
+     "Distribute" means providing a copy of the Package or making it accessible to anyone else, or in the case of a company or organization, to others outside of your company or organization.
+
+     "Distributor Fee" means any fee that you charge for Distributing this Package or providing support for this Package to another party.  It does not mean licensing fees.
+
+     "Standard Version" refers to the Package if it has not been modified, or has been modified only in ways explicitly requested by the Copyright Holder.
+
+     "Modified Version" means the Package, if it has been changed, and such changes were not explicitly requested by the Copyright Holder.
+
+     "Original License" means this Artistic License as Distributed with the Standard Version of the Package, in its current version or as it may be modified by The Perl Foundation in the future.
+
+     "Source" form means the source code, documentation source, and configuration files for the Package.
+
+     "Compiled" form means the compiled bytecode, object code, binary, or any other form resulting from mechanical transformation or translation of the Source form.
+
+Permission for Use and Modification Without Distribution
+
+(1) You are permitted to use the Standard Version and create and use Modified Versions for any purpose without restriction, provided that you do not Distribute the Modified Version.
+
+Permissions for Redistribution of the Standard Version
+
+(2) You may Distribute verbatim copies of the Source form of the Standard Version of this Package in any medium without restriction, either gratis or for a Distributor Fee, provided that you duplicate all of the original copyright notices and associated disclaimers.  At your discretion, such verbatim copies may or may not include a Compiled form of the Package.
+
+(3) You may apply any bug fixes, portability changes, and other modifications made available from the Copyright Holder.  The resulting Package will still be considered the Standard Version, and as such will be subject to the Original License.
+
+Distribution of Modified Versions of the Package as Source
+
+(4) You may Distribute your Modified Version as Source (either gratis or for a Distributor Fee, and with or without a Compiled form of the Modified Version) provided that you clearly document how it differs from the Standard Version, including, but not limited to, documenting any non-standard features, executables, or modules, and provided that you do at least ONE of the following:
+
+     (a) make the Modified Version available to the Copyright Holder of the Standard Version, under the Original License, so that the Copyright Holder may include your modifications in the Standard Version.
+     (b) ensure that installation of your Modified Version does not prevent the user installing or running the Standard Version. In addition, the Modified Version must bear a name that is different from the name of the Standard Version.
+     (c) allow anyone who receives a copy of the Modified Version to make the Source form of the Modified Version available to others under
+
+          (i) the Original License or
+          (ii) a license that permits the licensee to freely copy, modify and redistribute the Modified Version using the same licensing terms that apply to the copy that the licensee received, and requires that the Source form of the Modified Version, and of any works derived from it, be made freely available in that license fees are prohibited but Distributor Fees are allowed.
+
+Distribution of Compiled Forms of the Standard Version or Modified Versions without the Source
+
+(5)  You may Distribute Compiled forms of the Standard Version without the Source, provided that you include complete instructions on how to get the Source of the Standard Version.  Such instructions must be valid at the time of your distribution.  If these instructions, at any time while you are carrying out such distribution, become invalid, you must provide new instructions on demand or cease further distribution. If you provide valid instructions or cease distribution within thirty days after you become aware that the instructions are invalid, then you do not forfeit any of your rights under this license.
+
+(6)  You may Distribute a Modified Version in Compiled form without the Source, provided that you comply with Section 4 with respect to the Source of the Modified Version.
+
+Aggregating or Linking the Package
+
+(7)  You may aggregate the Package (either the Standard Version or Modified Version) with other packages and Distribute the resulting aggregation provided that you do not charge a licensing fee for the Package.  Distributor Fees are permitted, and licensing fees for other components in the aggregation are permitted. The terms of this license apply to the use and Distribution of the Standard or Modified Versions as included in the aggregation.
+
+(8) You are permitted to link Modified and Standard Versions with other works, to embed the Package in a larger work of your own, or to build stand-alone binary or bytecode versions of applications that include the Package, and Distribute the result without restriction, provided the result does not expose a direct interface to the Package.
+
+Items That are Not Considered Part of a Modified Version
+
+(9) Works (including, but not limited to, modules and scripts) that merely extend or make use of the Package, do not, by themselves, cause the Package to be a Modified Version.  In addition, such works are not considered parts of the Package itself, and are not subject to the terms of this license.
+
+General Provisions
+
+(10)  Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.
+
+(11)  If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.
+
+(12)  This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.
+
+(13)  This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.
+
+(14)  Disclaimer of Warranty:
+THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 </pre>
 
 <!-- /LICENSEFILE -->

package.json

 {
   "name": "badges",
-  "version": "4.27.0",
+  "version": "4.28.0-next.1679639918.7888b4b698a8624d753d087c0967c5a9cdf392b7",
   "description": "The definitive collection of badges for rendering",
   "homepage": "https://github.com/bevry/badges",
-  "license": "MIT",
+  "license": "Artistic-2.0",
   "keywords": [
@@ -25,3 +25,3 @@ "+1",
     "donation",
-    "es2019",
+    "es2021",
     "facebook",
@@ -87,4 +87,2 @@ "facebook follow",
       "npmdownloads",
-      "daviddm",
-      "daviddmdev",
       "---",
@@ -150,3 +148,3 @@ "githubsponsors",
     {
-      "description": "TypeScript compiled against ES2020 for web browsers with Import for modules",
+      "description": "TypeScript compiled against ES2021 for web browsers with Import for modules",
       "directory": "edition-browsers",
@@ -165,4 +163,4 @@ "entry": "index.js",
     {
-      "description": "TypeScript compiled against ES2019 for Node.js 10 || 12 || 14 || 16 with Require for modules",
-      "directory": "edition-es2019",
+      "description": "TypeScript compiled against ES2021 for Node.js 10 || 12 || 14 || 16 || 18 || 19 with Require for modules",
+      "directory": "edition-es2021",
       "entry": "index.js",
@@ -172,7 +170,7 @@ "tags": [
         "javascript",
-        "es2019",
+        "es2021",
         "require"
       ],
       "engines": {
-        "node": "10 || 12 || 14 || 16",
+        "node": "10 || 12 || 14 || 16 || 18 || 19",
         "browsers": false
@@ -182,4 +180,4 @@ }
     {
-      "description": "TypeScript compiled against ES2019 for Node.js 12 || 14 || 16 with Import for modules",
-      "directory": "edition-es2019-esm",
+      "description": "TypeScript compiled against ES2021 for Node.js 12 || 14 || 16 || 18 || 19 with Import for modules",
+      "directory": "edition-es2021-esm",
       "entry": "index.js",
@@ -189,7 +187,7 @@ "tags": [
         "javascript",
-        "es2019",
+        "es2021",
         "import"
       ],
       "engines": {
-        "node": "12 || 14 || 16",
+        "node": "12 || 14 || 16 || 18 || 19",
         "browsers": false
@@ -201,7 +199,7 @@ }
   "type": "module",
-  "main": "edition-es2019/index.js",
+  "main": "edition-es2021/index.js",
   "exports": {
     "node": {
-      "import": "./edition-es2019-esm/index.js",
-      "require": "./edition-es2019/index.js"
+      "import": "./edition-es2021-esm/index.js",
+      "require": "./edition-es2021/index.js"
     },
@@ -215,27 +213,27 @@ "browser": {
   "devDependencies": {
-    "@bevry/update-contributors": "^1.19.0",
-    "@typescript-eslint/eslint-plugin": "^4.28.5",
-    "@typescript-eslint/parser": "^4.28.5",
-    "assert-helpers": "^8.2.0",
-    "eslint": "^7.31.0",
-    "eslint-config-bevry": "^3.26.0",
-    "eslint-config-prettier": "^8.3.0",
-    "eslint-plugin-prettier": "^3.4.0",
-    "kava": "^5.14.0",
+    "@bevry/update-contributors": "^1.21.0",
+    "@typescript-eslint/eslint-plugin": "^5.56.0",
+    "@typescript-eslint/parser": "^5.56.0",
+    "assert-helpers": "^8.4.0",
+    "eslint": "^8.36.0",
+    "eslint-config-bevry": "^3.27.0",
+    "eslint-config-prettier": "^8.8.0",
+    "eslint-plugin-prettier": "^4.2.1",
+    "kava": "^5.15.0",
     "make-deno-edition": "^1.3.0",
-    "prettier": "^2.3.2",
-    "projectz": "^2.21.0",
-    "surge": "^0.23.0",
-    "typedoc": "^0.21.4",
-    "typescript": "4.3.5",
-    "valid-directory": "^3.7.0",
-    "valid-module": "^1.16.0"
+    "prettier": "^2.8.6",
+    "projectz": "^2.22.0",
+    "surge": "^0.23.1",
+    "typedoc": "^0.23.28",
+    "typescript": "5.0.2",
+    "valid-directory": "^3.9.0",
+    "valid-module": "^1.17.0"
   },
   "scripts": {
     "our:clean": "rm -Rf ./docs ./edition* ./es2015 ./es5 ./out ./.next",
-    "our:compile": "npm run our:compile:deno && npm run our:compile:edition-browsers && npm run our:compile:edition-es2019 && npm run our:compile:edition-es2019-esm && npm run our:compile:types",
+    "our:compile": "npm run our:compile:deno && npm run our:compile:edition-browsers && npm run our:compile:edition-es2021 && npm run our:compile:edition-es2021-esm && npm run our:compile:types",
     "our:compile:deno": "make-deno-edition --attempt",
-    "our:compile:edition-browsers": "tsc --module ESNext --target ES2020 --outDir ./edition-browsers --project tsconfig.json && ( test ! -d edition-browsers/source || ( mv edition-browsers/source edition-temp && rm -Rf edition-browsers && mv edition-temp edition-browsers ) )",
-    "our:compile:edition-es2019": "tsc --module commonjs --target ES2019 --outDir ./edition-es2019 --project tsconfig.json && ( test ! -d edition-es2019/source || ( mv edition-es2019/source edition-temp && rm -Rf edition-es2019 && mv edition-temp edition-es2019 ) ) && echo '{\"type\": \"commonjs\"}' > edition-es2019/package.json",
-    "our:compile:edition-es2019-esm": "tsc --module ESNext --target ES2019 --outDir ./edition-es2019-esm --project tsconfig.json && ( test ! -d edition-es2019-esm/source || ( mv edition-es2019-esm/source edition-temp && rm -Rf edition-es2019-esm && mv edition-temp edition-es2019-esm ) ) && echo '{\"type\": \"module\"}' > edition-es2019-esm/package.json",
+    "our:compile:edition-browsers": "tsc --module ESNext --target ES2021 --outDir ./edition-browsers --project tsconfig.json && ( test ! -d edition-browsers/source || ( mv edition-browsers/source edition-temp && rm -Rf edition-browsers && mv edition-temp edition-browsers ) )",
+    "our:compile:edition-es2021": "tsc --module commonjs --target ES2021 --outDir ./edition-es2021 --project tsconfig.json && ( test ! -d edition-es2021/source || ( mv edition-es2021/source edition-temp && rm -Rf edition-es2021 && mv edition-temp edition-es2021 ) ) && echo '{\"type\": \"commonjs\"}' > edition-es2021/package.json",
+    "our:compile:edition-es2021-esm": "tsc --module ESNext --target ES2021 --outDir ./edition-es2021-esm --project tsconfig.json && ( test ! -d edition-es2021-esm/source || ( mv edition-es2021-esm/source edition-temp && rm -Rf edition-es2021-esm && mv edition-temp edition-es2021-esm ) ) && echo '{\"type\": \"module\"}' > edition-es2021-esm/package.json",
     "our:compile:types": "tsc --project tsconfig.json --emitDeclarationOnly --declaration --declarationMap --declarationDir ./compiled-types && ( test ! -d compiled-types/source || ( mv compiled-types/source edition-temp && rm -Rf compiled-types && mv edition-temp compiled-types ) )",
@@ -262,3 +260,3 @@ "our:deploy": "echo no need for this project",
     "our:verify:prettier": "prettier --write .",
-    "test": "node ./edition-es2019/test.js"
+    "test": "node ./edition-es2021/test.js"
   },
@@ -274,2 +272,2 @@ "eslintConfig": {
   }
-}
+}

README.md

@@ -13,4 +13,2 @@ <!-- TITLE/ -->
 <span class="badge-npmdownloads"><a href="https://npmjs.org/package/badges" title="View this project on NPM"><img src="https://img.shields.io/npm/dm/badges.svg" alt="NPM downloads" /></a></span>
-<span class="badge-daviddm"><a href="https://david-dm.org/bevry/badges" title="View the status of this project's dependencies on DavidDM"><img src="https://img.shields.io/david/bevry/badges.svg" alt="Dependency Status" /></a></span>
-<span class="badge-daviddmdev"><a href="https://david-dm.org/bevry/badges#info=devDependencies" title="View the status of this project's development dependencies on DavidDM"><img src="https://img.shields.io/david/dev/bevry/badges.svg" alt="Dev Dependency Status" /></a></span>
 <br class="badge-separator" />
@@ -186,3 +184,3 @@ <span class="badge-githubsponsors"><a href="https://github.com/sponsors/balupton" title="Donate to this project using GitHub Sponsors"><img src="https://img.shields.io/badge/github-donate-yellow.svg" alt="GitHub Sponsors donate button" /></a></span>
 <script type="module">
-    import * as pkg from '//cdn.skypack.dev/badges@^4.27.0'
+    import * as pkg from '//cdn.skypack.dev/badges@^4.28.0'
 </script>
@@ -195,3 +193,3 @@ ```
 <script type="module">
-    import * as pkg from '//unpkg.com/badges@^4.27.0'
+    import * as pkg from '//unpkg.com/badges@^4.28.0'
 </script>
@@ -204,3 +202,3 @@ ```
 <script type="module">
-    import * as pkg from '//dev.jspm.io/badges@4.27.0'
+    import * as pkg from '//dev.jspm.io/badges@4.28.0'
 </script>
@@ -214,6 +212,6 @@ ```
 <ul><li><code>badges/source/index.ts</code> is <a href="https://www.typescriptlang.org/" title="TypeScript is a typed superset of JavaScript that compiles to plain JavaScript. ">TypeScript</a> source code with <a href="https://babeljs.io/docs/learn-es2015/#modules" title="ECMAScript Modules">Import</a> for modules</li>
-<li><code>badges/edition-browsers/index.js</code> is <a href="https://www.typescriptlang.org/" title="TypeScript is a typed superset of JavaScript that compiles to plain JavaScript. ">TypeScript</a> compiled against <a href="https://en.wikipedia.org/wiki/ECMAScript#11th_Edition_–_ECMAScript_2020" title="ECMAScript ES2020">ES2020</a> for web browsers with <a href="https://babeljs.io/docs/learn-es2015/#modules" title="ECMAScript Modules">Import</a> for modules</li>
-<li><code>badges</code> aliases <code>badges/edition-es2019/index.js</code></li>
-<li><code>badges/edition-es2019/index.js</code> is <a href="https://www.typescriptlang.org/" title="TypeScript is a typed superset of JavaScript that compiles to plain JavaScript. ">TypeScript</a> compiled against <a href="https://en.wikipedia.org/wiki/ECMAScript#10th_Edition_-_ECMAScript_2019" title="ECMAScript ES2019">ES2019</a> for <a href="https://nodejs.org" title="Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine">Node.js</a> 10 || 12 || 14 || 16 with <a href="https://nodejs.org/dist/latest-v5.x/docs/api/modules.html" title="Node/CJS Modules">Require</a> for modules</li>
-<li><code>badges/edition-es2019-esm/index.js</code> is <a href="https://www.typescriptlang.org/" title="TypeScript is a typed superset of JavaScript that compiles to plain JavaScript. ">TypeScript</a> compiled against <a href="https://en.wikipedia.org/wiki/ECMAScript#10th_Edition_-_ECMAScript_2019" title="ECMAScript ES2019">ES2019</a> for <a href="https://nodejs.org" title="Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine">Node.js</a> 12 || 14 || 16 with <a href="https://babeljs.io/docs/learn-es2015/#modules" title="ECMAScript Modules">Import</a> for modules</li></ul>
+<li><code>badges/edition-browsers/index.js</code> is <a href="https://www.typescriptlang.org/" title="TypeScript is a typed superset of JavaScript that compiles to plain JavaScript. ">TypeScript</a> compiled against ES2021 for web browsers with <a href="https://babeljs.io/docs/learn-es2015/#modules" title="ECMAScript Modules">Import</a> for modules</li>
+<li><code>badges</code> aliases <code>badges/edition-es2021/index.js</code></li>
+<li><code>badges/edition-es2021/index.js</code> is <a href="https://www.typescriptlang.org/" title="TypeScript is a typed superset of JavaScript that compiles to plain JavaScript. ">TypeScript</a> compiled against ES2021 for <a href="https://nodejs.org" title="Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine">Node.js</a> 10 || 12 || 14 || 16 || 18 || 19 with <a href="https://nodejs.org/dist/latest-v5.x/docs/api/modules.html" title="Node/CJS Modules">Require</a> for modules</li>
+<li><code>badges/edition-es2021-esm/index.js</code> is <a href="https://www.typescriptlang.org/" title="TypeScript is a typed superset of JavaScript that compiles to plain JavaScript. ">TypeScript</a> compiled against ES2021 for <a href="https://nodejs.org" title="Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine">Node.js</a> 12 || 14 || 16 || 18 || 19 with <a href="https://babeljs.io/docs/learn-es2015/#modules" title="ECMAScript Modules">Import</a> for modules</li></ul>
 
@@ -300,4 +298,4 @@ <!-- /INSTALL -->
 
-<ul><li><a href="http://spdx.org/licenses/MIT.html">MIT License</a></li></ul>
+<ul><li><a href="http://spdx.org/licenses/Artistic-2.0.html">Artistic License 2.0</a></li></ul>
 
 <!-- /LICENSE -->

source/badges.ts

@@ -12,3 +12,3 @@ // Import
 
-interface twitterOptions {
+export interface twitterOptions {
 	/**  The twitter username to tweet at */
@@ -18,3 +18,3 @@ twitterUsername: string
 
-interface homepageOptions {
+export interface homepageOptions {
 	/** The page url that the badge will be for */
@@ -24,3 +24,3 @@ homepage: string
 
-interface githubUsernameOptions {
+export interface githubUsernameOptions {
 	/** The github username to use */
@@ -30,3 +30,3 @@ githubUsername: string
 
-interface githubSlugOptions {
+export interface githubSlugOptions {
 	/** The github slug of the project (e.g. bevry/badges) */
@@ -36,3 +36,3 @@ githubSlug: string
 
-interface npmOptions {
+export interface npmOptions {
 	/** The npm package name */
@@ -42,3 +42,3 @@ npmPackageName: string
 
-interface badgeOptions {
+export interface badgeOptions {
 	/** The URL to the image **/
@@ -73,3 +73,3 @@ image?: string
 
-interface shieldsOptions {
+export interface shieldsOptions {
 	/** The text for the left side of the badge */
@@ -110,3 +110,3 @@ left: string
 
-interface npmversionOptions {
+export interface npmversionOptions {
 	/** The repository slug (username/reponame) */
@@ -171,6 +171,8 @@ npmPackageName: string
 
-interface nodeicoOptions extends npmOptions {
-	/** See https://nodei.co for options
-	defined as either a string param1=&param2=
-	or an object {param1: '', param2: ''} that will be serialized to param1=&param2= etc. */
+export interface nodeicoOptions extends npmOptions {
+	/**
+	 * See https://nodei.co for options
+	 * defined as either a string `param1=&param2=`
+	 * or an object `{param1: '', param2: ''}` that will be serialized to `param1=&param2=` etc.
+	 */
 	nodeicoQueryString?: string | { [index: string]: any }
@@ -210,3 +212,3 @@ }
 
-interface saucelabsOptions {
+export interface saucelabsOptions {
 	/** The username of the sauncelabs account to use */
@@ -260,3 +262,3 @@ saucelabsUsername: string
 
-interface travisOptions extends githubSlugOptions {
+export interface travisOptions extends githubSlugOptions {
 	/** The TLD to use for travis, use "com" if you have moved to travis-ci.com instead of travis-ci.org */
@@ -289,3 +291,3 @@ travisTLD?: string
 
-interface codeshipOptions {
+export interface codeshipOptions {
 	/** The UUID for a specific project, which is available on the General tab in your project settings */
@@ -373,3 +375,3 @@ codeshipProjectUUID: string
 
-interface githubworkflowOptions extends githubSlugOptions {
+export interface githubworkflowOptions extends githubSlugOptions {
 	/** The name or location of the workflow file to show the badge for */
@@ -414,3 +416,3 @@ githubWorkflow: string
 /** At least one of the properties must be provided */
-interface sixtydevOptions {
+export interface sixtydevOptions {
 	/** The 60devs username to donate to */
@@ -443,3 +445,3 @@ sixtydevstipsID?: string
 /** At least one of the properties must be provided */
-interface githubsponsorsOptions {
+export interface githubsponsorsOptions {
 	/** The url to the GitHub donate page */
@@ -476,3 +478,35 @@ githubSponsorsURL?: string
 /** At least one of the properties must be provided */
-interface patreonOptions {
+export interface thanksdevOptions {
+	/** The url to the ThanksDev donate page */
+	thanksdevURL?: string
+	/** The GitHub username to donate to */
+	thanksdevGithubUsername?: string
+	/** The GitHub username fallback to donate to */
+	githubUsername?: string
+}
+/** ThanksDev Badge */
+export function thanksdev({
+	thanksdevURL,
+	thanksdevGithubUsername,
+	githubUsername,
+}: thanksdevOptions): string {
+	if (!thanksdevURL) {
+		if (!thanksdevGithubUsername && !githubUsername)
+			throw new Error('thanksdevGithubUsername and githubUsername are missing')
+		thanksdevURL = `https://thanks.dev/u/gh/${
+			thanksdevGithubUsername || githubUsername
+		}`
+	}
+
+	// Create
+	const image = 'https://img.shields.io/badge/thanksdev-donate-yellow.svg'
+	const url = thanksdevURL
+	const alt = 'ThanksDev donate button'
+	const title = 'Donate to this project using ThanksDev'
+	return badge({ image, alt, url, title })
+}
+thanksdev.badgeCategory = 'funding'
+
+/** At least one of the properties must be provided */
+export interface patreonOptions {
 	/** The Patreon username to donate to */
@@ -504,3 +538,3 @@ patreonUsername?: string
 /** At least one of the properties must be provided */
-interface opencollectiveOptions {
+export interface opencollectiveOptions {
 	/** The Open Collective username to donate to */
@@ -534,3 +568,3 @@ opencollectiveUsername?: string
 /** At least one of the properties must be provided */
-interface gratipayOptions {
+export interface gratipayOptions {
 	/** The Gratipay username to donate to */
@@ -562,3 +596,3 @@ gratipayUsername?: string
 /** At least one of the properties must be provided */
-interface flattrOptions {
+export interface flattrOptions {
 	/** The Flattr code to donate to (e.g. 344188/balupton-on-Flattr) */
@@ -598,3 +632,3 @@ flattrCode?: string
 /** At least one of the properties must be provided */
-interface paypalOptions {
+export interface paypalOptions {
 	/**  The url to the paypal donate page */
@@ -638,3 +672,3 @@ paypalURL?: string
 
-interface cryptoOptions {
+export interface cryptoOptions {
 	/** The url to the crypto donation page */
@@ -666,3 +700,3 @@ cryptoURL: string
 
-interface wishlistOptions {
+export interface wishlistOptions {
 	/** The url to the wishlist page */
@@ -686,3 +720,3 @@ wishlistURL: string
 /** At least one of the properties must be provided */
-interface buymeacoffeeOptions {
+export interface buymeacoffeeOptions {
 	/**  The Buy Me A Coffee username to donate to */
@@ -717,3 +751,3 @@ buymeacoffeeUsername?: string
 /** At least one of the properties must be provided */
-interface liberapayOptions {
+export interface liberapayOptions {
 	/** The Liberapay username to donate to */
@@ -746,3 +780,3 @@ liberapayUsername?: string
 /** At least one of the properties must be provided */
-interface thanksappOptions {
+export interface thanksappOptions {
 	/** The repository slug (username/reponame) */
@@ -806,3 +840,3 @@ npmPackageName?: string
 
-interface slackinOptions {
+export interface slackinOptions {
 	/** The slackin url (e.g. https://slack.bevry.me) */
@@ -836,3 +870,3 @@ slackinURL: string
 
-interface gabeaconOptions {
+export interface gabeaconOptions {
 	/**  The google analytics tracing id (e.g. UA-XXXXX-XX) */
@@ -897,3 +931,3 @@ gaTrackingID: string
 
-interface facebooklikeOptions extends homepageOptions {
+export interface facebooklikeOptions extends homepageOptions {
 	/** The facebook application id that the badge is for, defaults to the environment variable `FACEBOOK_APPLICATION_ID` */
@@ -923,3 +957,3 @@ facebookApplicationID?: string
 
-interface facebookfollowOptions {
+export interface facebookfollowOptions {
 	/** The facebook username to follow */
@@ -1010,3 +1044,3 @@ facebookUsername: string
 
-interface quoraOptions {
+export interface quoraOptions {
 	/**  The quora user to follow */
@@ -1013,0 +1047,0 @@ quoraUsername: string

tsconfig.json

@@ -9,3 +9,3 @@ {
     "strict": true,
-    "target": "ES2019",
+    "target": "ES2021",
     "module": "ESNext"
@@ -12,0 +12,0 @@ },

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

227243

increased by1.27%

Lines of code

4855

increased by2.73%

Worsened metrics

Number of low quality alerts

1

increased byInfinity%

Number of lines in readme file

296

decreased by-0.67%

No dependency changes