traq-bot-ts

TypeScript で traQ Bot を作りたい人向けのライブラリです。JavaScriptでも多分使えます。

強力に型が整備されていることと、使いやすいAPIを備えていることが特徴です。

使い方

npm install traq-bot-ts
yarn add traq-bot-ts
pnpm add traq-bot-ts
bun add traq-bot-ts

import { Client } from 'traq-bot-ts';

const client = new Client({ token: 'WRITE_YOUR_TOKEN_HERE' });

client.on('MESSAGE_CREATED', ({ message }) => {
   console.log(message.text);
});

await client.listen(() => console.log('connected'));

※Deno で使いたい場合は、最初の traq-bot-ts のところを npm:traq-bot-ts に書き換えてください

new Client()でクライアントを生成して、各種イベントをclient.on()でリッスンできます。

最後にawait client.listen()で実際にサーバーに接続して稼働を開始します。

具体的なイベントについてはBOT Consoleのイベントリファレンスを参照してください。

コントリビューター向け

1. このリポジトリをフォークする
2. フォークしたリポジトリをローカルにクローンしてプロジェクトルートに移動する
3. パッケージのインストール

   bun i

4. 開発する
5. 変更内容を記述する

   bun changeset

6. コミット前

   bun precommit

7. コミット＆プッシュ
8. フォークしたリポジトリからプルリクエストを作成する
9. 以下は管理者がバージョンアップする場合のみ
10. バージョンの変更とプッシュ

    bun changeset version

11. mainブランチにマージする
12. タグをつけてプッシュ

    bun changeset tag

13. CI/CDが自動でNPMに公開する