当前位置：首页 > news >正文

使用 TypeScript 开发并发布一个 npm 包（完整指南）

news 来源：原创 2025/5/19 3:46:04

本教程将一步步教你从零开发、打包并发布一个 TypeScript 工具库到 npm。以日期时间格式化工具为例，涵盖项目初始化、Vite 打包、类型声明输出、npm 配置、实际发布等完整流程，适合开发者直接套用。

文章目录

- 📁 项目结构预览
- 🧱 初始化项目
- ✍️ 编写功能模块
- ⚙️ 配置 TypeScript
- 🔧 配置 Vite 打包
- 📦 配置 package.json
- 📖 添加 README.md（简略）
- 使用示例
- 🧠 发布后的版本管理建议

📁 项目结构预览

ts-date-utils/
├── dist/                     # 构建产物输出目录
│   ├── types/                # 类型声明文件输出目录
│   ├── ts-date-utils.es.js  # ES 模块
│   └── ts-date-utils.umd.js # UMD 模块
├── src/
│   └── index.ts              # 工具函数主入口
├── package.json              # 项目和发布配置
├── tsconfig.json             # TypeScript 配置
├── vite.config.ts            # Vite 打包配置
├── README.md                 # 包文档说明
└── .gitignore

🧱 初始化项目

mkdir ts-date-utils && cd ts-date-utils
npm init -y
npm install typescript vite -D
npx tsc --init
npm install @types/node -D

✍️ 编写功能模块

src/index.ts

export function formatDate(date: Date, format: string = 'YYYY-MM-DD HH:mm:ss'): string {const map: Record<string, string> = {'YYYY': date.getFullYear().toString(),'MM': (date.getMonth() + 1).toString().padStart(2, '0'),'DD': date.getDate().toString().padStart(2, '0'),'HH': date.getHours().toString().padStart(2, '0'),'mm': date.getMinutes().toString().padStart(2, '0'),'ss': date.getSeconds().toString().padStart(2, '0')};return format.replace(/YYYY|MM|DD|HH|mm|ss/g, m => map[m]);
}export function formatTimestamp(timestamp: number, format: string = 'YYYY-MM-DD HH:mm:ss'): string {return formatDate(new Date(timestamp), format);
}export function now(format: string = 'YYYY-MM-DD HH:mm:ss'): string {return formatDate(new Date(), format);
}export function parseDateString(str: string): Date {return new Date(str.replace(/-/g, '/'));
}export function isValidDate(val: unknown): val is Date {return val instanceof Date && !isNaN(val.getTime());
}

⚙️ 配置 TypeScript

tsconfig.json

{"compilerOptions": {"target": "ES2020","module": "ESNext","lib": ["ES2020", "DOM", "DOM.Iterable"],"moduleResolution": "node","esModuleInterop": true,"declaration": true,"declarationDir": "dist/types","emitDeclarationOnly": true,"outDir": "dist","skipLibCheck": true,"isolatedModules": true,"moduleDetection": "force","strict": true,"noUnusedLocals": true,"noUnusedParameters": true,"noFallthroughCasesInSwitch": true,"noUncheckedSideEffectImports": true,"types": ["node"]},"include": ["src"]
}

🔧 配置 Vite 打包

vite.config.ts

import { defineConfig } from 'vite';
import { resolve } from 'path';export default defineConfig({build: {lib: {entry: resolve(__dirname, 'src/index.ts'),name: 'TsDateUtils',fileName: (format) => `ts-date-utils.${format}.js`,formats: ['es', 'umd']},rollupOptions: {external: [],output: {globals: {}}}}
});

📦 配置 package.json

{"name": "kaze-ts-date-utils","version": "1.0.0","description": "A simple and flexible TypeScript date formatting library","main": "dist/ts-date-utils.umd.js","module": "dist/ts-date-utils.es.js","types": "dist/types/index.d.ts","files": ["dist","README.md"],"scripts": {"build": "vite build && tsc --emitDeclarationOnly","prepublishOnly": "npm run build"},"keywords": ["date","format","typescript","utils","time"],"author": "kaze","license": "MIT","devDependencies": {"@types/node": "^20.0.0","typescript": "^5.0.0","vite": "^5.0.0"}
}

