# console-color

**Repository Path**: michaelray/console-color

## Basic Information

- **Project Name**: console-color
- **Description**: this plugins is used for color of console message
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-03-25
- **Last Updated**: 2024-05-03

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Description
Node控制台文字变色的插件，主要方便输出带色彩的信息。

This plugins is used for color of node console message.
It is mainly convenient for debugging or other purposes.
# install
by npm
> npm install @michaelray/console-color -D

by yarn
> yarn add @michaelray/console-color -D

# use

### 引入
````javascript
const consoleColor = require('@michaelray/console-color');
````
````typescript
import consoleColor from "@michaelray/console-color";
````

### 使用
````javascript
//use system console function，The system console maybe no color
console.group('-----------demo1:use system console function-----------');
consoleColor.info('info');
consoleColor.debug('debug');
consoleColor.warn('warn');
consoleColor.error('error');
consoleColor.info('hello', 'michael', 'ray');
console.groupEnd();
````

# If you use default color, you can force change the color
动态修改颜色。

````javascript
//dynamic color modification
console.log('this is info','msg1'.red, 'msg2'.blue); //force change default color

````
# You can use color in variable or function

你可以在变量或者函数中使用变色

````javascript
console.group('---------variable use color------------');

let name = 'Michael Ray';
let age    = 1000;

let obj  = {
	name : 'Michael Jackson',
	age  : '100'
};

function hello(){
	return 'hello';
}

function isBoole(){
	return true;
}

console.log(name);
console.log('Hello,My name is ' + name.green +',I am a'+' man'.yellow+'.');
console.log(age.blue);
console.log(obj.name.blue);
console.log(hello().red);
//Boolean value must change to string.
console.log(isBoole().toString().red);

console.groupEnd();
````

## style 样式参考
- 'bold'          
- 'italic'        
- 'underline'     
- 'inverse'       
- 'strikethrough' 
- 'white'         
- 'grey'          
- 'black'         
- 'blue'          
- 'cyan'         
- 'green'        
- 'magenta'       
- 'red'           
- 'yellow'        
- 'whiteBG'       
- 'greyBG'
- 'blackBG'      
- 'blueBG'        
- 'cyanBG'        
- 'greenBG'       
- 'magentaBG'     
- 'redBG'        
- 'yellowBG'