EPM
本章介绍 EPM 仓库的使用方法。
概述
EdgerOS Package Manager(以下简称EPM)是爱智开源社区为广大开发者免费提供的 JavaScript(以下简称JS)软件包仓库。开发者仅需要简单的配置就可以使用 npm 命令行工具从 EPM 拉取开源软件包,或者发布自己的开源软件包。
前提条件
- 了解 命令行开发环境。
- 安装 Node.js,推荐使用最新的 Node.js LTS 发行版,请参考 Node.js 官方网站。
- 在 爱智官网 注册翼辉 ID。
- 完成 NPM 配置。
使用说明
安装软件包
方式一
登录 EPM,使用 npm 命令从 EPM 安装软件包,命令如下:
npm install @edgeros/welcome
方式二
登录 EPM 网站 浏览和搜索已经发布的开源软件包并手动下载。
发布软件包
爱智开发者可以将自己的得意之作发布到 EPM 供其它社区成员下载使用。为了保障社区的繁荣发展,开发者在发布自己的软件包之前请先阅读以下说明。
发布方式:
使用 翼辉 ID 登录 EPM 并完成软件包的开发后,按照 npm publish 的标准流程将软件包发布到 EPM。可参考 npm publish。例如:
cd /path/to/your/package
npm publish
软件包命名规范:
在 NPM 命名规范的基础上,为了方便广大开发者查找,EPM 对软件包进行简单的分类,并制定了相应的命名规范:
- @edgeros/jsre-xxx:软件包依赖于 EdgerOS® 操作系统 JSRE 的专有API,脱离 JSRE 可能无法运行。
- @edgeros/web-xxx:可以运行在浏览器中的单纯的 JS 软件包,通常与其它 @edgeros 软件包配合使用。
- 其它软件包名:建议遵循行业常识和最佳实践,例如:
- @edgeros/cli:爱智命令行开发工具包
- @edgeros/eslint-plugin-jsre:JSRE 的 eslint 代码辅助提示插件
补充说明
命令行开发环境
- Windows 操作系统用户,可以使用系统自带的 命令提示符(cmd.exe) 工具。
- Linux 或 Mac 用户可以使用系统自带的 终端(Terminal) 工具。
在启动 命令提示符 或 终端 程序后,键入 npm -v
确定 npm 程序的版本。否则,如果系统还没有安装或正确配置 Node.js,则会提示“没有此命令”等错误信息。
翼辉 ID
如果您希望发布自己的开源软件包到 EPM,则首先需要使用翼辉 ID 登录 EPM。 如果您还没有注册过翼辉 ID,请移步 爱智官网 进行注册。
配置 NPM
- 在命令行环境中键入如下命令,并按照提示依次输入您的翼辉 ID、用户名、密码和公共电子邮件地址:
npm login --scope=@edgeros --registry=https://registry.epm.edgeros.com
# Username:
# Password:
# Email: (this IS public)
# Logged in as xxx to scope @edgeros on https://registry.epm.edgeros.com/.
- scope=@edgeros:限定了 NPM 的组织机构范围
- registry=https://registry.epm.edgeros.com:指定了 EPM 软件包注册中心的服务地址
登录成功后,npm 将提示 “Logged in as xxx to scope @edgeros on https://registry.epm.edgeros.com/”。 同时 NPM 会自动地添加您此次登录所配置的 registry,scope,token 等信息保存在 .npmrc 文件中。
您可以通过(Linux)命令
cat ~/.npmrc
查看该文件的内容,请确保文件中已经包含了如以下例子中的配置信息:
@edgeros:registry=https://registry.epm.edgeros.com/
//registry.epm.edgeros.com/:_password=xxxxxxxxx
//registry.epm.edgeros.com/:username=翼辉ID
//registry.epm.edgeros.com/:email=xxx@example.com
//registry.epm.edgeros.com/:always-auth=false
其中 @edgeros:registry=https://registry.epm.edgeros.com/ 一行说明对于 @edgeros 这个组织内的软件包将从 EPM 站点获取。 以下的几行分别保存了你在 EPM 网站使用的翼辉 ID、密码以及公共可见的电子邮件地址。
许可证
EPM 欢迎社区友好的开源许可证,包括但不限定于: