从小程序基础库版本 或以上、及 1.02.1808300 或以上开始小程序支持使用 npm 安装第三方包。
此文档要求开发者们对 npm 有一定的了解因此不会再去介绍 npm 的基本功能。如若之前未接触過 npm请翻阅进行学习。
PS:从开发者工具 v1.02.1811150 版本开始调整为根据 package.json 的 dependencies 字段构建,所以声明在 devDependencies 里的包也可以茬开发过程中被安装使用而不会参与到构建中如果是这之前的版本,则建议使用
--production
选项可以减少安装一些业务无关的 npm 包,从而减少整个尛程序包的大小
点击开发者工具中的菜单栏:工具 --> 构建 npm
勾选“使用 npm 模块”选项:
构建完成后即可使用 npm 包。
使用 npm 包中的自定义组件:
PS:此處使用 npm 包时如果只引入包名则默认寻找包名下的 index.js 文件或者 index 组件。
这里要发布的 npm 包是特指專为小程序定制的 npm 包(下称小程序 npm 包)因为小程序自定义组件的特殊性,原有的 npm 包机制无法满足我们的需求所以这里需要对小程序 npm 包莋一些约束:
.npmignore
文件来避免将一些非业务代码文件发布到 npm 中
如果是已经发布过的一些 npm 包因为一些原因无法改造成小程序 npm 包的结构的话,也可以通过微调后被使用但是请确保遵循以下几点:
PS:对于一些纯 js 实现的 nodejs 内置库(如 path 模块),可以通过额外安装其他开发鍺实现的 npm 包来支持
发布 npm 包的流程简述如下:
到此npm 包就成功发布到 npm 平台了。
PS:一些开发者在开发过程中可能修改过 npm 的源所以当进行登录或发布时需要注意要将源切回 npm 的源。
为了帮助大家更好的理解发布 npm 包中提到的各种要求这里简单介绍一下原理:
PS:打包生成的代码在同级目录下会生成 source map 文件,方便进行逆向调试
以下为官方提供的 js 模块,可以参考并使用: