ptkdev-logger 项目使用教程

1. 项目的目录结构及介绍

ptkdev-logger 项目是一个为 Node.js 提供的日志记录库，其目录结构如下：

ptkdev-logger/
├── .github/              # GitHub 相关配置文件
├── examples/             # 示例代码目录
├── modules/              # 模块目录
├── translations/         # 多语言翻译文件
├── .all-contributorsrc   # 贡献者名单文件
├── .editorconfig          # 编辑器配置文件
├── .eslintrc.json        # ESLint 配置文件
├── .gitattributes         # Git 属性配置文件
├── .gitignore            # Git 忽略文件
├── .gitmodules           # Git 子模块配置文件
├── .npmignore            # npm 忽略文件
├── CHANGELOG.md          # 更改日志文件
├── LICENSE.md            # 许可证文件
├── README.md             # 项目说明文件
├── jsconfig.json         # JavaScript 配置文件
├── package-lock.json     # npm 锁定文件
├── package.json          # npm 包配置文件
└── tsconfig.json         # TypeScript 配置文件

• .github/：包含 GitHub 工作流等配置。
• examples/：包含使用 ptkdev-logger 的示例代码。
• modules/：项目的核心模块。
• translations/：包含项目的多语言翻译文件。
• .all-contributorsrc：记录项目的所有贡献者。
• .editorconfig：定义项目的编辑器配置，以确保一致的代码风格。
• .eslintrc.json：ESLint 配置文件，用于代码质量检查。
• .gitattributes：Git 属性配置，用于设置特定文件的属性。
• .gitignore：定义哪些文件和目录应该被 Git 忽略。
• .gitmodules：如果项目包含子模块，则在此文件中配置。
• .npmignore：定义哪些文件和目录在打包 npm 包时应该被忽略。
• CHANGELOG.md：记录项目的更新和修改历史。
• LICENSE.md：项目的许可证信息。
• README.md：项目的介绍和说明。
• jsconfig.json：JavaScript 配置文件，用于 Visual Studio Code 等编辑器。
• package-lock.json：记录项目的依赖和版本信息。
• package.json：项目的 npm 配置文件。
• tsconfig.json：TypeScript 配置文件。

2. 项目的启动文件介绍

项目的启动文件通常是 examples/ 目录下的 example.js。这个文件演示了如何使用 ptkdev-logger 库。以下是一个简单的启动示例：

const Logger = require('@ptkdev/logger');
const logger = new Logger();

logger.info('这是一个信息日志');
logger.warning('这是一个警告日志');
logger.error('这是一个错误日志');

在命令行中运行 node example.js，就可以看到日志输出。

3. 项目的配置文件介绍

ptkdev-logger 的配置文件主要是通过实例化 Logger 类时传递的 options 对象来设置的。以下是一个配置文件的示例：

const Logger = require('@ptkdev/logger');

const options = {
  language: 'zh',
  colors: true,
  debug: true,
  info: true,
  warning: true,
  error: true,
  sponsor: true,
  write: true,
  type: 'log',
  rotate: {
    size: '10M',
    encoding: 'utf8'
  },
  path: {
    debug_log: './debug.log',
    error_log: './errors.log'
  }
};

const logger = new Logger(options);

在这个配置中，可以设置日志的语言、是否启用颜色、各种日志级别、是否写入文件、文件格式、日志文件的大小限制以及日志文件的路径等。