Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/oawu/npm-cli-progress
終端機上使用 Node.js「進度工具」
https://github.com/oawu/npm-cli-progress
cli-progress command-line nodejs npm progress progress-bar terminal
Last synced: about 1 month ago
JSON representation
終端機上使用 Node.js「進度工具」
- Host: GitHub
- URL: https://github.com/oawu/npm-cli-progress
- Owner: oawu
- Created: 2021-01-15T09:07:08.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2024-01-02T10:22:08.000Z (12 months ago)
- Last Synced: 2024-08-10T06:10:34.235Z (4 months ago)
- Topics: cli-progress, command-line, nodejs, npm, progress, progress-bar, terminal
- Language: JavaScript
- Homepage:
- Size: 150 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# OA's Node.js Cli Progress
OA 的終端機進度工具 🚀
## 說明
終端機上使用 Node.js「進度工具」
## 安裝
```shell
npm install @oawu/cli-progress
```
## 使用
引入 `require('@oawu/cli-progress')` 即可使用，如下範例：
```javascript
const Progress = require('@oawu/cli-progress')
Progress.title('標題', '副標題')
Progress.total(3)
setTimeout(_ => {
Progress.advance
setTimeout(_ => {
Progress.advance
setTimeout(_ => {
Progress.done()
}, 1000)
}, 1000)
}, 1000)
```
## 設定
* 使用色彩器(@oawu/xterm)，於一開始使用 `Progress.option.color = true` 即可，預設為 `false`
* 設定左邊空格基礎 `Progress.option.space = 2`，預設為 `3`
* 設定讀取中
* 顯示：於一開始使用 `Progress.option.loading = "⠦⠧⠇⠏⠉⠙⠹⠸⠼⠴⠤⠦"`，預設為 `⠦⠧⠇⠏⠉⠙⠹⠸⠼⠴⠤⠦`
* 顏色：於一開始使用 `Progress.option.loading.color = Xterm.red`，預設為 `Xterm.yellow`
* 設定主標題顏色，於一開始使用 `Progress.option.title.color = Xterm.red`，預設為 `Xterm.gray`
* 設定小標題顏色，於一開始使用 `Progress.option.subtitle.color = Xterm.red`，預設為 `Xterm.gray`
* 設定百分比顏色，於一開始使用 `Progress.option.percent.color = Xterm.red`，預設為 `Xterm.gray`
* 設定數值顏色，於一開始使用 `Progress.option.index.color = Xterm.red`，預設為 `Xterm.dim`
* 設定 done 顏色，於一開始使用 `Progress.option.done.color = Xterm.red`，預設為 `Xterm.green`
* 設定 fail 顏色，於一開始使用 `Progress.option.fail.color = Xterm.red`，預設為 `Xterm.red`
* 設定主標題符號
* 顯示：於一開始使用 `Progress.option.header = "！"`，預設為 `◉`
* 顏色：於一開始使用 `Progress.option.header.color = Xterm.red`，預設為 `Xterm.purple`
* 設定小標題符號
* 顯示：於一開始使用 `Progress.option.newline = "！"`，預設為 `↳`
* 顏色：於一開始使用 `Progress.option.newline.color = Xterm.red`，預設為 `Xterm.dim.purple`
* 設定分隔符號
* 顯示：於一開始使用 `Progress.option.dash = "！"`，預設為 `─`
* 顏色：於一開始使用 `Progress.option.dash.color = Xterm.red`，預設為 `Xterm.dim`
* 設定點點點符號
* 顯示：於一開始使用 `Progress.option.dot = "！"`，預設為 `…`
* 顏色：於一開始使用 `Progress.option.dot.color = Xterm.red`，預設為 `Xterm.dim.lightBlack`
以下為基本設定範例與執行結果：
```javascript
const Progress = require('@oawu/cli-progress')
Progress.option.color = true // 使用顏色
Progress.option.done.color = text => Xterm.lightBlue(text).dim() // done 時顯示為細體藍色
Progress.option.fail.color = Xterm.red // fail 時為紅色
Progress.option.header = '➜' // 主標題符號改為 `➜`
Progress.option.header.color = Xterm.lightGray // 主標題符號顏色改為亮灰色
// 開始執行
Progress.title('標題', '副標題')
Progress.total(3)
setTimeout(_ => {
Progress.advance
setTimeout(_ => {
Progress.advance
setTimeout(_ => {
Progress.done()
}, 1000)
}, 1000)
}, 1000)
```
執行中：
完成：
