【源码】基于Rollup框架的Npm包发布脚手架

项目简介

本项目是一个基于Rollup框架的Npm包发布脚手架，适用于Npm包发布。它支持区分cjs/es双格式编译发布，集成了Storybook、TypeScript、Scss、Babel、Eslint、Prettier、Husky和LintStaged等工具，有助于提升开发效率和代码质量。

项目的主要特性和功能

1. Rollup打包：简化配置，替代Webpack，支持cjs/es双格式编译发布。
2. TypeScript开发：便于开发，可提前预知所需属性。
3. 代码规范与格式化：Eslint规范JS相关代码，Prettier格式化文件格式，提高代码可读性。
4. Git提交拦截与检测：Husky拦截Git提交，Lint - staged配合Husky对commit代码进行Eslint检测，防止冗余代码进入仓库。
5. 一致开发环境：.vscode、.editorConfig保证不同机器上开发环境相同，开发更便捷。
6. 版本与安装源管理：.nvmrc告知生产环境CI的node版本，.npmrc设定安装源，规避墙。
7. 组件文档与Demo生成：Storybook根据组件生成文档以及Demo。

安装使用步骤

准备工作

1. 确保已下载本项目的源码文件，使用VSCode打开当前安装项目文件路径。
2. 删除影响配置的文件：删除锁定版本的文件（如lock文件）和node_modules文件夹。

安装依赖

根据项目中的package.json文件内容，直接运行yarn install进行依赖安装，勿逐个安装库，避免配置问题。

配置开发环境

1. 安装VSCode插件“editorconfig.editorconfig”，使.editorconfig生效。
2. 重新打开VSCode和项目，避免缓存配置影响。

启动项目

运行yarn start启动Storybook，开始开发。

打包项目

• 开发环境：运行yarn build - dev。
• 生产环境：运行yarn build - prod。

发布Npm包

1. 注册npm账号：访问https://www.npmjs.com/ 进行注册。
2. 登录npm：在本地控制台运行npm login，输入注册的账号信息。
3. 修改package.json：确保main、module等属性指向编译打包后的文件。
4. 创建.npmignore文件：指定不发布到npm的文件和文件夹。
5. 发布包：运行npm publish。
6. 检测发布结果：在npm上直接搜索包名。

下载地址

点击下载 【提取码: 4003】【解压密码: www.makuang.net】