@way17/minimal-npm-demo 0.1.0

package/README.md

@@ -0,0 +1,74 @@
+# minimal-npm-demo
+
+一个最小可运行、且需要先构建再发布的 npm 包示例。
+
+## 功能
+
+- 源码使用 TypeScript，构建产物输出到 `dist/`
+- 导出一个 `createHelloMessage(name)` 方法
+- 自带测试
+- 发布前会先执行构建
+
+## 项目结构
+
+```text
+src/        # TypeScript 源码
+dist/       # build 后生成的发布产物
+test/       # 测试
+```
+
+## 本地开发
+
+先安装依赖：
+
+```bash
+npm install
+```
+
+构建：
+
+```bash
+npm run build
+```
+
+测试：
+
+```bash
+npm test
+```
+
+检查发布内容：
+
+```bash
+npm run pack:check
+```
+
+## 使用
+
+```js
+const { createHelloMessage } = require("minimal-npm-demo");
+
+console.log(createHelloMessage("Codex"));
+// Hello, Codex!
+```
+
+这个包发布后，用户实际拿到的是 `dist/index.js`，不是 `src/index.ts`。
+
+## 开发命令
+
+```bash
+npm install
+npm run build
+npm test
+npm run pack:check
+```
+
+## 发布流程
+
+1. 修改 `package.json` 中的 `name` 为你自己的包名
+2. 更新 `version`
+3. 执行 `npm test`
+4. 登录 npm：`npm login`
+5. 发布：`npm publish`
+
+其中 `npm publish` 前会自动执行 `prepublishOnly`，`npm pack` / `npm publish` 前会自动执行 `prepack`，所以这个 demo 已经具备“发布前必须先构建”的流程。

package/dist/index.d.ts

@@ -0,0 +1 @@
+export declare function createHelloMessage(name?: string): string;

package/dist/index.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createHelloMessage = createHelloMessage;
+function createHelloMessage(name = "world") {
+    if (typeof name !== "string") {
+        throw new TypeError("name must be a string");
+    }
+    const normalizedName = name.trim();
+    return `Hello, ${normalizedName || "world"}!`;
+}

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@way17/minimal-npm-demo",
+  "version": "0.1.0",
+  "description": "A minimal npm package demo that requires a build step before publish.",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "test": "npm run build && node --test",
+    "check": "npm run build && npm test",
+    "prepack": "npm run build",
+    "prepublishOnly": "npm test",
+    "pack:check": "npm pack --dry-run"
+  },
+  "keywords": [
+    "npm",
+    "demo",
+    "package"
+  ],
+  "author": "",
+  "license": "MIT",
+  "engines": {
+    "node": ">=18"
+  },
+  "devDependencies": {
+    "typescript": "^5.8.3"
+  }
+}