Skip to content

v-idol/npm-template

 
 

Repository files navigation

@arvinxu/npm-template

NPM version NPM downloads install size

Test CI status Deploy CI Coverage

 docs by dumi Build With father

简介

这是一个开发 npm 项目的模板,工程框架选型如下:

  • 构建: father4
  • 文档: dumi2
  • CI: Github Action
  • CD:
    • 文档发布: 使用 vercel 自动化触发文档站构建;
    • npm 发布: 使用 semantic-release 实现 npm 包的自动化发布;

快速上手

安装

推荐使用 pnpm 安装

pnpm i @arvinxu/npm-template -S

使用

基于该仓库模板可以快速创建一个 npm 包的工程化脚手架。

使用介绍

Step1. 使用该模板创建一个新的仓库

点击右上角 use this template -> create a new reposity 按钮,创建一个新的仓库。

Step2. 初始化项目信息

使用编辑器全局替换 @arvinxu/npm-template 为你的包名(例如 antd-style),执行 pnpm i 安装依赖。

Step3. 开始开发

迭代记录

2022.12.17 - 基于蚂蚁研发技术栈配置完成最新的 npm 研发脚手架

详情:CHANGELOG

License

MIT

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 45.7%
  • JavaScript 45.1%
  • Shell 9.2%