Skip to content

v0.6.0

Choose a tag to compare

@ShuntaToda ShuntaToda released this 23 Jun 09:09
· 135 commits to main since this release

🎉 新機能

カスタム属性対応

課題エクスポート機能でBacklogのカスタム属性を出力できるようになりました。

  • テーブル形式で表示: カスタム属性はMarkdownテーブル形式で見やすく整理
  • 全ての値タイプに対応:
    • プリミティブ値(文字列、数値)
    • 配列値(複数選択、カンマ区切りで表示)
    • オブジェクト値(単一選択)
    • null/undefined値("なし"として表示)
  • 特殊文字の適切な処理:
    • 改行文字は
      タグに変換
    • パイプ文字は自動エスケープ

出力例

カスタム属性

属性名 値
工数(エンジニア) 3
担当チーム フロントエンド, バックエンド
工数詳細 実装内容
- 機能A
- 機能B

🔧 技術的改善

コード品質の向上

  • 関数の分離: カスタム属性処理を独立した関数に分離し、保守性を向上
  • 型安全性の強化: TypeScript型定義を拡張してカスタム属性フィールドに対応
  • JSDocの充実: 全ての公開関数にパラメータの詳細説明を追加
  • ESLint警告の解消: コード品質ツールの警告をすべて修正

テストカバレッジの拡大

  • 包括的なテストスイート: カスタム属性機能用に12個の新しいテストケースを追加
  • エッジケースの検証:
    • 空配列/undefined値の処理
    • 特殊文字(改行、パイプ文字)の適切な変換
    • 複数のカスタム属性の組み合わせ
    • 異なる値タイプの混在パターン

📚 ドキュメント更新

README.md の充実

  • カスタム属性機能の詳細説明を追加
  • 実際の出力例を含む使用方法の説明
  • 対応している値タイプの一覧
  • その他の特徴セクションにカスタム属性対応を追加

🔄 互換性情報

下位互換性

  • ✅ 既存機能への影響なし: 従来の課題エクスポート機能は変更なし
  • ✅ API互換性維持: 既存のコマンドラインオプションはすべて動作
  • ✅ 設定ファイル互換性: 既存のbacklog-settings.jsonは引き続き使用可能

要求環境

  • Node.js 16.0.0 以上
  • Backlog API v2 対応

📦 インストール・アップグレード

新規インストール

npm install -g backlog-exporter@0.6.0

既存環境からのアップグレード

npm update -g backlog-exporter

npxでの使用(インストール不要)

npx backlog-exporter@0.6.0 issue --domain example.backlog.jp --projectIdOrKey PROJECT_KEY

🚀 使用方法

カスタム属性は課題エクスポート時に自動的に含まれます。特別な設定は不要です。

基本的な使用方法(カスタム属性も自動的に出力される)

backlog-exporter issue --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY

一括エクスポートでもカスタム属性が含まれます

backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY

🐛 バグ修正

特に報告されたバグはありませんが、以下の潜在的な問題を予防的に修正:

  • ESLint設定による関数の複雑度制限への対応
  • 特殊文字を含むカスタム属性値の適切なエスケープ処理

📈 パフォーマンス

  • 処理速度: カスタム属性処理の追加による処理時間への影響は最小限
  • メモリ使用量: 追加のメモリ使用量は軽微
  • API呼び出し回数: 変更なし(既存のissue APIレスポンスを活用)

🙏 謝辞

この機能追加は、ユーザーからのBacklogカスタム属性対応の要望にお応えして実装されました。
フィードバックをお寄せいただいた皆様、ありがとうございました。

📞 サポート

問題が発生した場合は、以下のリポジトリでIssueを作成してください:
https://github.com/ShuntaToda/backlog-exporter/issues