📖 添加 README.md（简略）

# ts-date-utils> A simple and flexible TypeScript date formatting utility.## 安装
```bash
npm install kaze-ts-date-utils

使用示例

import { formatDate, now } from 'kaze-ts-date-utils';
console.log(now());
console.log(formatDate(new Date(), 'YYYY/MM/DD HH:mm'));


---## 🚀 发布到 npm1. 登录 npm（只需一次）
```bash
npm login

打包构建

npm run build

发布

npm publish

注意：版本号每次发布必须递增。

🧠 发布后的版本管理建议

bugfix / 小改动 → npm version patch
新功能 → npm version minor
有破坏性改动 → npm version major

发布更新：

npm version patch && npm publish

✅ 恭喜你，现在你已经掌握了完整的 TypeScript npm 包开发与发布流程！

使用 TypeScript 开发并发布一个 npm 包（完整指南）

本教程将一步步教你从零开发、打包并发布一个 TypeScript 工具库到 npm。以日期时间格式化工具为例，涵盖项目初始化、Vite 打包、类型声明输出、npm 配置、实际发布等完整流程，适合开发者直接套用。文章目录 📁 项目结构预览🧱 初…...

编程日记 2025/5/19 3:46:04

在Anolis OS 8上部署Elasticsearch 7.16.1与JDK 11的完整指南

目录 1. 环境与版本选择 1.1 操作系统选择：Anolis OS 8 1.2 版本匹配说明 1.3 前置条件检查 2. JDK 11安装与配置 2.1 安装流程 2.2 配置详解 3. Elasticsearch 7.16.1安装与优化 3.1 基础安装 3.2 目录规划与权限 3.3 核心配置文件详解 3.4 JVM调优 4. 用户权限管…...

编程日记 2025/4/30 11:06:47

SELinux 从理论到实践：深入解析与实战指南

文章目录引言：为什么需要 SELinux？第一部分：SELinux 核心理论1.1 SELinux 的三大核心模型1.2 安全上下文（Security Context）1.3 策略语言与模块化第二部分：实战操作指南2.1 SELinux 状态管理2.2 文件上下…...

编程日记 2025/4/30 11:05:43

巧用 `unittest.mock` 模块实现依赖服务隔离测试

巧用 unittest.mock 模块实现依赖服务隔离测试引言在软件开发过程中，单元测试是保障代码质量的核心手段。然而，许多代码依赖于外部服务，如数据库、API 或文件系统，直接进行测试可能会导致：环境不可控：测试数据可能变化，影响测试结果的稳定性。执行时间长：依赖外部…...

编程日记 2025/5/4 3:12:19

水利三维可视化平台怎么做？快速上手的3步指南

分享大纲： 1、了解水利三维可视化平台 2、选择合适的开发平台 3、快速搭建水利三维可视化平台第一步：了解水利三维可视化平台水利三维可视化平台是利用大数据、物联网、数字孪生等技术，将物理实体数字化建模，并通过三维可视化技…...

编程日记 2025/4/30 11:05:40

【DB2】逻辑导出导入注意事项

DB2异构操作系统之间迁移需选择逻辑备份恢复导出环节 1、设置字符集，源端创建导出目录，并导出数据库DDL db2set db2codepage1208 db2stop force db2start db2look -d YS-e -l -o -createdb db2look_YS.sql导出文件:db2look_YS.sql –详细参数请参考…...

编程日记 2025/4/30 11:04:37

Fiddler抓取APP端，HTTPS报错全解析及解决方案（一篇解决常见问题）

环境：雷电模拟器Android9系统你所遇到的fiddler中抓取HTTPS的问题可以分为三类：一类是你自己证书安装上逻辑错误，另一种是APP中使用了“证书固定”的手段。三类fiddler中生成证书时的参数过程。 1.Fiddler证书安装上的逻辑错误更新Opt…...

编程日记 2025/5/16 8:06:18

C语言教程（二十三）：C 语言强制类型转换详解

一、强制类型转换的概念强制类型转换是指在程序中手动将一个数据类型的值转换为另一种数据类型。在某些情况下，编译器可能不会自动进行类型转换，或者自动转换的结果不符合我们的预期，这时就需要使用强制类型转换来明确指定要进行的类型转换。…...

