https://github.com/marinerer/diy-log

🌈 Various console log level prefixes with support for color symbols and tags. 📟 自定义控制台各种级别日志输出的前缀，支持颜色符号，标签和时间。
https://github.com/marinerer/diy-log

console log log-symbols logger logging terminal

Last synced: 7 days ago
JSON representation

🌈 Various console log level prefixes with support for color symbols and tags. 📟 自定义控制台各种级别日志输出的前缀，支持颜色符号，标签和时间。

• Host: GitHub
• URL: https://github.com/marinerer/diy-log
• Owner: Marinerer
• Created: 2018-12-14T09:24:04.000Z (almost 6 years ago)
• Default Branch: main
• Last Pushed: 2023-12-21T11:35:12.000Z (11 months ago)
• Last Synced: 2024-10-29T23:56:24.361Z (8 days ago)
• Topics: console, log, log-symbols, logger, logging, terminal
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/diy-log
• Size: 155 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# diy-log 🌈

[![version](https://img.shields.io/npm/v/diy-log?style=flat-square)](https://www.npmjs.com/package/diy-log)

[![Codecov](https://img.shields.io/codecov/c/github/meqn/diy-log?token=HYQ5I268HN&style=flat-square&logo=codecov)](https://codecov.io/gh/Meqn/diy-log)

[![release](https://img.shields.io/github/actions/workflow/status/meqn/diy-log/release.yml?style=flat-square)](https://github.com/Meqn/pipflow/releases)

[![node.js](https://img.shields.io/node/v/diy-log?style=flat-square&logo=nodedotjs)](https://nodejs.org/en/about/releases/)

[![languages](https://img.shields.io/github/languages/top/meqn/diy-log?style=flat-square)](https://github.com/Meqn/diy-log)

[![downloads](https://img.shields.io/npm/dm/diy-log?style=flat-square)](https://www.npmjs.com/package/diy-log)

> Various console log level prefixes with support for color symbols and tags.

自定义控制台各种级别日志输出的前缀，支持颜色符号，标签和时间。

![img](./example/screenshot.png)

## Installation

```bash

npm install diy-log --save-dev

```

## Usage

```js

// for cjs

const logger = require('diy-log')

const { log, symbols, colors, tag } = logger

// for esm

import logger, {

  log,

  colors,

  symbols,

  tag

} from 'diy-log'

```

```js

time('time ...')

info('info ...')

done('done ...')

error('error ...')

warn('warn ...')

log(symbols.info, 'info ...')

log(symbols.done, 'done ...')

log(symbols.error, 'error ...')

log(symbols.warn, 'warn ...')

log(colors.dim('dim:text;'))

log(colors.blue('color: blue;'))

log(colors.bgGreen('bgcolor: green;'))

log(colors.bold('bold:text;'))

log(colors.italic('italic:text;'))

log(colors.underline('underline:text;'))

tag('info message')

tag('success message', 'done', 'success')

tag.warn('warning message')

tag.done('done message')

tag.info(colors.blue('info message'))

tag.error('error message')

```

## Methods

```ts

type Log = (...args: any[]) => void

type TagType = (message: string, label?: string) => void

interface Tag {

  (message: string, tag: 'info' | 'error' | 'done' | 'warn' = 'info', label?: string): void

  info: TagType

  error: TagType

  done: TagType

  warn: TagType

}

```

- `log`: Log;

- `time`: Log;

- `info`: Log;

- `error`: Log;

- `done`: Log;

- `warn`: Log;

- `tag`: Tag;

- `tag.info`: TagType;

- `tag.error`: TagType;

- `tag.done`: TagType;

- `tag.warn`: TagType;

## Thanks

[log-symbols](https://github.com/sindresorhus/log-symbols) , [picocolors](https://github.com/alexeyraspopov/picocolors) , [time-stamp](https://github.com/jonschlinkert/time-stamp)