Backlog(Nulab) Integration for VS Code

IDE（VS Code , Cursor , Windsurf 等）で動く Backlog（Nulab社製プロジェクト・タスク管理ツール）拡張機能

A Backlog (Project/Task management tool by Nulab) extension for IDEs (VS Code, Cursor, Windsurf, etc.).

課題の確認、ステータス更新、コメント投稿から、プルリクエスト（PR）まで、開発に必要な操作をIDE内でシームレスに実行できます。 AIを活用したタスク登録や、分析機能も提供。 次世代のタスク管理を業務に取り入れよう！

From checking issues, updating statuses, and posting comments to handling Pull Requests (PRs), you can seamlessly run all the development operations you need right inside your IDE. It also offers AI-powered task registration and analysis features. Bring next-generation task management into your workflow!

Request → (https://forms.gle/bp5fGoxMbrva1pJJ8)

▼ 日本語版 概要説明

English version is available below.

主な機能 (Key Features)

1. タスク管理 (Task Management)

• 課題一覧表示: キーワード/担当者/状態/マイルストーン/更新日・作成日範囲/ソートで絞り込み表示（30件ずつページング）。
• 課題詳細閲覧: 課題クリックでエディタタブに詳細を表示（既定表示を WebView / Markdown から切替可能）。
• 課題作成: 「新規課題」タブから種別・件名・担当者などを指定して起票（作成後の自動クリア対応）。
• コメント: 「コメントを読み込む」で10件ずつ追加読み込み。新規コメント投稿に対応。
• ステータス更新: 課題詳細画面にて、ステータス更新が可能。変更前に確認ダイアログを表示。
• Markdown出力: 課題一覧/課題詳細を統計情報付きでMarkdown出力（AIチャット共有やWiki転記に便利）。
• 一覧アクション: 各課題行に MD（Markdown）アイコン（表示/非表示をカスタマイズ可）。

2. Git連携 (Git Integration)

• スマートブランチ作成: 課題キーを含むブランチをプレフィックス付きで自動作成。ベースブランチ指定・作成後の自動チェックアウトに対応。
• コミットメッセージ補完: 現在のブランチ名から課題キーを抽出し、SCM入力へ自動挿入。
• ブランチ整理: リモートに存在しないローカルブランチを一覧表示し、一括削除可能。

3. PR管理 (Pull Request Management)

• PR一覧: Open / Closed / Merged、担当者、作成者、関連課題で検索し、追加読み込みに対応。
• PR詳細: エディタパネルで詳細閲覧、コメント一覧の追加読み込み、コメント投稿に対応。
• PR作成: マージ対象ブランチの選択、関連課題検索・自動検索、タイトル自動補完、担当者・通知ユーザ指定、作成後の自動クリア対応。

4. AI連携 (AI-Powered Features)

• 課題一括取り込み: ワークスペース内の .backlog/import/*.md を解析し、Backlog課題として一括登録。AI用プロンプトを自動作成し、インポート用Markdownの作成を支援。
• 課題分析: 課題一覧データの定量分析・リスク検知用のAIプロンプトを生成。レポートやスライド構成の作成を支援。

5. 直感的なUIと設定 (Intuitive UI & Settings)

• 6つの専用タブ: 「課題一覧」「新規課題」「PR一覧」「PR作成」「設定」「ツール」（新規課題・PR一覧は表示/非表示可）。
• 表示カスタマイズ: 「新規課題」「PR一覧」タブ、課題フィルタ項目、アイコン（MD/Br/PR）の表示/非表示を切替可能。
• ステータス同期: ステータス/課題種別/ユーザー/優先度/マイルストーン等を一括同期し、キャッシュして高速化。
• エディタパネル: サイドバーに加え、エディタ領域のタブとしてBacklog UIを開き、課題/PR詳細へSPA遷移（戻る・別ウィンドウ化対応）。
• 通知バッジ: ステータスバーに未読お知らせ数を表示。クリックでQuick Pickから一覧を開き、課題/PRを直接開ける。
• VS Code Native: VS Codeのデザインシステムに準拠し、ダークモードにも対応。
• 多言語対応: Backlog APIの認証ユーザー情報に基づき、UIを日本語/英語で自動切り替え。手動切替も可能で、設定は永続化されます。

始め方 (Getting Started)

1. 拡張機能をインストールします。
2. サイドバーのアクティビティバーに表示される Backlog アイコンをクリックします。
3. 「設定 (Settings)」タブ を開きます。
4. Backlog（接続設定） で以下を入力して保存します：

• 認証方式: APIキー / アクセストークン
• APIキー / アクセストークン: Backlogの個人設定から発行した値
• Space URL: BacklogのスペースURL (例: https://your-space.backlog.jp)
• プロジェクト選択: プロジェクト一覧取得 → ドロップダウンから選択（キーワード絞り込み対応）
• 取得件数上限: 一度に取得する件数
• API無効時間: 3秒 / 5秒 / 10秒 / 30秒

APIキーの取得：個人設定 > API

5. Git連携/PR機能を使う場合、Git（Git連携設定） でリポジトリを選択（検索）して保存します。
6. 「ツール」タブ で「同期」を実行します（課題作成・フィルタに必要なメタデータを更新）。
7. 「課題一覧」タブ に移動し、「更新」ボタンを押すと課題が表示されます。

設定項目 (Extension Settings)

設定は基本的に サイドバーの設定タブ から行います（機密情報は SecretStorage に暗号化保存されます）。

Backlog（接続設定）

• 認証方式: APIキー / アクセストークン
• BacklogスペースURL
• プロジェクト選択
• 取得件数上限
• API無効時間（操作クールダウン）

Git（Git連携設定）

• ブランチプレフィックス: （なし）/ target / feature / bugfix
• コミットメッセージに課題キーを自動挿入: ON/OFF
• ブランチ名の最大文字数
• リポジトリ選択: 手入力で検索・選択

表示設定

• 検索項目の表示/非表示: キーワード/担当者/状態/マイルストーン/更新日範囲/作成日範囲/ソート
• タブ表示の表示/非表示: 新規課題タブ / PR一覧タブ
• アイコン表示の表示/非表示: MD（Markdown）/ Br（ブランチ）/ PR（プルリク）
• 課題詳細表示のデフォルト: WebView / Markdown
• 言語設定: UIの表示言語を日本語/英語から選択可能。Backlog APIの認証ユーザー情報に基づいて自動設定され、手動で変更した設定は永続化されます。

通知設定

• お知らせポーリング: ON/OFF、ポーリング間隔（10〜120分、デフォルト60分）。

セキュリティ (Security & Privacy)

• 機密情報の保護: APIキー/アクセストークンは、VS Codeの SecretStorage に暗号化保存されます。プレーンテキストファイルに平文保存しません。
• 通信: すべての通信は Backlog API (HTTPS) との間で直接行われます。外部の第三者サーバーを経由することはありません。

ヒント (Tips)

• AIとの連携: 「MD取得」で課題情報をMarkdown化し、AIチャットにペーストして文脈共有が可能。ツールタブの「課題一括取り込み」「課題分析」でAI用プロンプトを生成し、インポートやレポート作成を支援。
• フィルタの保存: 課題一覧タブで設定したフィルタ条件（担当者やステータス）は、タブを切り替えても保持されます。
• エディタパネル: コマンドパレットの「Backlog: エディタパネルで開く」から、エディタ領域で6タブ操作ができます。

⌨️ コマンド (Commands)

• Backlog: 課題からブランチを作成
• Backlog: プルリクエストを作成
• Backlog: エディタパネルで開く
• Backlog: 課題を一括取り込み
• Backlog: お知らせを表示
• 更新

参考資料 (References)

• Backlog API ドキュメント: https://developer.nulab.com/ja/docs/backlog/
  • 本拡張機能は Backlog API を使用して実装されています。

▼ English Version / Overview

Key Features

1. Task Management

• Issue List: Filter by Keyword, Assignee, Status, Milestone, Updated/Created Date Range, and Sort (paging: 30 items).
• View Issue Details: Click to show details in an editor tab (default: WebView or Markdown).
• Create Issue: Create issues from the "New Issue" tab (type, summary, assignee, etc.; optional auto-clear after create).
• Comments: Load 10 comments at a time; post new comments.
• Status Update: Update status from the issue detail view (with confirmation dialog).
• Markdown Output: Export issue list or details with statistics to Markdown (for AI chats or Wikis).
• List Actions: MD icons per row (visibility customizable).

2. Git Integration

• Smart Branch Creation: Create branches with issue key and prefix; base branch and auto-checkout supported.
• Commit Message Completion: Insert issue key from current branch name into SCM input.
• Branch Cleanup: List and bulk-delete local branches that no longer exist on the remote.

3. Pull Request Management

• PR List: Search by Open/Closed/Merged, Assignee, Creator, Related Issues; incremental loading.
• PR Details: View in editor panel, load comments, post comments.
• Create PR: Select branches, search/link issues, auto-complete title, assignee/notify users; optional auto-clear after create.

4. AI-Powered Features

• Bulk Issue Import: Parse .backlog/import/*.md and register issues in bulk; auto-generate AI prompts for creating import files.
• Issue Analysis: Generate AI prompts for quantitative analysis and risk detection; supports reports and slide outlines.

5. Intuitive UI & Settings

• 6 Tabs: Issue List, New Issue, PR List, Create PR, Settings, Tools (New Issue and PR List tabs can be hidden).
• Display Customization: Toggle tabs, filter fields, and icons (MD/Br/PR).
• Status Sync: Batch sync and cache Status, Issue Type, User, Priority, Milestone.
• Editor Panel: Open Backlog UI as an editor tab with SPA navigation and optional separate window.
• Notification Badge: Show unread count in the status bar; open list via Quick Pick and jump to issue/PR.
• VS Code Native: Follows VS Code design system; Dark Mode supported.
• Multi-language: Auto Japanese/English from Backlog API; manual override persisted.

Getting Started

1. Install the extension.
2. Click the Backlog icon in the Sidebar Activity Bar.
3. Open the "Settings" tab.
4. Enter the following in Backlog (Connection Settings) and save:

• Auth Method: API Key / Access Token
• API Key / Access Token: Value generated from your personal settings in Backlog.
• Space URL: Your Backlog Space URL (e.g., https://your-space.backlog.jp)
• Project Selection: Fetch project list → Select from dropdown (supports keyword filtering).
• Fetch Limit: Maximum number of items to fetch at once.
• API Cooldown: 3s / 5s / 10s / 30s

To get API key: Profile > API

5. If using Git/PR features, select (search for) your repository in Git (Git Integration Settings) and save.
6. Go to the "Tools" tab and execute "Sync" (Updates metadata required for issue creation and filtering).
7. Go to the "Issue List" tab and click the "Update" button to display issues.

Extension Settings

Settings are primarily managed via the Sidebar Settings Tab (Sensitive information is encrypted and stored in SecretStorage).

Backlog (Connection Settings)

• Auth Method: API Key / Access Token
• Backlog Space URL
• Project Selection
• Fetch Limit
• API Cooldown (Operation cool down time)

Git (Git Integration Settings)

• Branch Prefix: None / target / feature / bugfix
• Auto-insert issue key in commit message: ON/OFF
• Max branch name length
• Repository Selection: Search and select by name

Display Settings

• Toggle Search Items: Keyword / Assignee / Status / Milestone / Updated Date Range / Created Date Range / Sort
• Toggle Tab Display: New Issue Tab / PR List Tab
• Toggle Icon Display: MD / Br / PR
• Default Issue Detail View: WebView / Markdown
• Language: Japanese/English (auto from Backlog API; manual choice persisted).

Notification Settings

• Notification polling: ON/OFF; interval 10–120 min (default 60 min).

Security & Privacy

• Protection of Sensitive Information: API Keys and Access Tokens are encrypted and stored in VS Code's SecretStorage. They are never saved in plain text files.
• Communication: All communication is conducted directly with the Backlog API (HTTPS). No external third-party servers are involved.

Tips

• AI Integration: "Get MD" converts issues to Markdown for AI chats. Use "Bulk Import" and "Issue Analysis" in the Tools tab to generate AI prompts for import and reporting.
• Save Filters: Filter conditions in the Issue List tab are preserved when switching tabs.
• Editor Panel: "Backlog: Open in Editor Panel" opens the 6 tabs in the editor area.

⌨️ Commands

• Backlog: Create Branch from Issue
• Backlog: Create Pull Request
• Backlog: Open in Editor Panel
• Backlog: Bulk Import Issues
• Backlog: Show Notifications
• Update

References

• Backlog API Documentation: https://developer.nulab.com/docs/backlog/
• This extension is implemented using the Backlog API.

License

Copyright (c) 2024-2026 uzin-60123

All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.