minimal-npm-demo

一个最小可运行、且需要先构建再发布的 npm 包示例。

功能

• 源码使用 TypeScript，构建产物输出到 dist/
• 导出一个 createHelloMessage(name) 方法
• 自带测试
• 发布前会先执行构建

项目结构

src/        # TypeScript 源码
dist/       # build 后生成的发布产物
test/       # 测试

本地开发

先安装依赖：

npm install

构建：

npm run build

测试：

npm test

检查发布内容：

npm run pack:check

使用

const { createHelloMessage } = require("minimal-npm-demo");

console.log(createHelloMessage("Codex"));
// Hello, Codex!

这个包发布后，用户实际拿到的是 dist/index.js，不是 src/index.ts。

开发命令

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 已经具备“发布前必须先构建”的流程。