backlog-exporter 0.6.1 → 0.7.1

package/README.md

@@ -23,6 +23,9 @@ Backlog のデータをエクスポートするためのコマンドラインツ
 * [課題のエクスポート](#課題のエクスポート)
 * [基本的な使用方法](#基本的な使用方法)
 * [出力先を指定](#出力先を指定)
+* [Markdownファイル名を課題キーにする](#markdownファイル名を課題キーにする)
+* [課題キーでフォルダを作成する](#課題キーでフォルダを作成する)
+* [課題キーでフォルダを作成し、Markdownファイル名も課題キーにする](#課題キーでフォルダを作成しmarkdownファイル名も課題キーにする)
 * [Wiki のエクスポート](#wiki-のエクスポート)
 * [基本的な使用方法](#基本的な使用方法)
 * [出力先を指定](#出力先を指定)
@@ -74,7 +77,7 @@ $ npm install -g backlog-exporter
 $ backlog-exporter COMMAND
 running command...
 $ backlog-exporter (--version)
-backlog-exporter/0.6.1 linux-x64 node-v24.3.0
+backlog-exporter/0.7.1 linux-x64 node-v24.4.1
 $ backlog-exporter --help [COMMAND]
 USAGE
   $ backlog-exporter COMMAND
@@ -137,6 +140,15 @@ $ backlog-exporter issue --domain example.backlog.jp --projectIdOrKey PROJECT_KE
 
 # 出力先を指定
 $ backlog-exporter issue --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --output ./issues
+
+# Markdownファイル名を課題キーにする
+$ backlog-exporter issue --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --issueKeyFileName
+
+# 課題キーでフォルダを作成する
+$ backlog-exporter issue --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --issueKeyFolder
+
+# 課題キーでフォルダを作成し、Markdownファイル名も課題キーにする
+$ backlog-exporter issue --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --issueKeyFileName --issueKeyFolder
 ```
 
 エクスポートされた課題は、指定したディレクトリ内に Markdown ファイルとして保存されます。ファイル名は課題のキーに基づいて自動的に生成されます。
@@ -146,21 +158,23 @@ $ backlog-exporter issue --domain example.backlog.jp --projectIdOrKey PROJECT_KE
 課題のエクスポートでは、Backlogのカスタム属性も含めて出力されます：
 
 ### 対応している値の型
+
 - **プリミティブ値**: 文字列、数値などの単純な値
 - **配列値**: 複数選択のカスタム属性（カンマ区切りで表示）
 - **オブジェクト値**: 単一選択のカスタム属性（name または value プロパティを使用）
 
 ### 表示形式
+
 カスタム属性はMarkdownテーブル形式で表示され、改行やパイプ文字も適切に処理されます：
 
 ```markdown
 ## カスタム属性
 
-| 属性名 | 値 |
-|--------|----| 
-| 工数（エンジニア） | 3 |
-| 担当チーム | フロントエンド, バックエンド |
-| 詳細 | 実装内容<br>- 機能A<br>- 機能B |
+| 属性名             | 値                             |
+| ------------------ | ------------------------------ |
+| 工数（エンジニア） | 3                              |
+| 担当チーム         | フロントエンド, バックエンド   |
+| 詳細               | 実装内容<br>- 機能A<br>- 機能B |
 ```
 
 # Wiki のエクスポート
@@ -197,10 +211,12 @@ $ backlog-exporter document --domain example.backlog.jp --projectIdOrKey PROJECT
 ドキュメントは **ツリー構造を保持** してエクスポートされます：
 
 ### ディレクトリ構造の保持
+
 - Backlogのドキュメントツリーの階層構造がそのままローカルディレクトリ構造として再現されます
 - フォルダはディレクトリとして作成され、ドキュメントはMarkdownファイルとして保存されます
 
 ### 出力例
+
 ```
 documents/
 ├── プロジェクト概要/
@@ -217,6 +233,7 @@ documents/
 ```
 
 ### 特徴
+
 - **階層構造の完全再現**: Backlogのフォルダ階層がそのまま保持されます
 - **重複処理の防止**: 同じドキュメントが複数回処理されることを防ぎます
 - **ファイル名の自動サニタイズ**: 不正な文字を自動的に除去して安全なファイル名を生成します
@@ -249,6 +266,7 @@ $ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY
 `all`コマンドでは、以下のフラグを使用してエクスポート対象を制御できます：
 
 ### --only フラグ
+
 特定のデータタイプのみをエクスポートします。カンマ区切りで複数指定可能です。
 
 ```sh
@@ -260,6 +278,7 @@ $ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY
 ```
 
 ### --exclude フラグ
+
 特定のデータタイプを除外してエクスポートします。カンマ区切りで複数指定可能です。
 
 ```sh
@@ -328,7 +347,7 @@ Backlogから課題・Wiki・ドキュメントを取得してMarkdownファイ
 ```
 USAGE
   $ backlog-exporter all --domain <value> --projectIdOrKey <value> [--apiKey <value>] [--exclude <value>]
-    [-m <value>] [--only <value>] [-o <value>]
+    [--issueKeyFileName] [--issueKeyFolder] [-m <value>] [--only <value>] [-o <value>]
 
 FLAGS
   -m, --maxCount=<value>        [default: 5000] 一度に取得する課題の最大数（デフォルト: 5000）
@@ -336,6 +355,8 @@ FLAGS
       --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')
+      --issueKeyFileName        ファイル名を課題キーにする
+      --issueKeyFolder          課題キーでフォルダを作成する
       --only=<value>            Export only the specified types, separated by commas (e.g., 'issues,wiki')
       --projectIdOrKey=<value>  (required) Backlog project ID or key
 
@@ -357,9 +378,18 @@ EXAMPLES
 
   $ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --maxCount 1000
   最大1000件の課題を取得する（デフォルトは5000件）
+
+  $ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --issueKeyFileName
+  ファイル名を課題キーにする
+
+  $ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --issueKeyFolder
+  課題キーでフォルダを作成する
+
+  $ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --issueKeyFileName --issueKeyFolder
+  課題キーでフォルダを作成し、ファイル名も課題キーにする
 ```
 
-_See code: [src/commands/all/index.ts](https://github.com/ShuntaToda/backlog-exporter/blob/v0.6.1/src/commands/all/index.ts)_
+_See code: [src/commands/all/index.ts](https://github.com/ShuntaToda/backlog-exporter/blob/v0.7.1/src/commands/all/index.ts)_
 
 ## `backlog-exporter document`
 
@@ -391,7 +421,7 @@ EXAMPLES
   キーワード「仕様書」を含むドキュメントのみを取得する
 ```
 
-_See code: [src/commands/document/index.ts](https://github.com/ShuntaToda/backlog-exporter/blob/v0.6.1/src/commands/document/index.ts)_
+_See code: [src/commands/document/index.ts](https://github.com/ShuntaToda/backlog-exporter/blob/v0.7.1/src/commands/document/index.ts)_
 
 ## `backlog-exporter help [COMMAND]`
 
@@ -419,14 +449,16 @@ Backlogから課題を取得してMarkdownファイルとして保存する
 
 ```
 USAGE
-  $ backlog-exporter issue --domain <value> --projectIdOrKey <value> [--apiKey <value>] [-m <value>] [-o
-    <value>] [--statusId <value>]
+  $ backlog-exporter issue --domain <value> --projectIdOrKey <value> [--apiKey <value>]
+    [--issueKeyFileName] [--issueKeyFolder] [-m <value>] [-o <value>] [--statusId <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)
+      --issueKeyFileName        ファイル名を課題キーにする
+      --issueKeyFolder          課題キーでフォルダを作成する
       --projectIdOrKey=<value>  (required) Backlog project ID or key
       --statusId=<value>        ステータスID（カンマ区切りで複数指定可能）
 
@@ -445,9 +477,18 @@ EXAMPLES
 
   $ backlog-exporter issue --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --maxCount 10000
   最大10000件の課題を取得する（デフォルトは5000件）
+
+  $ backlog-exporter issue --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --issueKeyFileName
+  ファイル名を課題キーにする
+
+  $ backlog-exporter issue --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --issueKeyFolder
+  課題キーでフォルダを作成する
+
+  $ backlog-exporter issue --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --issueKeyFileName --issueKeyFolder
+  課題キーでフォルダを作成し、ファイル名も課題キーにする
 ```
 
-_See code: [src/commands/issue/index.ts](https://github.com/ShuntaToda/backlog-exporter/blob/v0.6.1/src/commands/issue/index.ts)_
+_See code: [src/commands/issue/index.ts](https://github.com/ShuntaToda/backlog-exporter/blob/v0.7.1/src/commands/issue/index.ts)_
 
 ## `backlog-exporter plugins`
 
@@ -746,7 +787,7 @@ Backlogから最新データを取得して更新する
 ```
 USAGE
   $ backlog-exporter update [DIRECTORY] [--apiKey <value>] [--documentsOnly] [--domain <value>] [-f]
-    [--issuesOnly] [--projectIdOrKey <value>] [--wikisOnly]
+    [--issueKeyFileName] [--issueKeyFolder] [--issuesOnly] [--projectIdOrKey <value>] [--wikisOnly]
 
 ARGUMENTS
   DIRECTORY  更新対象のディレクトリ（設定ファイルが保存されている場所）
@@ -756,6 +797,8 @@ FLAGS
       --apiKey=<value>          Backlog API key (環境変数 BACKLOG_API_KEY からも自動読み取り可能)
       --documentsOnly           ドキュメントのみを更新する
       --domain=<value>          Backlog domain (e.g. example.backlog.jp)
+      --issueKeyFileName        ファイル名を課題キーにする
+      --issueKeyFolder          課題キーでフォルダを作成する
       --issuesOnly              課題のみを更新する
       --projectIdOrKey=<value>  Backlog project ID or key
       --wikisOnly               Wikiのみを更新する
@@ -775,9 +818,18 @@ EXAMPLES
 
   $ backlog-exporter update ./my-project
   指定したディレクトリの設定を使用して更新する
+
+  $ backlog-exporter update --issueKeyFileName
+  ファイル名を課題キーにする
+
+  $ backlog-exporter update --issueKeyFolder
+  課題キーでフォルダを作成する
+
+  $ backlog-exporter update --issueKeyFileName --issueKeyFolder
+  課題キーでフォルダを作成し、ファイル名も課題キーにする
 ```
 
-_See code: [src/commands/update/index.ts](https://github.com/ShuntaToda/backlog-exporter/blob/v0.6.1/src/commands/update/index.ts)_
+_See code: [src/commands/update/index.ts](https://github.com/ShuntaToda/backlog-exporter/blob/v0.7.1/src/commands/update/index.ts)_
 
 ## `backlog-exporter wiki`
 
@@ -804,7 +856,7 @@ EXAMPLES
   指定したディレクトリにWikiを保存する
 ```
 
-_See code: [src/commands/wiki/index.ts](https://github.com/ShuntaToda/backlog-exporter/blob/v0.6.1/src/commands/wiki/index.ts)_
+_See code: [src/commands/wiki/index.ts](https://github.com/ShuntaToda/backlog-exporter/blob/v0.7.1/src/commands/wiki/index.ts)_
 <!-- commandsstop -->
 
 # 出力形式
@@ -828,12 +880,12 @@ _See code: [src/commands/wiki/index.ts](https://github.com/ShuntaToda/backlog-ex
 
 ## カスタム属性
 
-| 属性名 | 値 |
-|--------|----| 
-| 工数（エンジニア） | 3 |
-| 工数（PPO） | なし |
-| 担当チーム | フロントエンド, バックエンド |
-| 詳細 | 実装内容<br>- 機能A<br>- 機能B |
+| 属性名             | 値                             |
+| ------------------ | ------------------------------ |
+| 工数（エンジニア） | 3                              |
+| 工数（PPO）        | なし                           |
+| 担当チーム         | フロントエンド, バックエンド   |
+| 詳細               | 実装内容<br>- 機能A<br>- 機能B |
 
 ## 詳細
 
@@ -892,10 +944,12 @@ Backlog の書式がそのまま保持されます。
 Backlog の書式がそのまま保持されます。
 
 ## 添付ファイル
+
 - **資料.pdf** (1024.5 KB) - 作成者: 山田太郎, 作成日時: 2023/01/01 10:00:00
 - **画像.png** (256.3 KB) - 作成者: 佐藤次郎, 作成日時: 2023/01/01 10:30:00
 
 ## タグ
+
 - 仕様書
 - 設計書
 ```
@@ -910,3 +964,13 @@ Backlog の書式がそのまま保持されます。
 - **キーワード検索**: ドキュメントの検索キーワード対応
 - **差分更新**: 前回の更新以降に変更されたデータのみを更新
 - **カスタム属性対応**: 課題のカスタム属性をテーブル形式で表示（配列・オブジェクト・プリミティブ値に対応）
+
+## 開発への貢献
+
+backlog-exporterはオープンソースプロジェクトです。バグ報告、機能提案、プルリクエストなど、あらゆる形での貢献を歓迎しています。
+
+詳しくは [CONTRIBUTING.md](docs/CONTRIBUTING.md) をご覧ください。
+
+## ライセンス
+
+このプロジェクトは[MIT License](LICENSE)の下で公開されています。

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

@@ -6,6 +6,8 @@ export default class All extends Command {
         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>;
+        issueKeyFileName: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        issueKeyFolder: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         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>;

package/dist/commands/all/index.js

@@ -24,6 +24,15 @@ export default class All extends Command {
 `,
         `<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --maxCount 1000
 最大1000件の課題を取得する（デフォルトは5000件）
+`,
+        `<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --issueKeyFileName
+ファイル名を課題キーにする
+`,
+        `<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --issueKeyFolder
+課題キーでフォルダを作成する
+`,
+        `<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --issueKeyFileName --issueKeyFolder
+課題キーでフォルダを作成し、ファイル名も課題キーにする
 `,
     ];
     static flags = {
@@ -39,6 +48,14 @@ export default class All extends Command {
             description: "Exclude the specified types, separated by commas (e.g., 'documents,wiki')",
             required: false,
         }),
+        issueKeyFileName: Flags.boolean({
+            description: 'ファイル名を課題キーにする',
+            required: false,
+        }),
+        issueKeyFolder: Flags.boolean({
+            description: '課題キーでフォルダを作成する',
+            required: false,
+        }),
         maxCount: Flags.integer({
             char: 'm',
             default: 5000,
@@ -62,7 +79,7 @@ export default class All extends Command {
     async run() {
         const { flags } = await this.parse(All);
         try {
-            const { domain, exclude, maxCount, only, projectIdOrKey } = flags;
+            const { domain, exclude, issueKeyFileName, issueKeyFolder, maxCount, only, projectIdOrKey } = flags;
             const apiKey = flags.apiKey || getApiKey(this);
             const outputRoot = flags.output || './backlog-data';
             // Check for conflicting flags
@@ -77,7 +94,7 @@ export default class All extends Command {
             else if (exclude) {
                 const excludeTargets = exclude.split(',');
                 const allTargets = ['issues', 'wiki', 'documents'];
-                targets = allTargets.filter(target => !excludeTargets.includes(target));
+                targets = allTargets.filter((target) => !excludeTargets.includes(target));
             }
             else {
                 targets = ['issues', 'wiki', 'documents'];
@@ -108,6 +125,8 @@ export default class All extends Command {
                     apiKey,
                     domain,
                     folderType: FolderType.ISSUE,
+                    issueKeyFileName,
+                    issueKeyFolder,
                     outputDir: issueOutput,
                     projectIdOrKey,
                 });
@@ -117,6 +136,8 @@ export default class All extends Command {
                     apiKey,
                     count: maxCount,
                     domain,
+                    issueKeyFileName,
+                    issueKeyFolder,
                     outputDir: issueOutput,
                     projectId,
                 });

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

@@ -5,6 +5,8 @@ export default class Issue 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>;
+        issueKeyFileName: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        issueKeyFolder: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         maxCount: import("@oclif/core/interfaces").OptionFlag<number, 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/issue/index.js

@@ -20,6 +20,15 @@ export default class Issue extends Command {
 `,
         `<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --maxCount 10000
 最大10000件の課題を取得する（デフォルトは5000件）
+`,
+        `<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --issueKeyFileName
+ファイル名を課題キーにする
+`,
+        `<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --issueKeyFolder
+課題キーでフォルダを作成する
+`,
+        `<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --issueKeyFileName --issueKeyFolder
+課題キーでフォルダを作成し、ファイル名も課題キーにする
 `,
     ];
     static flags = {
@@ -31,6 +40,14 @@ export default class Issue extends Command {
             description: 'Backlog domain (e.g. example.backlog.jp)',
             required: true,
         }),
+        issueKeyFileName: Flags.boolean({
+            description: 'ファイル名を課題キーにする',
+            required: false,
+        }),
+        issueKeyFolder: Flags.boolean({
+            description: '課題キーでフォルダを作成する',
+            required: false,
+        }),
         maxCount: Flags.integer({
             char: 'm',
             default: 5000,
@@ -54,7 +71,7 @@ export default class Issue extends Command {
     async run() {
         const { flags } = await this.parse(Issue);
         try {
-            const { domain, maxCount, projectIdOrKey, statusId } = flags;
+            const { domain, issueKeyFileName, issueKeyFolder, maxCount, projectIdOrKey, statusId } = flags;
             const apiKey = flags.apiKey || getApiKey(this);
             const outputDir = flags.output || './backlog-issues';
             // 出力ディレクトリの作成
@@ -67,6 +84,8 @@ export default class Issue extends Command {
                 apiKey,
                 domain,
                 folderType: FolderType.ISSUE,
+                issueKeyFileName,
+                issueKeyFolder,
                 outputDir,
                 projectIdOrKey,
             });
@@ -75,6 +94,8 @@ export default class Issue extends Command {
                 apiKey,
                 count: maxCount,
                 domain,
+                issueKeyFileName,
+                issueKeyFolder,
                 outputDir,
                 projectId,
                 statusId,

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

@@ -10,6 +10,8 @@ export default class Update extends Command {
         documentsOnly: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         domain: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         force: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        issueKeyFileName: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        issueKeyFolder: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         issuesOnly: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         projectIdOrKey: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         wikisOnly: import("@oclif/core/interfaces").BooleanFlag<boolean>;

package/dist/commands/update/index.js

@@ -28,6 +28,15 @@ export default class Update extends Command {
 `,
         `<%= config.bin %> <%= command.id %> ./my-project
 指定したディレクトリの設定を使用して更新する
+`,
+        `<%= config.bin %> <%= command.id %> --issueKeyFileName
+ファイル名を課題キーにする
+`,
+        `<%= config.bin %> <%= command.id %> --issueKeyFolder
+課題キーでフォルダを作成する
+`,
+        `<%= config.bin %> <%= command.id %> --issueKeyFileName --issueKeyFolder
+課題キーでフォルダを作成し、ファイル名も課題キーにする
 `,
     ];
     static flags = {
@@ -48,6 +57,14 @@ export default class Update extends Command {
             description: '確認プロンプトをスキップする',
             required: false,
         }),
+        issueKeyFileName: Flags.boolean({
+            description: 'ファイル名を課題キーにする',
+            required: false,
+        }),
+        issueKeyFolder: Flags.boolean({
+            description: '課題キーでフォルダを作成する',
+            required: false,
+        }),
         issuesOnly: Flags.boolean({
             description: '課題のみを更新する',
             required: false,
@@ -177,6 +194,9 @@ export default class Update extends Command {
         const projectIdOrKey = flags.projectIdOrKey || settings.projectIdOrKey;
         const { folderType } = settings;
         const { documentsOnly, force, issuesOnly, wikisOnly } = flags;
+        // 設定ファイルからオプションを読み込み、コマンドライン引数で上書き
+        const issueKeyFileName = flags.issueKeyFileName ?? settings.issueKeyFileName ?? false;
+        const issueKeyFolder = flags.issueKeyFolder ?? settings.issueKeyFolder ?? false;
         // 必須パラメータの検証
         if (!domain) {
             this.warn(`${targetDir}: ドメインが指定されていません。スキップします。`);
@@ -220,6 +240,8 @@ export default class Update extends Command {
             await this.updateIssues({
                 apiKey,
                 domain,
+                issueKeyFileName,
+                issueKeyFolder,
                 projectId,
                 projectIdOrKey,
                 targetDir,
@@ -279,6 +301,8 @@ export default class Update extends Command {
             apiKey: options.apiKey,
             count: 100,
             domain: options.domain,
+            issueKeyFileName: options.issueKeyFileName,
+            issueKeyFolder: options.issueKeyFolder,
             lastUpdated,
             outputDir: options.targetDir,
             projectId: options.projectId,

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

@@ -20,11 +20,15 @@ export declare function createCustomFieldsSection(customFields?: Array<{
  * @param options.outputDir 出力ディレクトリ
  * @param options.projectId プロジェクトID
  * @param options.statusId ステータスID
+ * @param options.issueKeyFileName ファイル名を課題キーにするかどうか
+ * @param options.issueKeyFolder 課題キーでフォルダを作成するかどうか
  */
 export declare function downloadIssues(command: Command, options: {
     apiKey: string;
     count?: number;
     domain: string;
+    issueKeyFileName?: boolean;
+    issueKeyFolder?: boolean;
     lastUpdated?: string;
     outputDir: string;
     projectId: number;

package/dist/utils/backlog-api.js

@@ -21,7 +21,7 @@ export function createCustomFieldsSection(customFields) {
             if (Array.isArray(customField.value)) {
                 // 配列の場合（複数選択など）
                 fieldValue = customField.value
-                    .map(item => item.name || item.value || String(item))
+                    .map((item) => item.name || item.value || String(item))
                     .join(', ');
             }
             else if (typeof customField.value === 'object' && customField.value !== null) {
@@ -35,9 +35,7 @@ export function createCustomFieldsSection(customFields) {
             }
         }
         // テーブル内では改行をHTMLの<br>タグに変換し、パイプ文字をエスケープ
-        const escapedFieldValue = fieldValue
-            .replaceAll('|', String.raw `\|`)
-            .replaceAll('\n', '<br>');
+        const escapedFieldValue = fieldValue.replaceAll('|', String.raw `\|`).replaceAll('\n', '<br>');
         customFieldsSection += `| ${customField.name} | ${escapedFieldValue} |\n`;
     }
     return customFieldsSection;
@@ -53,6 +51,8 @@ export function createCustomFieldsSection(customFields) {
  * @param options.outputDir 出力ディレクトリ
  * @param options.projectId プロジェクトID
  * @param options.statusId ステータスID
+ * @param options.issueKeyFileName ファイル名を課題キーにするかどうか
+ * @param options.issueKeyFolder 課題キーでフォルダを作成するかどうか
  */
 export async function downloadIssues(command, options) {
     const baseUrl = `https://${options.domain}/api/v2`;
@@ -155,9 +155,22 @@ export async function downloadIssues(command, options) {
             // 年ごとのフォルダを作成
             // eslint-disable-next-line no-await-in-loop
             await fs.mkdir(yearDirPath, { recursive: true });
-            // 年ごとのフォルダ内にMarkdownファイルを保存
-            const issueFileName = `${sanitizeFileName(issue.summary)}.md`;
-            const issueFilePath = path.join(yearDirPath, issueFileName);
+            let issueFilePath;
+            let issueFileName;
+            if (options.issueKeyFolder) {
+                // 年ごとのフォルダ内に、課題キーでフォルダを作成
+                const issueKeyDirPath = path.join(yearDirPath, issue.issueKey);
+                // eslint-disable-next-line no-await-in-loop
+                await fs.mkdir(issueKeyDirPath, { recursive: true });
+                // ファイル名を課題名（標準）にするか課題キーにするかを決定
+                issueFileName = options.issueKeyFileName ? `${issue.issueKey}.md` : `${sanitizeFileName(issue.summary)}.md`;
+                issueFilePath = path.join(issueKeyDirPath, issueFileName);
+            }
+            else {
+                // 年ごとのフォルダ内に、Markdownファイルを作成
+                issueFileName = options.issueKeyFileName ? `${issue.issueKey}.md` : `${sanitizeFileName(issue.summary)}.md`;
+                issueFilePath = path.join(yearDirPath, issueFileName);
+            }
             // カスタム属性セクションを作成
             const customFieldsSection = createCustomFieldsSection(issue.customFields);
             // Markdownファイルに書き込む

package/dist/utils/settings.d.ts

@@ -13,6 +13,8 @@ export interface Settings {
     apiKey?: string;
     domain?: string;
     folderType?: FolderType;
+    issueKeyFileName?: boolean;
+    issueKeyFolder?: boolean;
     lastUpdated?: string;
     outputDir?: string;
     projectIdOrKey?: string;

package/oclif.manifest.json

@@ -9,7 +9,10 @@
         "<%= 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"
+        "<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --maxCount 1000\n最大1000件の課題を取得する（デフォルトは5000件）\n",
+        "<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --issueKeyFileName\nファイル名を課題キーにする\n",
+        "<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --issueKeyFolder\n課題キーでフォルダを作成する\n",
+        "<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --issueKeyFileName --issueKeyFolder\n課題キーでフォルダを作成し、ファイル名も課題キーにする\n"
       ],
       "flags": {
         "apiKey": {
@@ -36,6 +39,20 @@
           "multiple": false,
           "type": "option"
         },
+        "issueKeyFileName": {
+          "description": "ファイル名を課題キーにする",
+          "name": "issueKeyFileName",
+          "required": false,
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "issueKeyFolder": {
+          "description": "課題キーでフォルダを作成する",
+          "name": "issueKeyFolder",
+          "required": false,
+          "allowNo": false,
+          "type": "boolean"
+        },
         "maxCount": {
           "char": "m",
           "description": "一度に取得する課題の最大数（デフォルト: 5000）",
@@ -88,14 +105,18 @@
         "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",
+        "<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --issueKeyFileName\nファイル名を課題キーにする\n",
+        "<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --issueKeyFolder\n課題キーでフォルダを作成する\n",
+        "<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --issueKeyFileName --issueKeyFolder\n課題キーでフォルダを作成し、ファイル名も課題キーにする\n"
       ],
       "flags": {
         "apiKey": {
@@ -114,10 +135,26 @@
           "multiple": false,
           "type": "option"
         },
-        "keyword": {
-          "description": "検索キーワード",
-          "name": "keyword",
+        "issueKeyFileName": {
+          "description": "ファイル名を課題キーにする",
+          "name": "issueKeyFileName",
           "required": false,
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "issueKeyFolder": {
+          "description": "課題キーでフォルダを作成する",
+          "name": "issueKeyFolder",
+          "required": false,
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "maxCount": {
+          "char": "m",
+          "description": "一度に取得する課題の最大数（デフォルト: 5000）",
+          "name": "maxCount",
+          "required": false,
+          "default": 5000,
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
@@ -138,11 +175,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",
@@ -152,19 +197,18 @@
       "relativePath": [
         "dist",
         "commands",
-        "document",
+        "issue",
         "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": {
@@ -183,12 +227,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"
@@ -209,19 +251,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",
@@ -231,7 +265,7 @@
       "relativePath": [
         "dist",
         "commands",
-        "issue",
+        "document",
         "index.js"
       ]
     },
@@ -249,7 +283,10 @@
         "<%= config.bin %> <%= command.id %>\nカレントディレクトリの設定を使用して更新する\n",
         "<%= config.bin %> <%= command.id %> --force\n確認プロンプトをスキップする\n",
         "<%= config.bin %> <%= command.id %> --apiKey YOUR_API_KEY --domain example.backlog.jp --projectIdOrKey PROJECT_KEY\n指定したパラメータで更新する（設定ファイルが存在する場合は上書きされます）\n",
-        "<%= config.bin %> <%= command.id %> ./my-project\n指定したディレクトリの設定を使用して更新する\n"
+        "<%= config.bin %> <%= command.id %> ./my-project\n指定したディレクトリの設定を使用して更新する\n",
+        "<%= config.bin %> <%= command.id %> --issueKeyFileName\nファイル名を課題キーにする\n",
+        "<%= config.bin %> <%= command.id %> --issueKeyFolder\n課題キーでフォルダを作成する\n",
+        "<%= config.bin %> <%= command.id %> --issueKeyFileName --issueKeyFolder\n課題キーでフォルダを作成し、ファイル名も課題キーにする\n"
       ],
       "flags": {
         "apiKey": {
@@ -283,6 +320,20 @@
           "allowNo": false,
           "type": "boolean"
         },
+        "issueKeyFileName": {
+          "description": "ファイル名を課題キーにする",
+          "name": "issueKeyFileName",
+          "required": false,
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "issueKeyFolder": {
+          "description": "課題キーでフォルダを作成する",
+          "name": "issueKeyFolder",
+          "required": false,
+          "allowNo": false,
+          "type": "boolean"
+        },
         "issuesOnly": {
           "description": "課題のみを更新する",
           "name": "issuesOnly",
@@ -382,5 +433,5 @@
       ]
     }
   },
-  "version": "0.6.1"
+  "version": "0.7.1"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "backlog-exporter",
   "description": "A new CLI generated with oclif",
-  "version": "0.6.1",
+  "version": "0.7.1",
   "author": "ShuntaToda",
   "bin": {
     "backlog-exporter": "bin/run.js"
@@ -28,6 +28,7 @@
     "mocha": "^10",
     "nock": "^14.0.1",
     "oclif": "^4",
+    "prettier": "^3.6.2",
     "shx": "^0.3.3",
     "ts-node": "^10",
     "typescript": "^5"
@@ -68,6 +69,8 @@
   },
   "scripts": {
     "build": "shx rm -rf dist && tsc -b",
+    "format": "prettier --write .",
+    "format:check": "prettier --check .",
     "lint": "eslint",
     "postpack": "shx rm -f oclif.manifest.json",
     "posttest": "npm run lint",