编写JavaScript npm包的模板

vian f59006401d chore: 变更eslint配置 5 år sedan
dist ce94fe5604 build: init 5 år sedan
src ce94fe5604 build: init 5 år sedan
.eslintignore ce94fe5604 build: init 5 år sedan
.eslintrc.js f59006401d chore: 变更eslint配置 5 år sedan
.gitignore 79a8ec9996 build: init 5 år sedan
README.md ce94fe5604 build: init 5 år sedan
package-lock.json ce94fe5604 build: init 5 år sedan
package.json ce94fe5604 build: init 5 år sedan
prettier.config.js 79a8ec9996 build: init 5 år sedan
rollup.config.js ce94fe5604 build: init 5 år sedan

README.md

本项目是开发JavaScript npm包项目的模板,基于rollup打包,输出可被CommonJS、ESModule识别,并可直接被浏览器script引入的模块。

开始

基于本仓库进行开发,可以fork一个仓库或自行拷贝目录结构。

初始化

npm install

构建

  1. npm run build
  2. 若库需要被TypeScript项目引入,则必须添加声明文件:在dist目录下新建文件index.d.ts文件,编写相关声明(本仓库有简单示例)。

    代码风格

    ESLint + Airbnb config

Prettier

发布

package.json中name名称需要修改为相应包名称。为了将包发到npm私服上,name且必须以“@sc/”开头,如:@sc/test。

发布前应先执行构建指令

注册npm的地址为npm私服地址:

npm config set registry http://192.168.1.90:4873(可使用nrm进行管理)

发布

npm publish

若缺少权限,需要先进行用户验证:

  • 无私服账户: npm adduser
  • 有私服账户 npm login