npm 包 trello 使用教程

前言

    Trello 是一个在线项目管理工具，它提供了实时协作、板块划分、任务分配、看板式布局等功能。相信很多使用 Trello 作为项目管理工具的开发者都希望能在编程中自动化一些操作，例如：自动创建卡片、移动卡片、给卡片添加标签等。这就需要借助 Trello 的 API 进行开发。本文将介绍 npm 包 trello，帮助开发者更加便捷的使用 Trello 的 API。

trello 简介

    trello 是一个 Node.js 的 npm 包，通过这个包可以实现对 Trello API 的更好的管理和对 Trello 卡片的自动化操作。trello 封装了我们常见的 HTTP 请求，在 Trello 官方 API 的基础之上添加了一些语法糖，让开发者更加便捷的调用 API。

安装 trello

    trello 可以通过 npm 安装，只需要在终端中执行以下命令即可：

npm install trello

trello API 的准备工作

    要使用 trello 包操作 Trello 卡片，首先需要前往 Trello 官网注册账号，并开启开发者的 API 权限。步骤如下：

1. 前往 Trello 注册页面 注册账号。

2. 如果已有账号，可以点击 Trello 开发者页面 获取应用程序 ID 和开发者密钥。如果账号中已有应用程序，则可以在应用程序的设置中获取相应的 ID 和密钥。

   

3. 授权 trello 应用程序访问 Trello 帐户。如下代码，其中 TRELLO_KEY 为上面获取的应用程序 ID，TRELLO_SECRET 为开发者密钥。

const Trello = require('trello');
const trello = new Trello(TRELLO_KEY, TRELLO_SECRET);

trello 卡片操作

    了解了如何安装和配置 trello 后，我们就可以开始使用 trello 自动化 Trello 卡片。下面将介绍 trello 常见的卡片操作。

获取 Trello 认证链接

    在开始卡片操作之前，我们需要获取 Trello 的认证链接，这个链接将会在我们的程序中用于认证用户。

const authUrl = trello.getAuthorizationUrl('My App', 'https://myapp.com/return', 'none');

console.log(`Visit ${authUrl} to authorize your app.`)

查询 Trello 卡片

    我们可以使用 trello 来搜索某个 Trello 卡片。例如下面的代码将搜索所有 board 中标题包含 “my board” 的卡片。

trello.search('my board', ['cards'], (err, data) => {
  if (err) throw err;
  console.log(data);
});

根据 ID 获取 Trello 卡片

    如果我们知道卡片的 ID，我们可以轻松地获取它。下面的代码将获取卡片 ID 为 "12345" 的所有信息。

trello.getCard('12345', (err, card) => {
  if (err) throw err;
  console.log(card);
});

创建新的 Trello 卡片

    我们可以通过 trello 快速地创建新的 Trello 卡片。例如下面的代码将在指定的列表中创建一个新的卡片。

trello.addCard('New Card Title', 'New Card Description', 'listId',
  (err, card) => {
    if (err) throw err;
    console.log(card);
  }
);

移动 Trello 卡片

    我们可以使用 trello 将卡片从一个列表移动到另一个列表。例如下面的代码将卡片 ID 为 "12345" 的卡片从列表 ID 为 "list1" 的列表移动到列表 ID 为 "list2" 的列表。

trello.moveCardToList('12345', 'list1', 'list2', (err, card) => {
  if (err) throw err;
  console.log(card);
});

更新 Trello 卡片

    我们可以使用 trello 更新 Trello 卡片的其他属性，例如卡片的标题，卡片描述等。例如下面的代码将更新卡片 ID 为 "12345" 的卡片的标题为 "New Title"。

trello.updateCard('12345', 'name', 'New Title', (err, card) => {
  if (err) throw err;
  console.log(card);
});

总结

    本文我们介绍了 npm 包 trello 的使用方法，并详细说明了 trello 常见的卡片操作，包括创建、移动、查询、更新卡片等。trello 的使用极大地提高了 Trello API 的调用效率，让开发者能以更简洁的代码实现更多自动化的功能，希望本文对读者有所帮助。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/trello