编程日记 2025/5/7 15:01:30

阿里云服务器篇十二：加入 Project Honey Pot 和使用 http:BL

文章目录系列文章背景前提条件注册和准备注册安装蜜罐捐赠MX记录（可选）添加 QuickLinks（快速链接）使用 http:BL（HTTP黑名单）获取Access Key（访问秘钥）Apache自动拦截黑名单IP模块Http:BL API文档更多实现案例监控IP空间系列文章阿里云服务器篇一：申请和初始化阿里…...

编程日记 2025/5/18 10:18:28

Duplicate class com.xxxa.naviauto.sdk.listener.OnChangeListener found in modules jetified-xxxa-sdk-v1.1.2-release-runtime (:xxx-sdk-v1.1.2-release:) and jetified-xxxb-sdk-1.1.3-runtime (:xxxb-sdk-1.1.3:) A.aar B.aar 有类冲突；使用 exclude 排除本地aar无效…...

编程日记 2025/5/13 21:35:35

Tomcat 部署配置指南

## 1. 环境要求 - JDK 8 或更高版本 - Tomcat 8.5/9.x/10.x - Windows 操作系统 ## 2. 安装步骤 ### 2.1 安装JDK 1. 下载并安装JDK 2. 配置环境变量： - JAVA_HOME: JDK安装目录 - Path: 添加 %JAVA_HOME%\bin 3. 验证安装：打开命令提示符&#…...

编程日记 2025/4/30 11:02:26

阿里千问Qwen3技术解析与部署指南：混合推理架构突破性优势与对DeepSeek R1的全面超越

阿里千问Qwen3技术解析：突破性优势与对DeepSeek R1的全面超越在2025年4月29日，阿里巴巴发布了新一代开源大模型Qwen3（通义千问3），凭借其创新架构与显著性能提升，迅速成为全球开源AI领域的焦点。本文将从技…...

编程日记 2025/5/14 12:03:38

宾馆一次性拖鞋很重要，扬州卓韵酒店用品详细介绍其材质与卫生标准

宾馆一次性拖鞋在旅途中很重要。它的卫生情况受大家关注。它的舒适度也受大家关注。扬州卓韵酒店用品在这方面经验丰富。其产品质量优良。下面为你详细介绍宾馆一次性拖鞋。材质选择目前宾馆一次性拖鞋材质多样。常见的有布质、纸质和塑料的。布质拖鞋相对环保舒适。能给脚部…...

编程日记 2025/5/6 15:22:25

DevExpressWinForms-XtraMessageBox-使用教程

XtraMessageBox-使用教程一、基础使用：快速弹出标准消息框 XtraMessageBox 的基础使用非常简单，只需调用XtraMessageBox.Show方法即可弹出一个标准的消息框。根据不同的使用需求，Show方法有多种重载形式。 1.1 仅显示提示信息当我们仅仅…...

编程日记 2025/5/16 14:01:22

ETL数据集成与数据资产的紧密关联，解锁数据价值新密码

数据已然成为企业最为珍贵的资产之一。无论是传统行业巨头，还是新兴的互联网企业，都在积极挖掘数据背后所蕴含的巨大商业价值。而在这个过程中，ETL（Extract，Transform，Load）作为数据处理的关键环…...

编程日记 2025/5/19 3:44:23

【无报错，亲测有效】如何在Windows和Linux系统中查看MySQL版本

如何在Windows和Linux系统中查看MySQL版本 MySQL作为最流行的开源关系型数据库管理系统之一，了解如何查看其版本信息对于开发者和数据库管理员来说是常用的一个基本操作。本文将详细介绍在Windows和Linux系统中查看MySQL版本的方法。文章目录如何在Windows和Linu…...

编程日记 2025/5/2 7:10:14

【Leetcode 每日一题】2962. 统计最大元素出现至少 K 次的子数组

问题背景给你一个整数数组 n u m s nums nums 和一个正整数 k k k。请你统计有多少满足「 n u m s nums nums 中的最大元素」至少出现 k k k 次的子数组，并返回满足这一条件的子数组的数目。子数组是数组中的一个连续元素序列。数据约束 1 ≤ n u m s …...

