Completed v0.3.0.

.gitignore

@@ -1,3 +1,4 @@
 /lib/
 /samples/
 /node_modules/
+*.log

.npmignore

@@ -7,3 +7,4 @@
 /tslint.json
 /tsconfig.json
 /samples/
+*.log

.vscode/launch.json

@@ -12,6 +12,7 @@
             "sourceMaps": true,
             "outFiles": [
                 "${workspaceFolder}/lib/*.js",
+                "${workspaceFolder}/lib/Drivers/*.js",
                 "${workspaceFolder}/samples/*.js"
             ]
         }

README.md

@@ -31,7 +31,7 @@ npm i @litert/logger@dev --save
 
 ### 简体中文版
 
-- [开发版本](./docs/zh-CN/index.md)
+- [开发版本](./docs/zh-CN/README.md)
 
 ## License
 

docs/zh-CN/README.md

@@ -0,0 +1,4 @@
+# LiteRT/Logger 文档
+
+- [快速入门](./tutorial/README.md)
+- [API 文档](./apis/README.md)

docs/zh-CN/apis/README.md

@@ -0,0 +1,15 @@
+# LiteRT/Logger API 文档
+
+## 目录
+
+- [`模块方法 createColorfulTTYDriver`](./functions/createColorfulTTYDriver.md)
+- [`模块方法 createConsoleDriver`](./functions/createConsoleDriver.md)
+- [`模块方法 createFactory`](./functions/createFactory.md)
+- [`模块方法 getDefaultFactory`](./functions/getDefaultFactory.md)
+- [`模块方法 DEFAULT_TEXT_FORMATTER`](./functions/DEFAULT_TEXT_FORMATTER.md)
+- [`模块方法 DEFAULT_JSON_FORMATTER`](./functions/DEFAULT_JSON_FORMATTER.md)
+- [`接口 IColorfulTTYDriver`](./interfaces/IColorfulTTYDriver.md)
+- [`接口 IDriver`](./interfaces/IDriver.md)
+- [`接口 IFactory`](./interfaces/IFactory.md)
+- [`接口 IFormatter`](./interfaces/IFormatter.md)
+- [`接口 ILogger`](./interfaces/ILogger.md)

docs/zh-CN/apis/functions/DEFAULT_JSON_FORMATTER.md

@@ -0,0 +1,9 @@
+# 模块方法 DEFAULT_JSON_FORMATTER
+
+该方法是默认的自定义输入类型日志格式化函数。
+
+## 声明
+
+```ts
+declare const DEFAULT_JSON_FORMATTER: IFormatter<any, string>;
+```

docs/zh-CN/apis/functions/DEFAULT_TEXT_FORMATTER.md

@@ -0,0 +1,9 @@
+# 模块方法 DEFAULT_TEXT_FORMATTER
+
+该方法是默认的文本日志格式化函数。
+
+## 声明
+
+```ts
+declare const DEFAULT_TEXT_FORMATTER: IFormatter<string, string>;
+```

docs/zh-CN/apis/functions/createColorfulTTYDriver.md

@@ -0,0 +1,13 @@
+# 模块方法 createColorfulTTYDriver
+
+该方法用于创建一个新的彩色命令行输出驱动对象。
+
+## 声明
+
+```ts
+function createColorfulTTYDriver(): IColorfulTTYDriver;
+```
+
+## 注意
+
+如果当前输出环境不支持彩色输出，则降级为控制台输出。

docs/zh-CN/apis/functions/createConsoleDriver.md

@@ -0,0 +1,9 @@
+# 模块方法 createConsoleDriver
+
+该方法用于创建一个新的控制台输出驱动对象。
+
+## 声明
+
+```ts
+function createConsoleDriver(): IDriver;
+```

docs/zh-CN/apis/functions/createFactory.md

@@ -0,0 +1,25 @@
+# 模块方法 createFactory
+
+该方法用于创建一个新的日志控制器工厂。
+
+## 声明
+
+```ts
+type DefaultLevels = "error" | "notice" | "warning" | "debug" | "info";
+
+function createFactory<
+    L extends string = DefaultLevels
+>(levels: L[]): IFactory<L>;
+```
+
+## 参数
+
+-   泛型参数 `L` 
+
+    指定可以使用的日志等级，用于静态类型检查和 IDE 自动完成。
+
+- 形参 `levels`
+
+    真正起定义日志等级的作用。
+
+

docs/zh-CN/apis/functions/getDefaultFactory.md

@@ -0,0 +1,11 @@
+# 模块方法 getDefaultFactory
+
+该方法用于获取默认的日志控制器工厂。
+
+## 声明
+
+```ts
+type DefaultLevels = "error" | "notice" | "warning" | "debug" | "info";
+
+function getDefaultFactory(): IFactory<DefaultLevels>;
+```

docs/zh-CN/apis/interfaces/IColorfulTTYDriver.md

@@ -0,0 +1,28 @@
+# 接口 IColorfulTTYDriver
+
+该接口定义彩色命令行输出驱动的方法列表。
+
+```ts
+type ColorSet = "blue" | "cyan" | "green" | "magenta" | "grey" |
+                "red" | "yellow" | "white" | "black" | "default";
+
+interface IColorfulTTYDriver
+extends IDriver {
+
+    /**
+     * 设置指定等级的日志的输出前景色。
+     *
+     * @param color 颜色名称
+     * @param level 指定要设置的日志等级。如果不指定，则修改默认的日志输出颜色。
+     */
+    foreColor(color: ColorSet, level?: string): this;
+
+    /**
+     * 设置指定等级的日志的输出背景色。
+     *
+     * @param color 颜色名称
+     * @param level 指定要设置的日志等级。如果不指定，则修改默认的日志输出颜色。
+     */
+    bgColor(color: ColorSet, level?: string): this;
+}
+```

docs/zh-CN/apis/interfaces/IDriver.md

@@ -0,0 +1,33 @@
+# 接口 IDriver
+
+该接口定义日志控制器输出驱动的方法列表。
+
+```ts
+interface IDriver {
+
+    /**
+     * 该方法提供给日志控制器调用，用于写日志到输出设备。
+     *
+     * @param text      已经格式化的日志文本
+     * @param subject   日志的主题
+     * @param level     日志的等级
+     * @param date      日志的时间
+     */
+    write(
+        text: string,
+        subject: string,
+        level: string,
+        date: Date
+    ): void;
+
+    /**
+     * 将输出缓存中的日志全部输出到输出设备。
+     */
+    flush(): void | Promise<void>;
+
+    /**
+     * 关闭驱动。
+     */
+    close(): void | Promise<void>;
+}
+```