Git Product home page Git Product logo

fullcolor's Introduction

Fullcolor: A minimalist 24-bit color module for Node.js

Use full 24-bit colors in Node.js! This module makes it simple to use and has zero dependencies.

image

Installation

npm install fullcolor
# Alternatively:
# yarn install fullcolor

In your node.js file, include the module

const fullcolor = require('fullcolor');

API

The fullcolor function simply adds escape sequences and returns the text as a string. The first argument is always the text you want to color. This also only changes the text color and not the background.

Install

fullcolor(text, colorString)

As of right now, only hex values are accepted for colorString.

const fullcolor = require('fullcolor');

console.log(fullcolor('Let there be colors!', '#66ccff'));
console.log(fullcolor('Let there be colors!', '#6cf'));

fullcolor(text, r, g, b)

The values r,g,b must be integers from 0 to 255.

const fullcolor = require('fullcolor');

console.log(fullcolor('Let there be colors!', 102, 204, 255));

So simple, you might not even need to use it!

If you simply want to print a few different colors to the terminal, you might not even need this module! Just copy and paste this snippet:

// Settings in this example:
// text = 'TEXT GOES HERE'
// r = 102
// g = 204
// b = 255
console.log('\x1b[38;2;102;204;255mTEXT GOES HERE\x1b[0m')

// If you use fullcolor, it becomes:
console.log(fullcolor('TEXT GOES HERE', 102, 204, 255))

// If you don't use fullcolor, I'm still happy that you read this.
// I hope this was helpful and hope that I helped you avoid adding a dependency.
// Also, a GitHub star is appreciated ;)

But if you do want a lightweight abstraction, then this module might be for you!

Simple and clean

No side effects. No state. No singletons. Does not monkeypatch or mutate anything.

No dependencies. Ever.

No dependencies. Never will have dependencies. Except of course JavaScript. This might even work in the browser as-is (this doesn't even use Node.js standard libraries), but I'm not sure how useful that'll be.

Why? This is a simple tool that adds a few characters to a string. That's it. Dependencies shouldn't be needed for something this simple. Each dependency is a potential security liability and another thing to maintain.

Versioning

Will follow semver. Major version every time a breaking change is introduced. Minor version on new features. Changes within a major version (e.g. 2.x and 2.y; y > x) will be backward compatible.

License

Licensed under Apache-2.0. Written and copyright by Iris Li.

Further information

I learned most my truecolor stuff from this awesome gist: https://gist.github.com/XVilka/8346728

fullcolor's People

Contributors

irisli avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.