https://github.com/sonofmagic/npm-lib-template

npm-lib-template
https://github.com/sonofmagic/npm-lib-template

Last synced: 15 days ago
JSON representation

npm-lib-template

• Host: GitHub
• URL: https://github.com/sonofmagic/npm-lib-template
• Owner: sonofmagic
• License: mit
• Created: 2021-11-17T08:33:32.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-10-16T17:05:30.000Z (26 days ago)
• Last Synced: 2024-10-18T09:11:32.825Z (24 days ago)
• Language: TypeScript
• Size: 1.21 MB
• Stars: 24
• Watchers: 2
• Forks: 2
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# npm-lib-template

[![codecov](https://codecov.io/gh/sonofmagic/npm-lib-template/branch/main/graph/badge.svg?token=zn05qXYznt)](https://codecov.io/gh/sonofmagic/npm-lib-template)

[icebreaker](https://github.com/sonofmagic) 编写的一个 `npm` 包的一个模板

- 使用 `tsup` 打包 , `rollup` 打包版本在 [rollup](https://github.com/sonofmagic/npm-lib-template/tree/rollup) 分支 (兼容 `tsc`)

- 使用 `vitest` 作为单元测试框架

- 使用 `eslint` 来规范代码风格

- 输出 `dist` -> `cjs`,`esm` and `.d.ts`

- 使用 `semantic-release` 来发布 `npm`/`github`

## 为什么使用 `vitest` 而不是原先的 `jest`

`vitest` 开箱即用, `jest` 在同时遇到 `cjs` 和 `esm` 依赖的时候，支持差，而且配置复杂，依赖的 `preset` 多，比如 `ts-jest`..

## scripts

### rename

执行 `npm run init:rename`

作用为替换 `package.json` 中默认包含的所有名称为 `npm-lib-template` 的字段

默认替换为新建代码仓库的文件夹名称！

### bin

执行 `npm run init:bin`

作用为 `package.json` 添加 `files` 和 `bin`，同时生成 `bin/{{pkg.name}}.js` 和 `src/cli.ts` 文件