使用TS+rollup打造一个npm工具库

要使用TypeScript和Rollup打造一个npm工具库,你需要执行以下步骤:

  1. 初始化项目并安装TypeScript和Rollup依赖。
  2. 创建TypeScript配置文件tsconfig.json
  3. 创建Rollup配置文件。
  4. 编写你的库代码。
  5. 构建库并发布到npm。

以下是一个简单的例子:

  1. 初始化项目并安装依赖:



npm init -y
npm install --save-dev typescript rollup @rollup/plugin-typescript rollup-plugin-terser
  1. 创建tsconfig.json



{
  "compilerOptions": {
    "target": "es5",
    "module": "es2015",
    "strict": true,
    "noImplicitReturns": true,
    "moduleResolution": "node",
    "esModuleInterop": true,
    "declaration": true,
    "outDir": "dist",
    "sourceMap": true
  }
}
  1. 创建rollup.config.js



import typescript from '@rollup/plugin-typescript';
import { terser } from 'rollup-plugin-terser';
 
export default {
  input: 'src/index.ts',
  output: [
    {
      file: 'dist/my-library.cjs.js',
      format: 'cjs',
    },
    {
      file: 'dist/my-library.esm.js',
      format: 'esm',
    },
    {
      file: 'dist/my-library.umd.js',
      format: 'umd',
      name: 'myLibrary'
    }
  ],
  plugins: [
    typescript({ tsconfig: './tsconfig.json' }),
    terser()
  ]
};
  1. src目录下创建index.ts文件并编写你的库代码。
  2. 在项目根目录下创建一个构建脚本,例如build.js



const { build } = require('rollup');
const rollupConfig = require('./rollup.config');
 
build(rollupConfig)
  .then(() => {
    console.log('Build successful');
  })
  .catch(error => {
    console.error('Build error:', error);
    process.exit(1);
  });
  1. package.json中添加scripts:



{
  "scripts": {
    "build": "node build.js"
  }
}
  1. 构建库:



npm run build
  1. 发布到npm:

    首先确保你已在npm上注册账号,然后登录到你的npm账号:




npm login

然后发布:




npm publish

这个例子提供了一个基本框架,你可以根据自己的需求进行扩展和定制。

npm
最后修改于:2024年08月09日 12:07

评论已关闭

推荐阅读

DDPG 模型解析,附Pytorch完整代码
2024年11月24日
DQN 模型解析,附Pytorch完整代码
2024年11月24日
AIGC实战——Transformer模型
2024年12月01日
Socket TCP 和 UDP 编程基础(Python)
2024年11月30日
python , tcp , udp
如何使用 ChatGPT 进行学术润色?你需要这些指令
2024年12月01日
AI
最新 Python 调用 OpenAi 详细教程实现问答、图像合成、图像理解、语音合成、语音识别(详细教程)
2024年11月24日
ChatGPT 和 DALL·E 2 配合生成故事绘本
2024年12月01日
omegaconf,一个超强的 Python 库!
2024年11月24日
【视觉AIGC识别】误差特征、人脸伪造检测、其他类型假图检测
2024年12月01日
[超级详细]如何在深度学习训练模型过程中使用 GPU 加速
2024年11月29日
Python 物理引擎pymunk最完整教程
2024年11月27日
MediaPipe 人体姿态与手指关键点检测教程
2024年11月27日
深入了解 Taipy:Python 打造 Web 应用的全面教程
2024年11月26日
基于Transformer的时间序列预测模型
2024年11月25日
Python在金融大数据分析中的AI应用(股价分析、量化交易)实战
2024年11月25日
AIGC Gradio系列学习教程之Components
2024年12月01日
Python3 `asyncio` — 异步 I/O,事件循环和并发工具
2024年11月30日
llama-factory SFT系列教程:大模型在自定义数据集 LoRA 训练与部署
2024年12月01日
Python 多线程和多进程用法
2024年11月24日
Python socket详解,全网最全教程
2024年11月27日