跳至内容

发布包

发布 Meteor 包涉及几个关键步骤,包括设置你的包、测试它,最后将其发布到 Meteor 包仓库。以下是如何使用 Meteor 3 发布 Meteor 包的简要指南,特别是使用 meteor publish --release=3.0.3 命令。

先决条件

  • 确保你已安装 Meteor 3。你可以检查你的 Meteor 版本,如果缺少则自动下载。
    bash
    meteor --version --release=3.0.3
  • 拥有一个 Meteor 开发者账户。你可以在Meteor 官方网站创建账户。

分步指南

1. 设置你的包

首先,你需要创建一个包目录并设置你的包结构。

  1. 创建包结构
bash
meteor create --package user:package
cd package
  1. 编辑 package.js 文件:此文件包含有关你的包及其依赖项的元数据。这是一个示例结构
javascript
Package.describe({
 name: 'user:package',
 version: '0.0.1',
 summary: 'A brief description of my package',
 git: 'https://github.com/myusername/my-package',
 documentation: 'README.md'
});

Package.onUse(function(api) {
 api.versionsFrom('3.0');
 api.use('ecmascript');
 api.mainModule('my-package.js');
});

Package.onTest(function(api) {
 api.use('ecmascript');
 api.use('tinytest');
 api.use('user:package');
 api.mainModule('my-package-tests.js');
});

如果该包也打算与 Meteor 2 一起使用,你可以使用

javascript
api.versionsFrom(['2.3', '3.0']);
  1. 创建主模块文件
bash
touch my-package.js
  1. 创建测试文件(可选但推荐)
bash
touch my-package-tests.js

2. 开发你的包

my-package.js 中添加你的包逻辑。例如

javascript
export const greet = (name) => {
  return `Hello, ${name}!`;
};

3. 测试你的包

在发布之前,请确保你的包按预期工作。

  1. 运行测试
bash
meteor test-packages ./ --driver-package meteortesting:mocha
  1. 修复在测试过程中遇到的任何问题。

4. 发布你的包

一旦你的包准备就绪并经过测试,你可以使用以下命令发布它

bash
meteor publish --release=3.0.3

你可以将 3.0.3 替换为相应的发布版本。如果你省略 --release 标志,它将默认为最新的官方 Meteor 版本,在撰写本文时为 Meteor 2。这样,在不指定发布的情况下发布的包将与 Meteor 3 不兼容,因为可能会有一个与 fibers 相关的错误。

  • 如果提示,请登录:如果你尚未登录,系统将要求你使用你的 Meteor 开发者账户凭据登录。

  • 发布确认:登录后,你的包将发布到 Meteor 包仓库。

5. 验证你的包

为了确保你的包已正确发布,你可以在 Meteor 包仓库中搜索它,或者尝试将其添加到 Meteor 项目中。

bash
meteor add user:package

提示

  • 版本控制:遵循语义版本控制你的包版本,以确保兼容性和正确的版本管理。
  • 文档:README.md 文件中提供详细的文档,以帮助用户了解如何使用你的包。
  • Git 仓库:将你的包源代码保存在版本控制的仓库(如 GitHub)中,以便于协作和更新。

通过遵循这些步骤,你应该能够成功地使用 Meteor 3 发布你的 Meteor 包。编码愉快!