# yyl-cmd-logger

> ## 安装

Latest version **0.2.1** (published 2021-05-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install yyl-cmd-logger
pnpm add yyl-cmd-logger
yarn add yyl-cmd-logger
bun add yyl-cmd-logger
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.1 |
| Published | 2021-05-22 |
| First published | 2021-03-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 73.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | jackness1208 |
| Maintainers | jackness |

## Links

- npm: https://www.npmjs.com/package/yyl-cmd-logger
- Repository: https://github.com/jackness1208/yyl-cmd-logger
- Homepage: https://github.com/jackness1208/yyl-cmd-logger#readme
- Issues: https://github.com/jackness1208/yyl-cmd-logger/issues
- npm.io page: https://npm.io/package/yyl-cmd-logger

## Dependencies (2)

- [chalk](https://npm.io/package/chalk.md) ^4.1.0
- [@types/node](https://npm.io/package/@types/node.md) ^15.3.0

## Recent versions

- 0.2.1 (latest) — 2021-05-22
- 0.2.0 — 2021-05-22
- 0.1.7 — 2021-05-16
- 0.1.6 — 2021-04-15
- 0.1.5 — 2021-03-08
- 0.1.3 — 2021-03-08
- 0.1.2 — 2021-03-08
- 0.1.1 — 2021-03-02
- 0.1.0 — 2021-03-02

## README

# yyl-cmd-logger

## 安装

```
yarn add yyl-cmd-logger
```

## 使用

### 一般使用

```typescript
import { YylCmdLogger } from 'yyl-cmd-logger'
const logger = new YylCmdLogger()
logger.log('info', ['hello world'])
logger.log('warn', ['hello world'])
logger.log('error', ['hello world'])
logger.log('success', ['hello world'])
logger.log('add', ['hello world'])
logger.log('del', ['hello world'])
logger.log('update', ['hello world'])
logger.log('cmd', ['hello world'])

logger.setProgress('start')
logger.log('info', ['hello world'])
logger.setProgress(0.1)
logger.log('info', ['hello world'])
logger.setProgress(1)
logger.setProgress('finished')
```

### 进度功能

```typescript
import { YylCmdLogger } from 'yyl-cmd-logger'
const logger = new YylCmdLogger()

logger.setProgress('start')
logger.log('info', ['hello world'])
logger.setProgress(0.1)
logger.log('info', ['hello world'])
logger.setProgress(1)
logger.setProgress('finished')
```

### 自定义 type

```typescript
import { YylCmdLogger } from 'yyl-cmd-logger'
import chalk from 'chalk'
const logger = new YylCmdLogger({
  type: {
    main: {
      name: 'YYL>',
      color: chalk.bgBlue.white,
      shortName: 'Y',
      shortColor: chalk.blue
    }
  }
})

logger.log('main', ['v1.0.0'])
```

### 其他函数

#### cleanScreen

屏幕 clear

```typescript
import { cleanScreen } from 'yyl-cmd-logger'
cleanScreen()
```

#### printHelp

打印 help

```typescript
import { printHelp } from 'yyl-cmd-logger'
printHelp({
  usage: 'yyl-print',
  desc: '打印命令',
  commands: {
    init: 'init files <Package>',
    default: 'default system'
  },
  options: {
    '-v, --version': 'show version',
    '-p, --path': 'path to plugin'
  },
  others: {
    Package: {
      packageA: '项目A',
      packageB: '项目B'
    }
  }
})
```

### 文档

[这里](./docs/modules.md)

---
_Source: https://npm.io/package/yyl-cmd-logger · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._