编程日记 2025/4/30 11:00:14

网络爬取需谨慎：警惕迷宫陷阱

一、技术背景：网络爬虫与数据保护的博弈升级 1. 问题根源：AI训练数据爬取的无序性数据需求爆炸：GPT-4、Gemini等大模型依赖数万亿网页数据训练，但大量爬虫无视网站的robots.txt协议（非法律强制），未经许可抓取内容（如新闻、学术论文、代码），引发版权争议（如OpenAI被…...

编程日记 2025/4/30 10:59:10

‘WebDriver‘ object has no attribute ‘find_element_by_class‘

在使用Selenium进行Web自动化测试时，如果你遇到了错误信息：“‘WebDriver’ object has no attribute ‘find_element_by_class’”，这通常是因为在Selenium 4及以上版本中，find_element_by_* 和 find_elements_by_* 这类方法已经…...

编程日记 2025/5/19 3:44:22

ComfyUI 学习笔记，案例1：2_pass_txt2img

背景 ComfyUI 官方案例学习笔记，本文是跑出的第三个案例，但确是官网案例的第一个，所以运行起来总体比较顺利。整理几点页面使用技巧： 是网页版本，没有 IDEA，而且画布上没有滚动条，想看清楚内容…...

编程日记 2025/5/11 18:24:45

代码颜色模式python

1. CMYK（印刷场景） 例子：某出版社设计书籍封面时，使用 Adobe Illustrator 绘制图案。红色封面的 CMYK 值可能为：C0, M100, Y100, K0（通过洋红和黄色油墨混合呈现红色）。印刷前需将设计文件转…...

编程日记 2025/4/30 10:59:06

Android第五次面试总结之网络篇（修）

一、域名解析到服务器的过程（DNS 解析流程） 当应用发起网络请求（如https://www.example.com）时，操作系统需先将域名转换为服务器 IP 地址，这一过程通过 DNS（域名系统） 完成&#xf…...

编程日记 2025/4/30 10:58:04

JavaScript 作用域全面总结

JavaScript 作用域全面总结作用域(Scope)是JavaScript中一个核心概念，决定了变量、函数和对象的可访问性。以下是JavaScript作用域的全面总结，结合表格和箭头图进行讲解。一、作用域类型 JavaScript 作用域类型详解 JavaScript 中有四种主要的作用…...

编程日记 2025/4/30 10:58:03

Redis核心与底层实现场景题深度解析

Redis核心与底层实现场景题深度解析在互联网大厂Java求职者的面试中，经常会被问到关于Redis的核心与底层实现相关的场景题。本文通过一个故事场景来展示这些问题的实际解决方案。第一轮提问面试官：马架构，欢迎来到我们公司的面试现场。…...

编程日记 2025/4/30 10:57:00

代发考试战报：4月份思科认证，华为认证，考试战报分享

CCNP 300-410考试通过战报，350-401 考试通过战报，CCNA 200-301 考试通过战报，HCIP数通 H12-821考试通过，H12-831考试通过，HCSP 行业金融 H19-611考试通过，HCSE 行业金融 H21-293 考试通过报名考试一定要找…...

编程日记 2025/4/30 10:56:59

Linux 内核中 TCP 协议的支撑解析

在 Linux 网络协议栈中，TCP（传输控制协议）作为面向连接的可靠传输协议，其实现依赖于一系列复杂的内核机制。本文通过分析四个关键函数（cookie_v4_init_sequence、tcp_fastopen_ctx_destroy、sk_forced_mem_schedule 和 sk_stream_alloc_skb），探讨它们如何共同保障 TCP 的…...

编程日记 2025/4/30 10:56:59

std::string的底层实现（详解）

目录 std::string的底层实现* 写时复制原理探究 CowString代码初步实现短字符串优化（SSO） 最佳策略 std::string的底层实现* 我们都知道， std::string的一些基本功能和用法了，但它底层到底是如何实现的呢? 其实在std::stri…...

编程日记 2025/4/30 10:55:55

蓝桥杯 11. 最大距离

编程日记 2025/5/8 17:12:35

【运维】使用 DataX 实现 MySQL 到 PostgreSQL 的数据同步

