# @epegzz/winston-dev-console 中文文档

规范地址：https://npmcn.com/package/%40epegzz/winston-dev-console/

版本：1\.3\.4
npm 元数据更新时间：2022-04-05T07:58:41.642Z
中文译文更新时间：2026-11-13T19:25:43.540Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40epegzz/winston-dev-console
原文对照：https://npmcn.com/package/%40epegzz/winston-dev-console/?lang=original

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：1.4 MB，37 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：3 个
- peer 依赖：winston ^3\.x
- 首次发布：2021-04-04T17:25:33.075Z
- 最新版本发布：2022-03-23T22:13:42.693Z
- 近 30 天下载量：68017（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：9（近 12 个月 0 个）

## 中文简介

Winston@3控制台格式,旨在改善开发 UX

## 安装

```sh
npm install @epegzz/winston-dev-console
```

也可以使用：`pnpm add @epegzz/winston-dev-console`、`yarn add @epegzz/winston-dev-console`、`bun add @epegzz/winston-dev-console`

## README

# 温顿- 德克多

温斯顿@3 发展控制台格式(基于 [圆锥格式](https://github.com/duccio/winston-console-format)目的是通过改进节点JS发展UX

-   在日志输出中添加日志语句的来源
-   通过日志语句分离,输出色彩化和arg pretty打印,优化每个日志语句的可读性

## 演示

![](https://npmcn.com/package/%40epegzz/winston-dev-console/demo.png)

### 真实世界截图 :

![](https://npmcn.com/package/%40epegzz/winston-dev-console/demo2.png)

## 安装

```bash
npm install winston @epegzz/winston-dev-console
```

或者说

```bash
yarn add winston @epegzz/winston-dev-console
```

  

## 用法类型脚本

```typescript
import { createLogger, format, transports } from "winston";
import winstonDevConsole from "@epegzz/winston-dev-console";
import util from "util";

let log = createLogger({
  level: "silly", // or use process.env.LOG_LEVEL
});

// Note: You probably only want to use winstonDevConsole during development
log = winstonDevConsole.init(log);
log.add(
  winstonDevConsole.transport({
    showTimestamps: false,
    addLineSeparation: true,
  })
);

log.silly("Logging initialized");
log.debug("Debug an object", { make: "Ford", model: "Mustang", year: 1969 });
log.verbose("Returned value", { value: util.format });
log.info("Information", {
  options: ["Lorem ipsum", "dolor sit amet"],
  values: ["Donec augue eros, ultrices."],
});
log.warn("Warning");
log.error(new Error("Unexpected error"));
```

## 用法 Java 脚本

```js
const { createLogger, format, transports } = require("winston");
const winstonDevConsole = require("@epegzz/winston-dev-console").default;
const util = require("util");

let log = createLogger({
  level: "silly", // or use process.env.LOG_LEVEL
});

// Note: You probably only want to use winstonDevConsole during development
log = winstonDevConsole.init(log);
log.add(
  winstonDevConsole.transport({
    showTimestamps: false,
    addLineSeparation: true,
  })
);

log.silly("Logging initialized");
log.debug("Debug an object", { make: "Ford", model: "Mustang", year: 1969 });
log.verbose("Returned value", { value: util.format });
log.info("Information", {
  options: ["Lorem ipsum", "dolor sit amet"],
  values: ["Donec augue eros, ultrices."],
});
log.warn("Warning");
log.error(new Error("Unexpected error"));
```

## API 密码

## wintonDev Console.format(选项)

### 选项

配置对象 .  
  
类型 : `DevConsoleFormatOptions`

### 选项。检查选项

`util.inspect()` [配置对象](https://nodejs.org/api/util.html#util_util_inspect_object_options)。 。 。 .  
  
类型 : `Object`  

### 选项。 basePath

用于在显示日志语句的文件路径时去除工程的基础路径. 默认情况下, 路径中的任何事项( 包括) `src` 文件夹将被删除.  
  
类型 : `String`  

### 选项

Wheather或不将每个日志语句用一行空白分隔.  
  
类型 : `Boolean`  
默认 : `true`  

### 选项。显示时间戳

无论小麦是否显示时间戳  
在开发期间,时间戳通常发出更多的噪音,然后是有用的,因此默认是被禁用.  
  
类型 : `Boolean`  
默认 : `false`  

## 鸣谢

这个项目的灵感来自并部分无耻地从 [圆锥格式](https://github.com/duccio/winston-console-format)

## 常见问题

### @epegzz/winston-dev-console 是什么？

Winston@3控制台格式,旨在改善开发 UX

### 如何安装 @epegzz/winston-dev-console？

在项目目录运行 npm install @epegzz/winston-dev-console，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：winston（^3\.x）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @epegzz/winston-dev-console 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @epegzz/winston-dev-console 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @epegzz/winston-dev-console 可以商用吗？

@epegzz/winston-dev-console 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @epegzz/winston-dev-console 的下载量有多少？

根据 npm 官方下载统计，@epegzz/winston-dev-console 在 2026/10/14 – 2026/11/12 这 30 天内被下载 68,017 次，日均约 2,267 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @epegzz/winston-dev-console 还在维护吗？

最新版本 1\.3\.4 发布于 2022/03/24（4 年前）；至今共发布 9 个版本，其中过去 12 个月发布了 0 个；首次发布于 2021/04/05。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

