dsh-log-kit 0.0.0-stage → 1.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 dsh-log-kit contributors
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,3 +1,84 @@
1
- # Temporary Holding Version
1
+ # dsh-log-kit
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ 一个很小的 CommonJS npm 包,用两个模块演示“属性 + 只打印日志的方法”:
4
+
5
+ - `logger` 日志模块
6
+ - `greeter` 问候模块
7
+
8
+ 无运行时依赖。方法名保持英文,便于 `require()` 和 JavaScript 工具链兼容;日志内容为中文。
9
+
10
+ 公网 npm 页面:<https://www.npmjs.com/package/dsh-log-kit>
11
+
12
+ ## 安装
13
+
14
+ ```bash
15
+ npm install dsh-log-kit
16
+ ```
17
+
18
+ 也可以从本机 Verdaccio 仓库安装(用于离线演示):
19
+
20
+ ```bash
21
+ npm install dsh-log-kit --registry=http://127.0.0.1:4873/
22
+ ```
23
+
24
+ ## 使用
25
+
26
+ ```js
27
+ const kit = require("dsh-log-kit");
28
+
29
+ // 包级属性
30
+ console.log(kit.name); // "dsh-log-kit"
31
+ console.log(kit.version); // "1.0.4"
32
+
33
+ // logger 模块:属性 + 方法
34
+ console.log(kit.logger.prefix); // "[dsh-log-kit]"
35
+ console.log(kit.logger.levels); // { INFO: "信息", WARN: "警告", ERROR: "错误" }
36
+ kit.logger.info("你好");
37
+ kit.logger.warn("注意");
38
+ kit.logger.error("出错了");
39
+
40
+ // greeter 模块:属性 + 方法
41
+ console.log(kit.greeter.supportedLanguages);
42
+ kit.greeter.greet("林徽因");
43
+ kit.greeter.farewell("林徽因", "en");
44
+ kit.greeter.introduce({ name: "林徽因", role: "建筑师", city: "杭州" });
45
+
46
+ // 包级便捷方法
47
+ kit.greet("世界");
48
+ ```
49
+
50
+ ## API
51
+
52
+ ### 包级属性
53
+
54
+ | 属性 | 类型 | 说明 |
55
+ | --- | --- | --- |
56
+ | `name` | string | 包名 |
57
+ | `version` | string | 版本号 |
58
+ | `description` | string | 包描述 |
59
+ | `logger` | object | 日志模块 |
60
+ | `greeter` | object | 问候模块 |
61
+
62
+ ### `logger`
63
+
64
+ 属性:`prefix`、`levels`。
65
+
66
+ 方法:`info(message, meta?)`、`warn(message, meta?)`、`error(message, meta?)`。
67
+
68
+ 三个方法都只打印日志,返回 `undefined`。
69
+
70
+ ### `greeter`
71
+
72
+ 属性:`defaultLanguage`、`supportedLanguages`、`templates`。
73
+
74
+ 方法:`greet(name, language?)`、`farewell(name, language?)`、`introduce(profile?)`。
75
+
76
+ 三个方法都只打印日志,返回 `undefined`。支持语言:`zh-CN`(默认)、`en`、`ja`。
77
+
78
+ ## 测试
79
+
80
+ ```bash
81
+ npm test
82
+ ```
83
+
84
+ MIT 许可证。
package/index.js ADDED
@@ -0,0 +1,25 @@
1
+ "use strict";
2
+
3
+ const logger = require("./lib/logger");
4
+ const greeter = require("./lib/greeter");
5
+ const pkg = require("./package.json");
6
+
7
+ /**
8
+ * 包入口:汇总两个模块,并额外提供包级属性和快捷方法。
9
+ * 使用 Object.freeze 冻结导出对象,避免使用方误改公共接口。
10
+ */
11
+ module.exports = Object.freeze({
12
+ name: pkg.name,
13
+ version: pkg.version,
14
+ description: pkg.description,
15
+
16
+ logger,
17
+ greeter,
18
+
19
+ info: logger.info,
20
+ warn: logger.warn,
21
+ error: logger.error,
22
+ greet: greeter.greet,
23
+ farewell: greeter.farewell,
24
+ introduce: greeter.introduce,
25
+ });
package/lib/greeter.js ADDED
@@ -0,0 +1,68 @@
1
+ "use strict";
2
+
3
+ /**
4
+ * 问候模块(CommonJS)。
5
+ *
6
+ * 暴露属性:
7
+ * - defaultLanguage:默认语言
8
+ * - supportedLanguages:支持的语言列表
9
+ *
10
+ * 暴露方法(只打印日志,不返回业务数据):
11
+ * - greet(name, language?)
12
+ * - farewell(name, language?)
13
+ * - introduce(profile?)
14
+ */
15
+
16
+ const defaultLanguage = "zh-CN";
17
+
18
+ const templates = Object.freeze({
19
+ "zh-CN": Object.freeze({
20
+ greet: (name) => `你好,${name}!`,
21
+ farewell: (name) => `再见,${name}。`,
22
+ }),
23
+ en: Object.freeze({
24
+ greet: (name) => `Hello, ${name}!`,
25
+ farewell: (name) => `Goodbye, ${name}.`,
26
+ }),
27
+ ja: Object.freeze({
28
+ greet: (name) => `こんにちは、${name}!`,
29
+ farewell: (name) => `さようなら、${name}。`,
30
+ }),
31
+ });
32
+
33
+ const supportedLanguages = Object.freeze(Object.keys(templates));
34
+
35
+ function pickLanguage(language) {
36
+ return supportedLanguages.includes(language) ? language : defaultLanguage;
37
+ }
38
+
39
+ function pickName(name) {
40
+ if (typeof name !== "string" || name.trim() === "") return "朋友";
41
+ return name.trim();
42
+ }
43
+
44
+ function greet(name, language = defaultLanguage) {
45
+ const lang = pickLanguage(language);
46
+ console.log(`[dsh-log-kit] [问候] ${templates[lang].greet(pickName(name))}`);
47
+ }
48
+
49
+ function farewell(name, language = defaultLanguage) {
50
+ const lang = pickLanguage(language);
51
+ console.log(`[dsh-log-kit] [告别] ${templates[lang].farewell(pickName(name))}`);
52
+ }
53
+
54
+ function introduce(profile = {}) {
55
+ const name = pickName(profile.name);
56
+ const role = typeof profile.role === "string" && profile.role.trim() ? profile.role.trim() : "新朋友";
57
+ const city = typeof profile.city === "string" && profile.city.trim() ? profile.city.trim() : "未知城市";
58
+ console.log(`[dsh-log-kit] [介绍] 我是 ${name},来自 ${city},身份是 ${role}。`);
59
+ }
60
+
61
+ module.exports = {
62
+ defaultLanguage,
63
+ supportedLanguages,
64
+ templates,
65
+ greet,
66
+ farewell,
67
+ introduce,
68
+ };
package/lib/logger.js ADDED
@@ -0,0 +1,65 @@
1
+ "use strict";
2
+
3
+ /**
4
+ * 日志模块(CommonJS)。
5
+ *
6
+ * 暴露属性:
7
+ * - prefix:日志统一前缀
8
+ * - levels:日志级别常量
9
+ *
10
+ * 暴露方法(只打印日志,不返回业务数据):
11
+ * - info(message, meta?)
12
+ * - warn(message, meta?)
13
+ * - error(message, meta?)
14
+ */
15
+
16
+ const prefix = "[dsh-log-kit]";
17
+
18
+ const levels = Object.freeze({
19
+ INFO: "信息",
20
+ WARN: "警告",
21
+ ERROR: "错误",
22
+ });
23
+
24
+ /** 把任意入参转成适合打印的文本。 */
25
+ function formatMessage(message) {
26
+ if (typeof message === "string") return message;
27
+ if (message instanceof Error) return `${message.name}: ${message.message}`;
28
+ try {
29
+ return JSON.stringify(message);
30
+ } catch {
31
+ return String(message);
32
+ }
33
+ }
34
+
35
+ /** 统一的日志输出实现。 */
36
+ function writeLog(level, consoleMethod, message, meta) {
37
+ const time = new Date().toISOString();
38
+ const line = `${time} ${prefix} [${level}] ${formatMessage(message)}`;
39
+
40
+ if (meta === undefined) {
41
+ console[consoleMethod](line);
42
+ } else {
43
+ console[consoleMethod](line, meta);
44
+ }
45
+ }
46
+
47
+ function info(message, meta) {
48
+ writeLog(levels.INFO, "log", message, meta);
49
+ }
50
+
51
+ function warn(message, meta) {
52
+ writeLog(levels.WARN, "warn", message, meta);
53
+ }
54
+
55
+ function error(message, meta) {
56
+ writeLog(levels.ERROR, "error", message, meta);
57
+ }
58
+
59
+ module.exports = {
60
+ prefix,
61
+ levels,
62
+ info,
63
+ warn,
64
+ error,
65
+ };
package/package.json CHANGED
@@ -1,6 +1,41 @@
1
1
  {
2
2
  "name": "dsh-log-kit",
3
- "version": "0.0.0-stage",
4
- "stub": true,
5
- "description": "Temporary package placeholder for staged publishing"
6
- }
3
+ "version": "1.0.4",
4
+ "description": "一个包含日志与问候两个 CommonJS 模块的示例 npm 包,暴露属性与只打印日志的方法。",
5
+ "main": "index.js",
6
+ "exports": {
7
+ ".": {
8
+ "require": "./index.js",
9
+ "default": "./index.js"
10
+ },
11
+ "./logger": "./lib/logger.js",
12
+ "./greeter": "./lib/greeter.js",
13
+ "./package.json": "./package.json"
14
+ },
15
+ "files": [
16
+ "index.js",
17
+ "lib/",
18
+ "README.md",
19
+ "LICENSE"
20
+ ],
21
+ "scripts": {
22
+ "test": "node test/basic.test.js"
23
+ },
24
+ "keywords": [
25
+ "demo",
26
+ "logger",
27
+ "greeter",
28
+ "commonjs",
29
+ "npm-package",
30
+ "日志",
31
+ "示例"
32
+ ],
33
+ "author": "dsh-log-kit 贡献者",
34
+ "license": "MIT",
35
+ "engines": {
36
+ "node": ">=16"
37
+ },
38
+ "publishConfig": {
39
+ "access": "public"
40
+ }
41
+ }