npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

easton

v1.0.1

Published

Use ANSI styles and HEX/RGB in CLI

Downloads

844

Readme

Easton

Use ANSI styles and HEX/RGB in CLI

npm license

img

Quick Start

Get easton up and running quickly!

  1. Run:

    npm install easton
    pnpm install easton
    yarn add easton
    bun add easton
  2. Use:

    ESM (ECMAScript Modules)

    import easton from 'easton';
    
    // Basic usage
    console.log(easton('bold')('This is bold text'));
    console.log(easton('#FF0000')('This is red text'));
    console.log(easton(255, 0, 0)('This is also red text'));
    
    // Combining styles and colors
    console.log(easton('#00FF00', 'bold', 'underline')('Green, bold, and underlined'));
    
    // Nesting styles
    console.log(easton('bold')(
      'Bold ' + easton('#FF0000')('and red ') + 'text'
    ));

    CJS (CommonJS)

    const easton = require('easton');
    
    // Basic usage
    console.log(easton('bold')('This is bold text'));
    console.log(easton('#FF0000')('This is red text'));
    console.log(easton(255, 0, 0)('This is also red text'));
    
    // Combining styles and colors
    console.log(easton('#00FF00', 'bold', 'underline')('Green, bold, and underlined'));
    
    // Nesting styles
    console.log(easton('bold')(
      'Bold ' + easton('#FF0000')('and red ') + 'text'
    ));

Usage

Easton provides a simple and intuitive API for styling your console output:

easton(...styles)(text)

Where styles can be:

  • Hex color codes (e.g., '#FF0000')
  • RGB values (e.g., 255, 0, 0)
  • Style names (e.g., 'bold', 'italic')

You can combine multiple styles by passing them as separate arguments.

Available Styles

  • bold: Bold text
  • italic: Italic text
  • underline: Underlined text
  • strikethrough: ~~Strikethrough~~
  • blink: (blink - works only in some terminals)
  • inverse: Reverses the foreground and background colors
  • hidden: Hidden text

styles

Colors

Easton supports:

  • Full HEX color codes (e.g., '#FF00FF')
  • RGB values (e.g., 255, 0, 255)

Examples

ESM (ECMAScript Modules)

import easton from 'easton';

// Basic styles
console.log(easton('bold')('Bold text'));
console.log(easton('italic')('Italic text'));
console.log(easton('underline')('Underlined text'));

// HEX colors
console.log(easton('#FF0000')('Red text'));
console.log(easton('#00FF00')('Green text'));
console.log(easton('#0000FF')('Blue text'));

// RGB colors
console.log(easton(255, 0, 0)('Red text'));
console.log(easton(0, 255, 0)('Green text'));
console.log(easton(0, 0, 255)('Blue text'));

// Combining styles and colors
console.log(easton('#FF00FF', 'bold', 'underline')('Bold, underlined magenta text'));

// Nesting styles
console.log(easton('bold')(
  'This is bold ' + easton('#FF0000')('and red ') + 'text'
));

CJS (CommonJS)

const easton = require('easton');

// Basic styles
console.log(easton('bold')('Bold text'));
console.log(easton('italic')('Italic text'));
console.log(easton('underline')('Underlined text'));

// HEX colors
console.log(easton('#FF0000')('Red text'));
console.log(easton('#00FF00')('Green text'));
console.log(easton('#0000FF')('Blue text'));

// RGB colors
console.log(easton(255, 0, 0)('Red text'));
console.log(easton(0, 255, 0)('Green text'));
console.log(easton(0, 0, 255)('Blue text'));

// Combining styles and colors
console.log(easton('#FF00FF', 'bold', 'underline')('Bold, underlined magenta text'));

// Nesting styles
console.log(easton('bold')(
  'This is bold ' + easton('#FF0000')('and red ') + 'text'
));

Contributing

We welcome contributions to easton! Whether it's reporting a bug, suggesting an enhancement, or submitting a pull request, your input is valued.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contact

For any questions, suggestions, or feedback, please contact love1ace.