# nstypocolors nstypocolors Icon [![npm version](https://img.shields.io/npm/v/nstypocolors?color=crimson&logo=npm)](https://www.npmjs.com/package/nstypocolors) ![Downloads](https://img.shields.io/npm/dt/nstypocolors?style=flat) [![Discord](https://img.shields.io/discord/855781247480496130.svg?color=5865F2&logo=discord&logoColor=white)](https://discord.gg/7SAcEv7MDd) [![GitHub contributors](https://img.shields.io/github/contributors/nsgpriyanshu/creatorsworld.svg?color=af52de)](https://github.com/nsgpriyanshu/creatorsworld/graphs/contributors) [![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release)](https://github.com/nsgpriyanshu/nstypocolors) [![CodeQL](https://github.com/nsgpriyanshu/nstypocolors/actions/workflows/codeql.yml/badge.svg)](https://github.com/nsgpriyanshu/nstypocolors/actions/workflows/codeql.yml) ![Last Commit](https://img.shields.io/github/last-commit/nsgpriyanshu/nstypocolors) [![Vitest](https://img.shields.io/badge/test-Vitest-%23FCC72B?logo=vitest&color=729B1B)](https://vitest.dev/)
Minimal color and gradient logging utilities for modern TypeScript projects. --- ## Features - Comprehensive color support: standard, bright, pastel, and background colors - Special gradient effects including rainbow and success animations - Integrated CLI tool (`nstc`) for direct terminal usage - Help documentation and command reference - Persistent default color configuration - Full TypeScript support with strong type safety --- ## Installation ```bash npm install nstypocolors ``` --- ## Usage ### TypeScript/JavaScript ```ts import { logRed, logGreen, logBlue, logSuccess } from 'nstypocolors' logRed('This is red') logGreen('This is green') logBlue('This is blue') logSuccess('Success message with gradient effect') ``` --- ## CLI Reference The package includes a command-line interface accessible via `nstc`. ### Basic Syntax ```bash nstc "Your message" --color-flag ``` ### Available Options | Flag | Description | | ------------ | -------------------------- | | `--red` | Red text | | `--green` | Green text | | `--blue` | Blue text | | `--gradient` | Rainbow gradient effect | | `--success` | Success gradient (default) | | `help` | Display help documentation | --- ## Help Documentation View all available commands and options: ```bash nstc help ``` --- ## Default Color Configuration Set a persistent default color to avoid repeatedly specifying color flags. The default color is stored locally in your home directory and applies automatically when no color option is provided. ### Commands #### Set Default Color ```bash nstc setdefault ``` Set a default color that will be used for all messages when no color flag is provided. **Examples:** ```bash nstc setdefault --build nstc setdefault --green nstc setdefault --pastel-blue nstc setdefault --success ``` You can replace `` with any valid color flag supported by `nstc`. #### Get Current Default ```bash nstc getdefault ``` Display the currently configured default color. #### Clear Default ```bash nstc cleardefault ``` Remove the default color configuration. ### Usage Once a default is set, simply run: ```bash nstc "Your message" ``` The message will automatically use your configured default color. You can still override it by specifying a color flag: ```bash nstc "Your message" --red ``` ### Storage The configuration is stored as a JSON file in your home directory (`~/.nstc-config.json`) and persists across terminal sessions. --- ## Example Usage ### Help Menu Help Menu Screenshot ### Terminal Output Terminal Output Screenshot --- ## Available Colors **Standard:** Red, Green, Pink, Yellow, Blue, Magenta, Cyan, White, Black **Bright:** Bright Red, Bright Green, Bright Yellow, Bright Blue, Bright Magenta, Bright Cyan, Bright White **Pastel:** Pastel Blue, Pastel Pink, Pastel Mint, Pastel Lavender, Pastel Coral, Pastel Yellow, Pastel Red, Pastel Green, Pastel Cyan, Pastel White **Background:** Back Pastel Blue, Back Pastel Pink, Back Pastel Red, Back Pastel Green, Back Pastel Yellow, Back Pastel Mint, Back Pastel Coral, Back Pastel Lavender --- ## Gradient Effects ```ts logGradient('Rainbow gradient text') logSuccess('Success gradient text') ``` --- ## Community Support For assistance or contributions, connect with the community: **Discord:** [https://discord.gg/vRXgWaar2G](https://discord.gg/vRXgWaar2G) --- ## Developer [![nsgpriyanshu](https://img.shields.io/badge/Developer-nsgpriyanshu-author.svg?color=f10a0a)](https://nsgpriyanshu.github.io)