backlog-exporter 0.5.1 → 0.6.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 ShuntaToda
+
+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.

package/README.md

@@ -15,6 +15,8 @@ Backlog のデータをエクスポートするためのコマンドラインツ
 * [Wikiのエクスポート](#wikiのエクスポート)
 * [ドキュメントのエクスポート](#ドキュメントのエクスポート)
 * [課題・Wiki・ドキュメントの一括エクスポート](#課題wikiドキュメントの一括エクスポート)
+* [特定のデータタイプのみをエクスポート（onlyフラグ）](#特定のデータタイプのみをエクスポートonlyフラグ)
+* [特定のデータタイプを除外してエクスポート（excludeフラグ）](#特定のデータタイプを除外してエクスポートexcludeフラグ)
 * [データの更新](#データの更新)
 * [npxを使った課題のエクスポート](#npxを使った課題のエクスポート)
 * [npxを使ったデータの更新](#npxを使ったデータの更新)
@@ -31,6 +33,12 @@ Backlog のデータをエクスポートするためのコマンドラインツ
 * [課題・Wiki・ドキュメント の一括エクスポート](#課題wikiドキュメント-の一括エクスポート)
 * [基本的な使用方法](#基本的な使用方法)
 * [出力先を指定](#出力先を指定)
+* [特定のデータタイプのみをエクスポート（onlyフラグ）](#特定のデータタイプのみをエクスポートonlyフラグ)
+* [特定のデータタイプを除外してエクスポート（excludeフラグ）](#特定のデータタイプを除外してエクスポートexcludeフラグ)
+* [課題とWikiのみをエクスポート](#課題とwikiのみをエクスポート)
+* [ドキュメントのみをエクスポート](#ドキュメントのみをエクスポート)
+* [ドキュメント以外（課題とWiki）をエクスポート](#ドキュメント以外課題とwikiをエクスポート)
+* [課題以外（WikiとDocuments）をエクスポート](#課題以外wikiとdocumentsをエクスポート)
 * [データの更新](#データの更新)
 * [カレントディレクトリとそのサブディレクトリのデータを更新](#カレントディレクトリとそのサブディレクトリのデータを更新)
 * [指定したディレクトリとそのサブディレクトリのデータを更新](#指定したディレクトリとそのサブディレクトリのデータを更新)
@@ -52,7 +60,7 @@ Backlog のデータをエクスポートするためのコマンドラインツ
 backlog-exporter は、Backlog のデータをローカルにエクスポートするためのコマンドラインツールです。
 現在、以下の機能をサポートしています：
 
-- **課題（Issue）のエクスポート**：Backlog の課題を Markdown ファイルとして保存
+- **課題（Issue）のエクスポート**：Backlog の課題を Markdown ファイルとして保存（カスタム属性対応）
 - **Wiki 記事のエクスポート**：Backlog の Wiki 記事を Markdown ファイルとして保存
 - **ドキュメントのエクスポート**：Backlog のドキュメントを Markdown ファイルとして保存
 - **一括エクスポート**：課題・Wiki・ドキュメントを同時に取得する機能
@@ -66,7 +74,7 @@ $ npm install -g backlog-exporter
 $ backlog-exporter COMMAND
 running command...
 $ backlog-exporter (--version)
-backlog-exporter/0.5.1 linux-x64 node-v24.2.0
+backlog-exporter/0.6.1 linux-x64 node-v24.3.0
 $ backlog-exporter --help [COMMAND]
 USAGE
   $ backlog-exporter COMMAND
@@ -99,6 +107,12 @@ $ backlog-exporter document --domain example.backlog.jp --projectIdOrKey PROJECT
 # 課題・Wiki・ドキュメントの一括エクスポート
 $ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --output ./backlog-data
 
+# 特定のデータタイプのみをエクスポート（onlyフラグ）
+$ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --only issues,wiki
+
+# 特定のデータタイプを除外してエクスポート（excludeフラグ）
+$ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --exclude documents
+
 # データの更新
 $ backlog-exporter update
 ```
@@ -127,6 +141,28 @@ $ backlog-exporter issue --domain example.backlog.jp --projectIdOrKey PROJECT_KE
 
 エクスポートされた課題は、指定したディレクトリ内に Markdown ファイルとして保存されます。ファイル名は課題のキーに基づいて自動的に生成されます。
 
+## カスタム属性の対応
+
+課題のエクスポートでは、Backlogのカスタム属性も含めて出力されます：
+
+### 対応している値の型
+- **プリミティブ値**: 文字列、数値などの単純な値
+- **配列値**: 複数選択のカスタム属性（カンマ区切りで表示）
+- **オブジェクト値**: 単一選択のカスタム属性（name または value プロパティを使用）
+
+### 表示形式
+カスタム属性はMarkdownテーブル形式で表示され、改行やパイプ文字も適切に処理されます：
+
+```markdown
+## カスタム属性
+
+| 属性名 | 値 |
+|--------|----| 
+| 工数（エンジニア） | 3 |
+| 担当チーム | フロントエンド, バックエンド |
+| 詳細 | 実装内容<br>- 機能A<br>- 機能B |
+```
+
 # Wiki のエクスポート
 
 `wiki`コマンドを使用すると、Backlog の Wiki ページを Markdown ファイルとしてエクスポートできます。
@@ -198,10 +234,44 @@ $ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY
 
 # 出力先を指定
 $ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --output ./backlog-data
+
+# 特定のデータタイプのみをエクスポート（onlyフラグ）
+$ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --only issues,wiki
+
+# 特定のデータタイプを除外してエクスポート（excludeフラグ）
+$ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --exclude documents
 ```
 
 一括エクスポートでは、課題は`issues`ディレクトリに、Wiki は`wiki`ディレクトリに、ドキュメントは`documents`ディレクトリに保存されます。
 
+## エクスポート対象の制御
+
+`all`コマンドでは、以下のフラグを使用してエクスポート対象を制御できます：
+
+### --only フラグ
+特定のデータタイプのみをエクスポートします。カンマ区切りで複数指定可能です。
+
+```sh
+# 課題とWikiのみをエクスポート
+$ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --only issues,wiki
+
+# ドキュメントのみをエクスポート
+$ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --only documents
+```
+
+### --exclude フラグ
+特定のデータタイプを除外してエクスポートします。カンマ区切りで複数指定可能です。
+
+```sh
+# ドキュメント以外（課題とWiki）をエクスポート
+$ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --exclude documents
+
+# 課題以外（WikiとDocuments）をエクスポート
+$ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --exclude issues
+```
+
+**注意**: `--only`と`--exclude`フラグは同時に使用できません。どちらか一方を使用してください。
+
 # データの更新
 
 `update`コマンドを使用すると、既存のエクスポートデータを最新の状態に更新できます。このコマンドは、ディレクトリ内の`backlog-settings.json`ファイルを探索し、見つかったディレクトリでデータを更新します。
@@ -257,14 +327,16 @@ Backlogから課題・Wiki・ドキュメントを取得してMarkdownファイ
 
 ```
 USAGE
-  $ backlog-exporter all --domain <value> --projectIdOrKey <value> [--apiKey <value>] [-m <value>] [-o
-    <value>]
+  $ backlog-exporter all --domain <value> --projectIdOrKey <value> [--apiKey <value>] [--exclude <value>]
+    [-m <value>] [--only <value>] [-o <value>]
 
 FLAGS
   -m, --maxCount=<value>        [default: 5000] 一度に取得する課題の最大数（デフォルト: 5000）
   -o, --output=<value>          出力ディレクトリパス
       --apiKey=<value>          Backlog API key (環境変数 BACKLOG_API_KEY からも自動読み取り可能)
       --domain=<value>          (required) Backlog domain (e.g. example.backlog.jp)
+      --exclude=<value>         Exclude the specified types, separated by commas (e.g., 'documents,wiki')
+      --only=<value>            Export only the specified types, separated by commas (e.g., 'issues,wiki')
       --projectIdOrKey=<value>  (required) Backlog project ID or key
 
 DESCRIPTION
@@ -277,11 +349,17 @@ EXAMPLES
   $ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --output ./my-project
   指定したディレクトリに課題・Wiki・ドキュメントを保存する
 
+  $ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --only issues,wiki
+  課題とWikiのみを取得する
+
+  $ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --exclude documents
+  ドキュメント以外（課題とWiki）を取得する
+
   $ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --maxCount 1000
   最大1000件の課題を取得する（デフォルトは5000件）
 ```
 
-_See code: [src/commands/all/index.ts](https://github.com/ShuntaToda/backlog-exporter/blob/v0.5.1/src/commands/all/index.ts)_
+_See code: [src/commands/all/index.ts](https://github.com/ShuntaToda/backlog-exporter/blob/v0.6.1/src/commands/all/index.ts)_
 
 ## `backlog-exporter document`
 
@@ -313,7 +391,7 @@ EXAMPLES
   キーワード「仕様書」を含むドキュメントのみを取得する
 ```
 
-_See code: [src/commands/document/index.ts](https://github.com/ShuntaToda/backlog-exporter/blob/v0.5.1/src/commands/document/index.ts)_
+_See code: [src/commands/document/index.ts](https://github.com/ShuntaToda/backlog-exporter/blob/v0.6.1/src/commands/document/index.ts)_
 
 ## `backlog-exporter help [COMMAND]`
 
@@ -369,7 +447,7 @@ EXAMPLES
   最大10000件の課題を取得する（デフォルトは5000件）
 ```
 
-_See code: [src/commands/issue/index.ts](https://github.com/ShuntaToda/backlog-exporter/blob/v0.5.1/src/commands/issue/index.ts)_
+_See code: [src/commands/issue/index.ts](https://github.com/ShuntaToda/backlog-exporter/blob/v0.6.1/src/commands/issue/index.ts)_
 
 ## `backlog-exporter plugins`
 
@@ -699,7 +777,7 @@ EXAMPLES
   指定したディレクトリの設定を使用して更新する
 ```
 
-_See code: [src/commands/update/index.ts](https://github.com/ShuntaToda/backlog-exporter/blob/v0.5.1/src/commands/update/index.ts)_
+_See code: [src/commands/update/index.ts](https://github.com/ShuntaToda/backlog-exporter/blob/v0.6.1/src/commands/update/index.ts)_
 
 ## `backlog-exporter wiki`
 
@@ -726,7 +804,7 @@ EXAMPLES
   指定したディレクトリにWikiを保存する
 ```
 
-_See code: [src/commands/wiki/index.ts](https://github.com/ShuntaToda/backlog-exporter/blob/v0.5.1/src/commands/wiki/index.ts)_
+_See code: [src/commands/wiki/index.ts](https://github.com/ShuntaToda/backlog-exporter/blob/v0.6.1/src/commands/wiki/index.ts)_
 <!-- commandsstop -->
 
 # 出力形式
@@ -748,6 +826,15 @@ _See code: [src/commands/wiki/index.ts](https://github.com/ShuntaToda/backlog-ex
 - 更新日時: 2023/01/02 15:30:45
 - [Backlog Issue Link](https://example.backlog.jp/view/PROJ-123)
 
+## カスタム属性
+
+| 属性名 | 値 |
+|--------|----| 
+| 工数（エンジニア） | 3 |
+| 工数（PPO） | なし |
+| 担当チーム | フロントエンド, バックエンド |
+| 詳細 | 実装内容<br>- 機能A<br>- 機能B |
+
 ## 詳細
 
 ここに課題の詳細説明が入ります。
@@ -822,3 +909,4 @@ Backlog の書式がそのまま保持されます。
 - **階層構造の保持**: Wiki の階層構造を保持したエクスポート
 - **キーワード検索**: ドキュメントの検索キーワード対応
 - **差分更新**: 前回の更新以降に変更されたデータのみを更新
+- **カスタム属性対応**: 課題のカスタム属性をテーブル形式で表示（配列・オブジェクト・プリミティブ値に対応）

package/dist/commands/all/index.d.ts

@@ -5,7 +5,9 @@ export default class All extends Command {
     static flags: {
         apiKey: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         domain: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        exclude: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         maxCount: import("@oclif/core/interfaces").OptionFlag<number, import("@oclif/core/interfaces").CustomOptions>;
+        only: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         output: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         projectIdOrKey: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
     };

package/dist/commands/all/index.js

@@ -15,6 +15,12 @@ export default class All extends Command {
 `,
         `<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --output ./my-project
 指定したディレクトリに課題・Wiki・ドキュメントを保存する
+`,
+        `<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --only issues,wiki
+課題とWikiのみを取得する
+`,
+        `<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --exclude documents
+ドキュメント以外（課題とWiki）を取得する
 `,
         `<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --maxCount 1000
 最大1000件の課題を取得する（デフォルトは5000件）
@@ -29,12 +35,20 @@ export default class All extends Command {
             description: 'Backlog domain (e.g. example.backlog.jp)',
             required: true,
         }),
+        exclude: Flags.string({
+            description: "Exclude the specified types, separated by commas (e.g., 'documents,wiki')",
+            required: false,
+        }),
         maxCount: Flags.integer({
             char: 'm',
             default: 5000,
             description: '一度に取得する課題の最大数（デフォルト: 5000）',
             required: false,
         }),
+        only: Flags.string({
+            description: "Export only the specified types, separated by commas (e.g., 'issues,wiki')",
+            required: false,
+        }),
         output: Flags.string({
             char: 'o',
             description: '出力ディレクトリパス',
@@ -48,88 +62,123 @@ export default class All extends Command {
     async run() {
         const { flags } = await this.parse(All);
         try {
-            const { domain, maxCount, projectIdOrKey } = flags;
+            const { domain, exclude, maxCount, only, projectIdOrKey } = flags;
             const apiKey = flags.apiKey || getApiKey(this);
             const outputRoot = flags.output || './backlog-data';
+            // Check for conflicting flags
+            if (only && exclude) {
+                this.error('Cannot use both --only and --exclude flags together. Please use only one.');
+            }
+            // Determine targets based on flags
+            let targets;
+            if (only) {
+                targets = only.split(',');
+            }
+            else if (exclude) {
+                const excludeTargets = exclude.split(',');
+                const allTargets = ['issues', 'wiki', 'documents'];
+                targets = allTargets.filter(target => !excludeTargets.includes(target));
+            }
+            else {
+                targets = ['issues', 'wiki', 'documents'];
+            }
+            // Validate targets
+            const validTargets = ['issues', 'wiki', 'documents'];
+            const inputTargets = only ? only.split(',') : exclude ? exclude.split(',') : [];
+            for (const target of inputTargets) {
+                if (!validTargets.includes(target)) {
+                    this.error(`Invalid target '${target}'. Available targets are: ${validTargets.join(', ')}`);
+                }
+            }
+            // Check if any targets remain after exclusion
+            if (targets.length === 0) {
+                this.error('No targets remaining after exclusion. Please specify valid targets to export.');
+            }
             // 出力ディレクトリの作成
             await createOutputDirectory(outputRoot);
             // プロジェクトキーからプロジェクトIDを取得
             const projectId = await validateAndGetProjectId(domain, projectIdOrKey, apiKey);
             this.log(`プロジェクトID: ${projectId} を使用します`);
-            // 課題の出力ディレクトリ
-            const issueOutput = path.join(outputRoot, 'issues');
-            await createOutputDirectory(issueOutput);
-            // Wikiの出力ディレクトリ
-            const wikiOutput = path.join(outputRoot, 'wiki');
-            await createOutputDirectory(wikiOutput);
-            // ドキュメントの出力ディレクトリ
-            const documentOutput = path.join(outputRoot, 'documents');
-            await createOutputDirectory(documentOutput);
-            // 課題フォルダに設定ファイルを保存
-            await updateSettings(issueOutput, {
-                apiKey,
-                domain,
-                folderType: FolderType.ISSUE,
-                outputDir: issueOutput,
-                projectIdOrKey,
-            });
-            // Wikiフォルダに設定ファイルを保存
-            await updateSettings(wikiOutput, {
-                apiKey,
-                domain,
-                folderType: FolderType.WIKI,
-                outputDir: wikiOutput,
-                projectIdOrKey,
-            });
-            // ドキュメントフォルダに設定ファイルを保存
-            await updateSettings(documentOutput, {
-                apiKey,
-                domain,
-                folderType: FolderType.DOCUMENT,
-                outputDir: documentOutput,
-                projectIdOrKey,
-            });
-            // 課題の取得と保存
-            this.log('課題の取得を開始します...');
-            await downloadIssues(this, {
-                apiKey,
-                count: maxCount,
-                domain,
-                outputDir: issueOutput,
-                projectId,
-            });
-            // 課題フォルダの最終更新日時を更新
-            await updateSettings(issueOutput, {
-                lastUpdated: new Date().toISOString(),
-            });
-            this.log('課題の取得が完了しました');
-            // Wikiの取得と保存
-            this.log('Wikiの取得を開始します...');
-            await downloadWikis(this, {
-                apiKey,
-                domain,
-                outputDir: wikiOutput,
-                projectIdOrKey,
-            });
-            // Wikiフォルダの最終更新日時を更新
-            await updateSettings(wikiOutput, {
-                lastUpdated: new Date().toISOString(),
-            });
-            this.log('Wikiの取得が完了しました');
-            // ドキュメントの取得と保存
-            this.log('ドキュメントの取得を開始します...');
-            await downloadDocuments(this, {
-                apiKey,
-                domain,
-                outputDir: documentOutput,
-                projectId,
-                projectIdOrKey,
-            });
-            // ドキュメントフォルダの最終更新日時を更新
-            await updateSettings(documentOutput, {
-                lastUpdated: new Date().toISOString(),
-            });
-            this.log('ドキュメントの取得が完了しました');
+            if (targets.includes('issues')) {
+                // 課題の出力ディレクトリ
+                const issueOutput = path.join(outputRoot, 'issues');
+                await createOutputDirectory(issueOutput);
+                // 課題フォルダに設定ファイルを保存
+                await updateSettings(issueOutput, {
+                    apiKey,
+                    domain,
+                    folderType: FolderType.ISSUE,
+                    outputDir: issueOutput,
+                    projectIdOrKey,
+                });
+                // 課題の取得と保存
+                this.log('課題の取得を開始します...');
+                await downloadIssues(this, {
+                    apiKey,
+                    count: maxCount,
+                    domain,
+                    outputDir: issueOutput,
+                    projectId,
+                });
+                // 課題フォルダの最終更新日時を更新
+                await updateSettings(issueOutput, {
+                    lastUpdated: new Date().toISOString(),
+                });
+                this.log('課題の取得が完了しました');
+            }
+            if (targets.includes('wiki')) {
+                // Wikiの出力ディレクトリ
+                const wikiOutput = path.join(outputRoot, 'wiki');
+                await createOutputDirectory(wikiOutput);
+                // Wikiフォルダに設定ファイルを保存
+                await updateSettings(wikiOutput, {
+                    apiKey,
+                    domain,
+                    folderType: FolderType.WIKI,
+                    outputDir: wikiOutput,
+                    projectIdOrKey,
+                });
+                // Wikiの取得と保存
+                this.log('Wikiの取得を開始します...');
+                await downloadWikis(this, {
+                    apiKey,
+                    domain,
+                    outputDir: wikiOutput,
+                    projectIdOrKey,
+                });
+                // Wikiフォルダの最終更新日時を更新
+                await updateSettings(wikiOutput, {
+                    lastUpdated: new Date().toISOString(),
+                });
+                this.log('Wikiの取得が完了しました');
+            }
+            if (targets.includes('documents')) {
+                // ドキュメントの出力ディレクトリ
+                const documentOutput = path.join(outputRoot, 'documents');
+                await createOutputDirectory(documentOutput);
+                // ドキュメントフォルダに設定ファイルを保存
+                await updateSettings(documentOutput, {
+                    apiKey,
+                    domain,
+                    folderType: FolderType.DOCUMENT,
+                    outputDir: documentOutput,
+                    projectIdOrKey,
+                });
+                // ドキュメントの取得と保存
+                this.log('ドキュメントの取得を開始します...');
+                await downloadDocuments(this, {
+                    apiKey,
+                    domain,
+                    outputDir: documentOutput,
+                    projectId,
+                    projectIdOrKey,
+                });
+                // ドキュメントフォルダの最終更新日時を更新
+                await updateSettings(documentOutput, {
+                    lastUpdated: new Date().toISOString(),
+                });
+                this.log('ドキュメントの取得が完了しました');
+            }
             this.log('すべてのデータの取得が完了しました！');
         }
         catch (error) {

package/dist/utils/backlog-api.d.ts

@@ -1,8 +1,25 @@
 import { Command } from '@oclif/core';
+/**
+ * カスタム属性セクションを作成する
+ * @param customFields カスタム属性の配列
+ * @returns Markdownテーブル形式のカスタム属性セクション
+ */
+export declare function createCustomFieldsSection(customFields?: Array<{
+    id: number;
+    name: string;
+    value: unknown;
+}>): string;
 /**
  * Backlogから課題をダウンロードする
  * @param command コマンドインスタンス
  * @param options 課題ダウンロードのオプション
+ * @param options.apiKey Backlog API key
+ * @param options.count 取得する課題の最大数
+ * @param options.domain Backlogのドメイン
+ * @param options.lastUpdated 最終更新日時
+ * @param options.outputDir 出力ディレクトリ
+ * @param options.projectId プロジェクトID
+ * @param options.statusId ステータスID
  */
 export declare function downloadIssues(command: Command, options: {
     apiKey: string;
@@ -17,6 +34,11 @@ export declare function downloadIssues(command: Command, options: {
  * BacklogからWikiをダウンロードする
  * @param command コマンドインスタンス
  * @param options Wikiダウンロードのオプション
+ * @param options.apiKey Backlog API key
+ * @param options.domain Backlogのドメイン
+ * @param options.lastUpdated 最終更新日時
+ * @param options.outputDir 出力ディレクトリ
+ * @param options.projectIdOrKey プロジェクトIDまたはキー
  */
 export declare function downloadWikis(command: Command, options: {
     apiKey: string;
@@ -29,6 +51,13 @@ export declare function downloadWikis(command: Command, options: {
  * Backlogからドキュメントをダウンロードする
  * @param command コマンドインスタンス
  * @param options ドキュメントダウンロードのオプション
+ * @param options.apiKey Backlog API key
+ * @param options.domain Backlogのドメイン
+ * @param options.keyword キーワードフィルター
+ * @param options.lastUpdated 最終更新日時
+ * @param options.outputDir 出力ディレクトリ
+ * @param options.projectId プロジェクトID
+ * @param options.projectIdOrKey プロジェクトIDまたはキー
  */
 export declare function downloadDocuments(command: Command, options: {
     apiKey: string;

package/dist/utils/backlog-api.js

@@ -5,10 +5,54 @@ import process from 'node:process';
 import { sanitizeFileName, sanitizeWikiFileName } from './common.js';
 import { appendLog } from './log.js';
 import { RateLimiter } from './sleep.js';
+/**
+ * カスタム属性セクションを作成する
+ * @param customFields カスタム属性の配列
+ * @returns Markdownテーブル形式のカスタム属性セクション
+ */
+export function createCustomFieldsSection(customFields) {
+    if (!customFields || customFields.length === 0) {
+        return '';
+    }
+    let customFieldsSection = '\n\n## カスタム属性\n\n| 属性名 | 値 |\n|--------|----|\n';
+    for (const customField of customFields) {
+        let fieldValue = 'なし';
+        if (customField.value !== null && customField.value !== undefined) {
+            if (Array.isArray(customField.value)) {
+                // 配列の場合（複数選択など）
+                fieldValue = customField.value
+                    .map(item => item.name || item.value || String(item))
+                    .join(', ');
+            }
+            else if (typeof customField.value === 'object' && customField.value !== null) {
+                // オブジェクトの場合（単一選択など）
+                const valueObj = customField.value;
+                fieldValue = valueObj.name || valueObj.value || String(customField.value);
+            }
+            else {
+                // プリミティブ値の場合
+                fieldValue = String(customField.value);
+            }
+        }
+        // テーブル内では改行をHTMLの<br>タグに変換し、パイプ文字をエスケープ
+        const escapedFieldValue = fieldValue
+            .replaceAll('|', String.raw `\|`)
+            .replaceAll('\n', '<br>');
+        customFieldsSection += `| ${customField.name} | ${escapedFieldValue} |\n`;
+    }
+    return customFieldsSection;
+}
 /**
  * Backlogから課題をダウンロードする
  * @param command コマンドインスタンス
  * @param options 課題ダウンロードのオプション
+ * @param options.apiKey Backlog API key
+ * @param options.count 取得する課題の最大数
+ * @param options.domain Backlogのドメイン
+ * @param options.lastUpdated 最終更新日時
+ * @param options.outputDir 出力ディレクトリ
+ * @param options.projectId プロジェクトID
+ * @param options.statusId ステータスID
  */
 export async function downloadIssues(command, options) {
     const baseUrl = `https://${options.domain}/api/v2`;
@@ -114,6 +158,8 @@ export async function downloadIssues(command, options) {
             // 年ごとのフォルダ内にMarkdownファイルを保存
             const issueFileName = `${sanitizeFileName(issue.summary)}.md`;
             const issueFilePath = path.join(yearDirPath, issueFileName);
+            // カスタム属性セクションを作成
+            const customFieldsSection = createCustomFieldsSection(issue.customFields);
             // Markdownファイルに書き込む
             const assigneeName = issue.assignee ? issue.assignee.name : '未割り当て';
             const markdownContent = `# ${issue.summary}
@@ -125,7 +171,7 @@ export async function downloadIssues(command, options) {
 - 担当者: ${assigneeName}
 - 作成日時: ${new Date(issue.created).toLocaleString('ja-JP')}
 - 更新日時: ${new Date(issue.updated).toLocaleString('ja-JP')}
-- [Backlog Issue Link](${backlogIssueUrl})
+- [Backlog Issue Link](${backlogIssueUrl})${customFieldsSection}
 
 ## 詳細
 ${issue.description || '詳細情報なし'}${commentsSection}`;
@@ -176,6 +222,11 @@ async function fetchAllCommentsForIssue({ apiKey, baseUrl, command, issueKey, ra
  * BacklogからWikiをダウンロードする
  * @param command コマンドインスタンス
  * @param options Wikiダウンロードのオプション
+ * @param options.apiKey Backlog API key
+ * @param options.domain Backlogのドメイン
+ * @param options.lastUpdated 最終更新日時
+ * @param options.outputDir 出力ディレクトリ
+ * @param options.projectIdOrKey プロジェクトIDまたはキー
  */
 export async function downloadWikis(command, options) {
     const baseUrl = `https://${options.domain}/api/v2`;
@@ -259,6 +310,13 @@ export async function downloadWikis(command, options) {
  * Backlogからドキュメントをダウンロードする
  * @param command コマンドインスタンス
  * @param options ドキュメントダウンロードのオプション
+ * @param options.apiKey Backlog API key
+ * @param options.domain Backlogのドメイン
+ * @param options.keyword キーワードフィルター
+ * @param options.lastUpdated 最終更新日時
+ * @param options.outputDir 出力ディレクトリ
+ * @param options.projectId プロジェクトID
+ * @param options.projectIdOrKey プロジェクトIDまたはキー
  */
 export async function downloadDocuments(command, options) {
     const baseUrl = `https://${options.domain}/api/v2`;

package/oclif.manifest.json

@@ -7,6 +7,8 @@
       "examples": [
         "<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY\n課題・Wiki・ドキュメントをMarkdownファイルとして保存する\n",
         "<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --output ./my-project\n指定したディレクトリに課題・Wiki・ドキュメントを保存する\n",
+        "<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --only issues,wiki\n課題とWikiのみを取得する\n",
+        "<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --exclude documents\nドキュメント以外（課題とWiki）を取得する\n",
         "<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --maxCount 1000\n最大1000件の課題を取得する（デフォルトは5000件）\n"
       ],
       "flags": {
@@ -26,6 +28,14 @@
           "multiple": false,
           "type": "option"
         },
+        "exclude": {
+          "description": "Exclude the specified types, separated by commas (e.g., 'documents,wiki')",
+          "name": "exclude",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
         "maxCount": {
           "char": "m",
           "description": "一度に取得する課題の最大数（デフォルト: 5000）",
@@ -36,6 +46,14 @@
           "multiple": false,
           "type": "option"
         },
+        "only": {
+          "description": "Export only the specified types, separated by commas (e.g., 'issues,wiki')",
+          "name": "only",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
         "output": {
           "char": "o",
           "description": "出力ディレクトリパス",
@@ -70,15 +88,14 @@
         "index.js"
       ]
     },
-    "issue": {
+    "document": {
       "aliases": [],
       "args": {},
-      "description": "Backlogから課題を取得してMarkdownファイルとして保存する",
+      "description": "Backlogからドキュメントを取得してMarkdownファイルとして保存する",
       "examples": [
-        "<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY\n課題をMarkdownファイルとして保存する\n",
-        "<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --output ./my-issues\n指定したディレクトリに課題を保存する\n",
-        "<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --statusId 1,2,3\n指定したステータスIDの課題のみを取得する\n",
-        "<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --maxCount 10000\n最大10000件の課題を取得する（デフォルトは5000件）\n"
+        "<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY\nドキュメントをMarkdownファイルとして保存する\n",
+        "<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --output ./my-documents\n指定したディレクトリにドキュメントを保存する\n",
+        "<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --keyword 仕様書\nキーワード「仕様書」を含むドキュメントのみを取得する\n"
       ],
       "flags": {
         "apiKey": {
@@ -97,12 +114,10 @@
           "multiple": false,
           "type": "option"
         },
-        "maxCount": {
-          "char": "m",
-          "description": "一度に取得する課題の最大数（デフォルト: 5000）",
-          "name": "maxCount",
+        "keyword": {
+          "description": "検索キーワード",
+          "name": "keyword",
           "required": false,
-          "default": 5000,
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
@@ -123,19 +138,11 @@
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
-        },
-        "statusId": {
-          "description": "ステータスID（カンマ区切りで複数指定可能）",
-          "name": "statusId",
-          "required": false,
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
         }
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "issue",
+      "id": "document",
       "pluginAlias": "backlog-exporter",
       "pluginName": "backlog-exporter",
       "pluginType": "core",
@@ -145,18 +152,19 @@
       "relativePath": [
         "dist",
         "commands",
-        "issue",
+        "document",
         "index.js"
       ]
     },
-    "document": {
+    "issue": {
       "aliases": [],
       "args": {},
-      "description": "Backlogからドキュメントを取得してMarkdownファイルとして保存する",
+      "description": "Backlogから課題を取得してMarkdownファイルとして保存する",
       "examples": [
-        "<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY\nドキュメントをMarkdownファイルとして保存する\n",
-        "<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --output ./my-documents\n指定したディレクトリにドキュメントを保存する\n",
-        "<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --keyword 仕様書\nキーワード「仕様書」を含むドキュメントのみを取得する\n"
+        "<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY\n課題をMarkdownファイルとして保存する\n",
+        "<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --output ./my-issues\n指定したディレクトリに課題を保存する\n",
+        "<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --statusId 1,2,3\n指定したステータスIDの課題のみを取得する\n",
+        "<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --maxCount 10000\n最大10000件の課題を取得する（デフォルトは5000件）\n"
       ],
       "flags": {
         "apiKey": {
@@ -175,10 +183,12 @@
           "multiple": false,
           "type": "option"
         },
-        "keyword": {
-          "description": "検索キーワード",
-          "name": "keyword",
+        "maxCount": {
+          "char": "m",
+          "description": "一度に取得する課題の最大数（デフォルト: 5000）",
+          "name": "maxCount",
           "required": false,
+          "default": 5000,
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
@@ -199,11 +209,19 @@
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
+        },
+        "statusId": {
+          "description": "ステータスID（カンマ区切りで複数指定可能）",
+          "name": "statusId",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
         }
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "document",
+      "id": "issue",
       "pluginAlias": "backlog-exporter",
       "pluginName": "backlog-exporter",
       "pluginType": "core",
@@ -213,7 +231,7 @@
       "relativePath": [
         "dist",
         "commands",
-        "document",
+        "issue",
         "index.js"
       ]
     },
@@ -364,5 +382,5 @@
       ]
     }
   },
-  "version": "0.5.1"
+  "version": "0.6.1"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "backlog-exporter",
   "description": "A new CLI generated with oclif",
-  "version": "0.5.1",
+  "version": "0.6.1",
   "author": "ShuntaToda",
   "bin": {
     "backlog-exporter": "bin/run.js"