🚀 使用 DataX 实现 MySQL 到 PostgreSQL 的数据同步在日常的数据开发工作中，数据同步是一项极其常见的任务。而 DataX 作为阿里开源的一款通用数据同步工具，支持多种数据源之间的互通，使用简单，扩展性强，非常适合进行结构化数据的迁移和同步。本文将详细介绍如何通…...

编程日记 2025/5/16 7:20:48

Mangodb基本概念和介绍，Mango三个重要的概念：数据库，集合，文档

MongoDB基本概念和介绍 MongoDB 是一个开源的、基于分布式文件存储的NoSQL数据库，由 C 编写。它的主要特点是： 使用**面向文档（Document-Oriented）**的存储方式，不是传统的表格行列模式。存储的数据格式是BSON&…...

编程日记 2025/4/30 10:54:48

什么是ICSP编程

ICSP编程介绍 ICSP 编程（In-Circuit Serial Programming），即“在线串行编程”，是一种通过 SPI 协议直接对微控制器（如 Arduino 的 ATmega328P）进行编程的技术，无需移除芯片。它常用于以下场景…...

编程日记 2025/4/30 10:54:45

LeetCode 155题解 | 最小栈

最小栈一、题目链接二、题目三、算法原理思路1：用一个变量存储最小元素思路2：双栈普通栈和最小栈四、编写代码五、时间复杂度一、题目链接最小栈二、题目三、算法原理栈用数组、链表实现都行，最主要的就是在能在常数时间内检索到最…...

编程日记 2025/5/5 14:45:17

Modal 深度解析：无服务器高性能计算平台实战指南

概览 Modal 是一个 “零配置，无需 YAML” 的云函数平台，通过将你的 Python 代码打包进容器并在 Modal 自建的云环境中执行，实现秒级启动、按秒计费、自动弹性扩缩容等能力。它构建在高性能 Rust 容器堆栈与 gVisor 沙箱之上，为大规模 AI 推理、批量数据处理、作业调度、Web…...

编程日记 2025/5/8 2:57:34

数字逻辑--期末大复习

写卷子前准备：二进制串、卡诺图的数序、分析与设计的步骤，直接写上省的忘了进制转化二进制刚开始做题前可以把0-9次方的列出来十进制转二进制:不断除以2得到余数，直到商为0，再将余数倒着拼起来即可。如十六进制&#xff…...

编程日记 2025/4/30 10:52:39

【Redis】缓存|缓存的更新策略|内存淘汰策略|缓存预热、缓存穿透、缓存雪崩和缓存击穿

思维导图： Redis最主要的用途，三个方面： 1.存储数据（内存数据库） 2.缓存（redis最常用的场景） 3.消息队列一、什么是缓存我们知道对于硬件的访问速度来说，通常情况下&#xff1…...

编程日记 2025/4/30 10:51:34

kubelet 清理资源以缓解磁盘压力

kubelet 资源清理缓解磁盘压力指南在 Kubernetes 集群中，当节点磁盘压力过大时，可通过以下几种方式利用 kubelet 清理资源，从而缓解磁盘压力。一、镜像垃圾回收自动回收 kubelet 内置了镜像垃圾回收机制，其行为由配置参数控…...

编程日记 2025/4/30 10:51:33

机器人“跨协议对话”秘籍：EtherNet IP转PROFINET网关应用实录

近期，我们工厂在进行自动化生产线升级改造时，引进了一批全新的机器人手臂设备。这批机器人采用EtherNet/IP通信协议，而生产线上原有的终端控制器则使用PROFINET协议。由于两种协议在通信标准和数据格式上存在差异，导致机器人手臂无…...

编程日记 2025/5/19 3:20:07

松下机器人快速入门指南（2025年更新版）

松下机器人快速入门指南（2025年更新版） 松下机器人以其高精度、稳定性和易用性在工业自动化领域广泛应用。本文将从硬件配置、参数设置、手动操作、编程基础到维护保养，全面讲解松下机器人的快速入门方法，帮助新手快速掌握核心操…...

编程日记 2025/4/30 10:50:30

开启健康养生，重塑生活品质

