consoleswag
TypeScript icon, indicating that this package has built-in type declarations

5.0.6 • Public • Published

consoleSwag Logo

consoleSwag.js

Console messages, with swag.

npm (scoped) downloads (scoped) npm bundle size (minified) npm bundle size (minified)



🙉 What's this all about?

Tired of those boring and basic console messages? Ever wanted to express your creativity through your console? Just want to add some hidden easter-eggs into your project? Well, then this is the library for you!

consoleSwag.js helps Javascript developers make console message more fun; making them stand out and pop with style. Whether you want to display an image banner, or just prepend existing console messages with emojis, we've got you covered. The best part? Our library is extremely lightweight and developer friendly- which means it won't take a toll on your project, and it's uber-simple to implement.

This shouldn't need to be said, but just in case: Please DO NOT use this in any enterprise production software! This was made purely for fun, and to maybe make your debugging sessions a little less mundane. You have been warned.

⚡️ Fast implementation

Step 1: Paste the following script tag into the head of your HTML document:

<script src="https://cdn.jsdelivr.net/npm/consoleswag/lib/cjs/index.min.js"></script>
<script type="text/javascript">
  console.swag({
    //options
  });
</script>

Or, use npm:

//Install:
npm i consoleswag

//Then, paste this at the top of your JavaScript file:
const cswag = require("consoleswag");
cswag.swag({
  //options
});

//Note: If your project is a module, you can paste this in your JavaScript file instead:
import cswag from 'consoleswag';
cswag.swag({
  //options
});

Step 2: Use any of the commands explained at below however you like.

Options

{
	theme: "blackandwhite",   //default, blackandwhite, neon
	customStyles: {
		log: ["color:blue","font-size:15px"],
		warn: ["color:orange","font-size:10px"],
		info: ["color:green","font-size:10px"],
		error: ["color:red","font-size:20px"],
	},
	emoji: true,
	customEmoji: {
		log: "🚀",
		warn: "🙉",
		info: "🤷‍♂️",
		error: "❌",
		image: "🕹️"
	},
	customTagText: {
		log: "My Log",
		warn: "Woah, warning",
		info: "Attention",
		error: "FAILURE",
	},
	memeErrors: true,
	angryErrors: true,
	uncensorAngryErrors: true,
	customAngryText: ["wtf","really???"],
	fileStackApiKey: "xxxxx",		//required for console.asciiImage() & console.screenshot()
}

🎉 Examples

⌶ Basic (Big Text)

console.bigText("So much swag!"); //=> Basic default styling

Basic Style


🌆 Image Banner

console.imageBanner("https://picsum.photos/200/600", "So Much Swag!"); //=> Image Banner

Basic Style


👏 Supporters

Stargazers repo roster for @dillonbaird/consoleswag Forkers repo roster for @dillonbaird/consoleswag

Animated footer bars


Back to top

Package Sidebar

Install

npm i consoleswag

Weekly Downloads

3

Version

5.0.6

License

MIT

Unpacked Size

1.59 MB

Total Files

10

Last publish

Collaborators

  • dillonbaird