当你习惯性地用咖啡开启忙碌的一天，当熬夜加班成为生活常态，当外卖占据一日三餐，或许未曾察觉，健康正悄然亮起红灯。在快节奏的现代生活中，健康养生不再是可选项，而是关乎生活质量与生命活力的必答题&#…...

编程日记 2025/4/30 10:49:26

百度「心响」：通用超级智能体，重新定义AI任务执行新范式

在AI技术从“对话交互”迈向“任务执行”的转折点，百度于2025年4月正式推出移动端超级智能体应用——心响。这款以“AI任务完成引擎”为核心的创新产品，被誉为“AI指挥官”，通过自然语言交互实现复杂任务的全流程托管，覆盖知识解析…...

编程日记 2025/4/30 10:47:18

AXPA17388: 4x45W 车用AB类四通道桥式输出音频功率放大器

AXPA17388是采用BCD(双极型，CMOS，DMOS)工艺技术设计的四通道桥式输出AB类车用音频功率放大器，采用完全互补的P型/ N型输出结构， 具有轨到轨的输出电压摆幅，高输出电流，具有出色的低失真性能。 AXPA17388可以…...

编程日记 2025/4/30 10:46:15

【codeforces 2086d】背包+组合数学

【codeforces 2086d】背包组合数学 Problem - D - Codeforces 题意： 给出字符串中每个字符的出现次数 c i ( 1 ≤ i ≤ 26 ) c_i(1 \leq i \leq 26) ci(1≤i≤26)。现构造一个字符串，要求任意相同字母之间的距离必须是偶数。求满足要求的字符串的数量…...

编程日记 2025/4/30 10:46:14

[特殊字符]OCR，给交通领域开了“外挂”？

OCR 技术是什么宝子们，OCR 其实就是光学字符识别（Optical Character Recognition）的英文缩写。简单来说，它能让电子设备，比如扫描仪、摄像头这些，像长了眼睛一样，“看” 懂图片或文档里的文字&…...

编程日记 2025/4/30 10:46:13

【语法】C++继承中遇到的问题及解决方法

目录 1.子类构造函数中初始化父类成员 2.子类显式调用父类的析构函数第一种说法：重定义反驳： 第二种说法：operator~ 3.因编译器版本过低而出现错误贴主在学习C的继承时，遇到了很多问题，觉得很变态&#xff0c…...

编程日记 2025/5/5 21:21:36

【自然语言处理与大模型】LangChain大模型应用框架入门②

本文介绍LangChain的另一个重要组件——提示词模板（Prompt Template）组件，它主要用于将用户输入和参数转换为语言模型可理解的指令。有助于引导模型生成符合预期的响应，帮助其更好地理解上下文，从而输出相关且连贯的语…...

编程日记 2025/4/30 10:44:03

首页数据展示

排版现在做首页的排版，依旧是偷antd里面的东西使用card包裹list的样式 import React from react import axios import { Card, Col, Row, List } from antd import { EditOutlined, EllipsisOutlined, SettingOutlined } from ant-design/icons; import { Avat…...

编程日记 2025/4/30 10:43:00

推荐系统实验指标置信度：p值核心原理与工程应用指南

目录一、推荐系统实验中的置信度困境二、p值核心原理：从假设检验到推荐场景适配2.1 基础概念与数学定义2.2 通俗版本核心白话总结： 2.2 推荐系统指标分类与统计方法三、推荐系统实验p值计算全流程3.1 实验设计阶段：流量分配与检验效能3.2 数…...

编程日记 2025/5/12 14:18:32

linux FTP服务器搭建

FTP服务器搭建系统环境：ubuntu 搭建方式：win系统下通过ssh连接ubuntu，搭建FTP服务一、ssh连接 ssh -p 端口用户名IP ssh -p 22 ubuntu192.168.1.109 密码：ubuntu123456 二、安装配置FTP服务器 1、安装 sudo apt install v…...

编程日记 2025/4/30 10:42:58

如何搭建一个简单的文件服务器的方法

搭建一个简易的文件服务器可以让你在局域网或互联网中共享文件，方便不同设备之间的访问与管理。以下是基于常见平台(Windows、Linux)分别介绍如何搭建一个简单的文件服务器的方法，适合个人或小型办公环境使用。一、文件服务器的准备工作所需条件&#…...

编程日记 2025/5/12 19:58:12