backlog-exporter 0.7.3 → 1.1.0

package/README.md

@@ -16,6 +16,12 @@ Backlog のデータをエクスポートするためのコマンドラインツ
 * [ドキュメント のエクスポート](#ドキュメント-のエクスポート)
 * [課題・Wiki・ドキュメント の一括エクスポート](#課題wikiドキュメント-の一括エクスポート)
 * [データの更新](#データの更新)
+* [特定の課題だけを再取得（課題キーまたは課題ID）](#特定の課題だけを再取得課題キーまたは課題id)
+* [特定のWikiだけを再取得（Wiki ID）](#特定のwikiだけを再取得wiki-id)
+* [特定のドキュメントだけを再取得（ドキュメントID）](#特定のドキュメントだけを再取得ドキュメントid)
+* [カレントディレクトリ配下の設定ファイルを探索して実行](#カレントディレクトリ配下の設定ファイルを探索して実行)
+* [対象ディレクトリを指定](#対象ディレクトリを指定)
+* [確認プロンプトをスキップ](#確認プロンプトをスキップ)
 * [コマンド](#コマンド)
 * [出力形式](#出力形式)
 * [課題のタイトル](#課題のタイトル)
@@ -43,7 +49,7 @@ $ npm install -g backlog-exporter
 $ backlog-exporter COMMAND
 running command...
 $ backlog-exporter (--version)
-backlog-exporter/0.7.3 linux-x64 node-v25.8.1
+backlog-exporter/1.1.0 linux-x64 node-v26.5.0
 $ backlog-exporter --help [COMMAND]
 USAGE
   $ backlog-exporter COMMAND
@@ -153,8 +159,30 @@ $ backlog-exporter issue --domain example.backlog.jp --projectIdOrKey PROJECT_KE
 $ backlog-exporter issue --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --issueKeyFileName --issueKeyFolder
 ```
 
+**課題の添付ファイルもダウンロードする**
+
+```sh
+$ backlog-exporter issue --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --downloadAttachments
+```
+
 エクスポートされた課題は、指定したディレクトリ内に Markdown ファイルとして保存されます。ファイル名は課題のキーに基づいて自動的に生成されます。
 
+## 添付ファイルのダウンロード
+
+`--downloadAttachments`（短縮形: `-d`）フラグを指定すると、課題・Wiki・ドキュメントの添付ファイルもダウンロードされます（`all` / `issue` / `wiki` / `document` / `update` コマンドで使用可能）。
+
+- 保存先:
+  - 課題: デフォルトは `{年}/attachments/{課題キー}/`、`--issueKeyFolder` 指定時は課題フォルダ直下の `attachments/`
+  - Wiki: Markdownと同じディレクトリの `attachments/{Wiki名}/`（階層Wikiは末尾のページ名）
+  - ドキュメント: Markdownと同じディレクトリの `attachments/{ドキュメント名}/`
+- ファイル名は同名の衝突を避けるため `{添付ID}_{ファイル名}` になります
+- Markdown の `## 添付ファイル` セクションにローカルファイルへの相対リンクが記載されます（フラグ未指定時はファイル名とサイズのみ記載）
+- 課題の本文・コメント内の添付画像のインライン記法（`![image][ファイル名]` / `#image(ファイル名)`）は、ダウンロード済みファイルへの画像リンクに変換され、Markdownビューアでそのまま表示できます
+- Wiki・ドキュメントの本文はBacklogの原文のまま維持されます（添付参照記法の書き換えは行いません）。添付ファイルへは `## 添付ファイル` セクションのリンクからアクセスできます
+- ダウンロード済みのファイルは再ダウンロードされないため、`update` コマンドでの差分更新でも効率的に動作します
+- 設定は `backlog-settings.json` に保存され、以降の `update` コマンドで自動的に引き継がれます（`update` コマンド自体でフラグを指定した場合はその実行のみ有効です）
+- Backlog側で削除された添付ファイルは、誤削除防止のため `prune` コマンドでも削除されず残ります
+
 ## カスタム属性の対応
 
 課題のエクスポートでは、Backlogのカスタム属性も含めて出力されます：
@@ -227,12 +255,14 @@ $ backlog-exporter document --domain example.backlog.jp --projectIdOrKey PROJECT
 
 - Backlogのドキュメントツリーの階層構造がそのままローカルディレクトリ構造として再現されます
 - フォルダはディレクトリとして作成され、ドキュメントはMarkdownファイルとして保存されます
+- 子を持つ親ドキュメント自身が本文を持つ場合は、フォルダ内の `00_index.md` として保存されます（本文が空の親はファイルを作成しません）
 
 ### 出力例
 
 ```
 documents/
 ├── プロジェクト概要/
+│   ├── 00_index.md          ← 親ドキュメント「プロジェクト概要」自身の本文
 │   ├── 要件定義書.md
 │   └── 仕様書.md
 ├── 設計書/
@@ -248,6 +278,7 @@ documents/
 ### 特徴
 
 - **階層構造の完全再現**: Backlogのフォルダ階層がそのまま保持されます
+- **親ドキュメント本文の保存**: 子を持つ親ドキュメントの本文もフォルダ内の `00_index.md` として保存されます
 - **重複処理の防止**: 同じドキュメントが複数回処理されることを防ぎます
 - **ファイル名の自動サニタイズ**: 不正な文字を自動的に除去して安全なファイル名を生成します
 - **メタデータの保持**: 作成者、更新者、タグ、添付ファイル情報なども含めて保存されます
@@ -286,6 +317,15 @@ $ backlog-exporter all --domain example.backlog.jp --projectIdOrKey PROJECT_KEY
 
 ## エクスポート対象の制御
 
+`--only` / `--exclude` を指定せずに対話端末で実行した場合は、Wiki・ドキュメントのどちらを取得するかを選択できます（BacklogはWikiからドキュメントへの移行を予定しています）:
+
+```
+BacklogのWikiとドキュメントのどちらを取得しますか？（BacklogはWikiからドキュメントへの移行を予定しています）
+  [1] 両方（デフォルト）  [2] Wikiのみ  [3] ドキュメントのみ
+```
+
+非対話環境（CI・パイプ実行）では従来どおり両方を取得します。
+
 `all`コマンドでは、以下のフラグを使用してエクスポート対象を制御できます：
 
 ### --only フラグ
@@ -368,8 +408,51 @@ $ backlog-exporter update --documentsOnly
 $ backlog-exporter update --apiKey YOUR_API_KEY
 ```
 
+**指定した項目（課題・Wiki・ドキュメント）のみを再取得する**
+
+```sh
+# 特定の課題だけを再取得（課題キーまたは課題ID）
+$ backlog-exporter update --issueIdOrKey PROJECT-1,PROJECT-2
+
+# 特定のWikiだけを再取得（Wiki ID）
+$ backlog-exporter update --wikiId 12345,12346
+
+# 特定のドキュメントだけを再取得（ドキュメントID）
+$ backlog-exporter update --documentId abc123,def456
+```
+
+`update` は通常、設定ファイルの最終更新日時（`lastUpdated`）以降に更新された項目を差分取得します。一方で「特定の項目だけを取り直したい」場合は、上記のID指定フラグを使います。
+
+- `--issueIdOrKey`: 課題キー（`PROJECT-1`）または課題ID（数値）。Wiki・ドキュメントは数値IDのみのため `--wikiId` / `--documentId` を使います
+- いずれもカンマ区切りで複数指定できます
+- 指定したフラグに対応する項目のみを再取得し、それ以外の種別の更新は行いません（例: `--wikiId` のみ指定時は課題・ドキュメントを更新しません）
+- 指定した項目以外のローカルファイルには影響しません
+
+> **Note**: これらのID指定フラグは全件差分更新ではないため、設定ファイルの最終更新日時（`lastUpdated`）は更新されません。そのため、次回の通常の差分更新に影響を与えません。
+
 更新コマンドは、各ディレクトリの設定ファイルに基づいて、課題・Wiki・ドキュメントを自動的に更新します。設定ファイルが見つかったディレクトリでは、そのディレクトリ内のファイルが直接更新されます（サブフォルダは作成されません）。
 
+**Backlog上で削除・移動された課題・ドキュメント・Wikiのローカルファイルを削除する（prune）**
+
+```sh
+# カレントディレクトリ配下の設定ファイルを探索して実行
+$ backlog-exporter prune
+
+# 対象ディレクトリを指定
+$ backlog-exporter prune ./backlog-documents
+
+# 確認プロンプトをスキップ
+$ backlog-exporter prune --force
+```
+
+`update`（および各取得コマンド）は増分更新（追加・上書き）のため、Backlog上で削除された課題・ドキュメント・Wikiや別の場所へ移動されたものは、ローカルにファイルが残り続けます。`prune` コマンドは、Backlogに存在しないローカルの `.md` ファイルと、空になったディレクトリを削除してBacklogと同じ状態に揃えます。
+
+- 対象は**課題・ドキュメント・Wikiフォルダ**です（設定ファイルの `folderType` で判定します）
+- ファイルを削除する破壊的な操作のため、`update` とは独立したコマンドとして分離しています（実行時に確認プロンプトを表示。`--force` でスキップ可能）
+- 削除対象は `.md` ファイルのみ。`backlog-settings.json`・`backlog-update.log`・`.md` 以外のファイルには触れません。ただし、対象フォルダ内にユーザーが独自に置いた `.md` ファイルや空のディレクトリは、Backlog上に存在しないものとして削除されるため注意してください
+- ファイル名は保存時と同じロジックで比較します（ドキュメントは一覧APIの `title` 基準、課題は設定ファイルの `issueKeyFileName`/`issueKeyFolder` を反映）。サニタイズ差異やツリー名との差異による誤削除は起きません。ドキュメント情報の取得に失敗した場合は、誤削除を防ぐため何も削除せずに中止します
+- 削除したファイルは `backlog-update.log` に記録されます
+
 # コマンド
 
 ## `backlog-exporter help [COMMAND]`
@@ -686,6 +769,25 @@ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/
 
 # 出力形式
 
+## 本文マーカー
+
+課題の詳細・Wikiの本文・ドキュメントの内容といった「本文」部分は、種別を問わず以下のHTMLコメントマーカーで囲まれて出力されます。
+
+```markdown
+<!-- backlog-exporter:body:start -->
+ここが本文（## 見出しなどを含んでもよい）
+<!-- backlog-exporter:body:end -->
+```
+
+- マーカーはMarkdownのレンダリング時には表示されません（HTMLコメント）
+- 本文自体が `##` 見出しなどを含んでいても、開始・終了マーカー間を本文として機械的に抽出・差し替えできます
+- 本文をBacklogへ書き戻す（API反映する）ツールなどが、どこからどこまでが本文かを一意に判定するために使えます
+- 子を持つ親ドキュメントの本文（`00_index.md`）にも同じマーカーが付きます
+
+**抽出時の規約**: 本文自体がマーカーと同じ文字列を含む可能性があるため（例: このツールの使い方をBacklog上にメモした場合）、抽出ツールは「ファイル内で**最初に現れる開始マーカー**から**最後に現れる終了マーカー**まで」を本文とみなしてください。
+
+以降の出力例では、この本文マーカーを含めた形を示します。
+
 ## 課題の出力形式
 
 課題は以下の形式で Markdown ファイルとして保存されます：
@@ -714,7 +816,9 @@ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/
 
 ## 詳細
 
+<!-- backlog-exporter:body:start -->
 ここに課題の詳細説明が入ります。
+<!-- backlog-exporter:body:end -->
 
 ## コメント
 
@@ -744,8 +848,10 @@ Wiki は以下の形式で Markdown ファイルとして保存されます：
 
 [Backlog Wiki Link](https://example.backlog.jp/alias/wiki/12345)
 
+<!-- backlog-exporter:body:start -->
 ここに Wiki の本文内容が入ります。
 Backlog の書式がそのまま保持されます。
+<!-- backlog-exporter:body:end -->
 ```
 
 ## ドキュメント の出力形式
@@ -765,8 +871,10 @@ Backlog の書式がそのまま保持されます。
 
 ## 内容
 
+<!-- backlog-exporter:body:start -->
 ここにドキュメントの本文内容が入ります。
 Backlog の書式がそのまま保持されます。
+<!-- backlog-exporter:body:end -->
 
 ## 添付ファイル
 

package/bin/dev.js

@@ -1,5 +1,9 @@
-#!/usr/bin/env -S node --loader ts-node/esm --disable-warning=ExperimentalWarning
+#!/usr/bin/env -S node --import tsx --disable-warning=ExperimentalWarning
 
 import {execute} from '@oclif/core'
 
-await execute({development: true, dir: import.meta.url})
+// execute({development: true}) はエラー時のスタックトレース表示も有効化してしまうため、
+// srcのTS解決に必要な NODE_ENV のみを設定する
+process.env.NODE_ENV = 'development'
+
+await execute({dir: import.meta.url})

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

@@ -5,6 +5,7 @@ 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>;
+        downloadAttachments: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         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>;
@@ -14,4 +15,6 @@ export default class All extends Command {
         projectIdOrKey: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
     };
     run(): Promise<void>;
+    private determineTargets;
+    private promptContentSelection;
 }

package/dist/commands/all/index.js

@@ -1,12 +1,12 @@
 import { Command, Flags } from '@oclif/core';
-import * as dotenv from 'dotenv';
-import path from 'node:path';
-import { downloadDocuments, downloadIssues, downloadWikis } from '../../utils/backlog-api.js';
-import { validateAndGetProjectId } from '../../utils/backlog.js';
-import { createOutputDirectory, getApiKey } from '../../utils/common.js';
-import { FolderType, updateSettings } from '../../utils/settings.js';
+import { createBacklogRepositories } from '../../composition/backlog-repositories.js';
+import { applyContentSelection, parseContentSelection } from '../../modules/all/domain/content-selection.js';
+import { exportAll } from '../../modules/all/use-case/export-all.js';
+import { API_KEY_NOT_FOUND_MESSAGE, loadDotenv, resolveApiKey } from '../../shared/config/env.js';
+import { isInteractiveStdin, readLine } from '../../shared/console/prompt.js';
 // .envファイルを読み込む
-dotenv.config();
+loadDotenv();
+const VALID_TARGETS = ['issues', 'wiki', 'documents'];
 export default class All extends Command {
     static description = 'Backlogから課題・Wiki・ドキュメントを取得してMarkdownファイルとして保存する';
     static examples = [
@@ -44,6 +44,11 @@ export default class All extends Command {
             description: 'Backlog domain (e.g. example.backlog.jp)',
             required: true,
         }),
+        downloadAttachments: Flags.boolean({
+            char: 'd',
+            description: '課題の添付ファイルもダウンロードする',
+            required: false,
+        }),
         exclude: Flags.string({
             description: "Exclude the specified types, separated by commas (e.g., 'documents,wiki')",
             required: false,
@@ -79,132 +84,69 @@ export default class All extends Command {
     async run() {
         const { flags } = await this.parse(All);
         try {
-            const { domain, exclude, issueKeyFileName, issueKeyFolder, maxCount, only, projectIdOrKey } = flags;
-            const apiKey = flags.apiKey || getApiKey(this);
+            const { domain, downloadAttachments, exclude, issueKeyFileName, issueKeyFolder, maxCount, only, projectIdOrKey } = flags;
+            const apiKey = resolveApiKey(flags.apiKey, () => this.log('環境変数 BACKLOG_API_KEY からAPIキーを使用します')) ??
+                this.error(API_KEY_NOT_FOUND_MESSAGE);
             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} を使用します`);
-            if (targets.includes('issues')) {
-                // 課題の出力ディレクトリ
-                const issueOutput = path.join(outputRoot, 'issues');
-                await createOutputDirectory(issueOutput);
-                // 課題フォルダに設定ファイルを保存
-                await updateSettings(issueOutput, {
-                    apiKey,
-                    domain,
-                    folderType: FolderType.ISSUE,
-                    issueKeyFileName,
-                    issueKeyFolder,
-                    outputDir: issueOutput,
-                    projectIdOrKey,
-                });
-                // 課題の取得と保存
-                this.log('課題の取得を開始します...');
-                await downloadIssues(this, {
-                    apiKey,
-                    count: maxCount,
-                    domain,
-                    issueKeyFileName,
-                    issueKeyFolder,
-                    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('ドキュメントの取得が完了しました');
+            let targets = this.determineTargets(only, exclude);
+            // --only / --exclude 未指定の対話実行では、Wiki・ドキュメントのどちらを取得するか選択できるようにする
+            if (!only && !exclude && isInteractiveStdin()) {
+                targets = applyContentSelection(targets, await this.promptContentSelection());
             }
-            this.log('すべてのデータの取得が完了しました！');
+            this.log(`取得対象: ${targets.join(', ')}`);
+            const logger = { log: (message) => this.log(message), warn: (message) => this.warn(message) };
+            const repositories = createBacklogRepositories({
+                apiKey,
+                domain,
+                onRateLimitExceeded: (waitSeconds) => this.log(`レート制限の上限に達しました。${waitSeconds}秒待機します...`),
+            });
+            await exportAll({ ...repositories, logger }, {
+                apiKey,
+                domain,
+                downloadAttachments,
+                issueKeyFileName,
+                issueKeyFolder,
+                maxCount,
+                outputRoot,
+                projectIdOrKey,
+                targets,
+            });
         }
         catch (error) {
             const errorMessage = error instanceof Error ? error.message : String(error);
             this.error(`データの取得に失敗しました: ${errorMessage}`);
         }
     }
+    determineTargets(only, exclude) {
+        if (only && exclude) {
+            this.error('Cannot use both --only and --exclude flags together. Please use only one.');
+        }
+        // 指定された値の検証
+        const inputTargets = only ? only.split(',') : exclude ? exclude.split(',') : [];
+        for (const target of inputTargets) {
+            if (!VALID_TARGETS.includes(target)) {
+                this.error(`Invalid target '${target}'. Available targets are: ${VALID_TARGETS.join(', ')}`);
+            }
+        }
+        let targets;
+        if (only) {
+            targets = only.split(',');
+        }
+        else if (exclude) {
+            const excludeTargets = exclude.split(',');
+            targets = VALID_TARGETS.filter((target) => !excludeTargets.includes(target));
+        }
+        else {
+            targets = [...VALID_TARGETS];
+        }
+        if (targets.length === 0) {
+            this.error('No targets remaining after exclusion. Please specify valid targets to export.');
+        }
+        return targets;
+    }
+    async promptContentSelection() {
+        this.log('BacklogのWikiとドキュメントのどちらを取得しますか？（BacklogはWikiからドキュメントへの移行を予定しています）');
+        this.log('  [1] 両方（デフォルト）  [2] Wikiのみ  [3] ドキュメントのみ');
+        return parseContentSelection(await readLine());
+    }
 }

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

@@ -5,6 +5,7 @@ export default class Document 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>;
+        downloadAttachments: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         keyword: 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/document/index.js

@@ -1,11 +1,12 @@
 import { Command, Flags } from '@oclif/core';
-import * as dotenv from 'dotenv';
-import { downloadDocuments } from '../../utils/backlog-api.js';
-import { validateAndGetProjectId } from '../../utils/backlog.js';
-import { createOutputDirectory, getApiKey } from '../../utils/common.js';
-import { FolderType, updateSettings } from '../../utils/settings.js';
+import { createBacklogRepositories } from '../../composition/backlog-repositories.js';
+import { exportDocuments } from '../../modules/document/use-case/export-documents.js';
+import { FolderType } from '../../modules/settings/domain/settings.js';
+import { updateSettings } from '../../modules/settings/repository/settings-store.js';
+import { API_KEY_NOT_FOUND_MESSAGE, loadDotenv, resolveApiKey } from '../../shared/config/env.js';
+import { ensureDirectory } from '../../shared/storage/markdown-store.js';
 // .envファイルを読み込む
-dotenv.config();
+loadDotenv();
 export default class Document extends Command {
     static description = 'Backlogからドキュメントを取得してMarkdownファイルとして保存する';
     static examples = [
@@ -28,6 +29,11 @@ export default class Document extends Command {
             description: 'Backlog domain (e.g. example.backlog.jp)',
             required: true,
         }),
+        downloadAttachments: Flags.boolean({
+            char: 'd',
+            description: '添付ファイルもダウンロードする',
+            required: false,
+        }),
         keyword: Flags.string({
             description: '検索キーワード',
             required: false,
@@ -45,26 +51,34 @@ export default class Document extends Command {
     async run() {
         const { flags } = await this.parse(Document);
         try {
-            const { domain, keyword, projectIdOrKey } = flags;
-            const apiKey = flags.apiKey || getApiKey(this);
+            const { domain, downloadAttachments, keyword, projectIdOrKey } = flags;
+            const apiKey = resolveApiKey(flags.apiKey, () => this.log('環境変数 BACKLOG_API_KEY からAPIキーを使用します')) ??
+                this.error(API_KEY_NOT_FOUND_MESSAGE);
             const outputDir = flags.output || './backlog-documents';
+            const logger = { log: (message) => this.log(message), warn: (message) => this.warn(message) };
+            const { documentRepository, projectRepository } = createBacklogRepositories({
+                apiKey,
+                domain,
+                onRateLimitExceeded: (waitSeconds) => this.log(`レート制限の上限に達しました。${waitSeconds}秒待機します...`),
+            });
             // 出力ディレクトリの作成
-            await createOutputDirectory(outputDir);
+            await ensureDirectory(outputDir);
             // プロジェクトキーからプロジェクトIDを取得
-            const projectId = await validateAndGetProjectId(domain, projectIdOrKey, apiKey);
+            const projectId = await projectRepository.resolveProjectId(projectIdOrKey);
             this.log(`プロジェクトID: ${projectId} を使用します`);
             // 設定ファイルを保存
             await updateSettings(outputDir, {
                 apiKey,
                 domain,
+                downloadAttachments,
                 folderType: FolderType.DOCUMENT,
                 outputDir,
                 projectIdOrKey,
             });
             // ドキュメントの取得と保存
-            await downloadDocuments(this, {
-                apiKey,
+            await exportDocuments({ documentRepository, logger }, {
                 domain,
+                downloadAttachments,
                 keyword,
                 outputDir,
                 projectId,

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

@@ -5,6 +5,7 @@ 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>;
+        downloadAttachments: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         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>;

package/dist/commands/issue/index.js

@@ -1,11 +1,12 @@
 import { Command, Flags } from '@oclif/core';
-import * as dotenv from 'dotenv';
-import { downloadIssues } from '../../utils/backlog-api.js';
-import { validateAndGetProjectId } from '../../utils/backlog.js';
-import { createOutputDirectory, getApiKey } from '../../utils/common.js';
-import { FolderType, updateSettings } from '../../utils/settings.js';
+import { createBacklogRepositories } from '../../composition/backlog-repositories.js';
+import { exportIssues } from '../../modules/issue/use-case/export-issues.js';
+import { FolderType } from '../../modules/settings/domain/settings.js';
+import { updateSettings } from '../../modules/settings/repository/settings-store.js';
+import { API_KEY_NOT_FOUND_MESSAGE, loadDotenv, resolveApiKey } from '../../shared/config/env.js';
+import { ensureDirectory } from '../../shared/storage/markdown-store.js';
 // .envファイルを読み込む
-dotenv.config();
+loadDotenv();
 export default class Issue extends Command {
     static description = 'Backlogから課題を取得してMarkdownファイルとして保存する';
     static examples = [
@@ -29,6 +30,9 @@ export default class Issue extends Command {
 `,
         `<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --issueKeyFileName --issueKeyFolder
 課題キーでフォルダを作成し、ファイル名も課題キーにする
+`,
+        `<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --downloadAttachments
+課題の添付ファイルもダウンロードする
 `,
     ];
     static flags = {
@@ -40,6 +44,11 @@ export default class Issue extends Command {
             description: 'Backlog domain (e.g. example.backlog.jp)',
             required: true,
         }),
+        downloadAttachments: Flags.boolean({
+            char: 'd',
+            description: '課題の添付ファイルもダウンロードする',
+            required: false,
+        }),
         issueKeyFileName: Flags.boolean({
             description: 'ファイル名を課題キーにする',
             required: false,
@@ -71,18 +80,26 @@ export default class Issue extends Command {
     async run() {
         const { flags } = await this.parse(Issue);
         try {
-            const { domain, issueKeyFileName, issueKeyFolder, maxCount, projectIdOrKey, statusId } = flags;
-            const apiKey = flags.apiKey || getApiKey(this);
+            const { domain, downloadAttachments, issueKeyFileName, issueKeyFolder, maxCount, projectIdOrKey, statusId } = flags;
+            const apiKey = resolveApiKey(flags.apiKey, () => this.log('環境変数 BACKLOG_API_KEY からAPIキーを使用します')) ??
+                this.error(API_KEY_NOT_FOUND_MESSAGE);
             const outputDir = flags.output || './backlog-issues';
+            const logger = { log: (message) => this.log(message), warn: (message) => this.warn(message) };
+            const { issueRepository, projectRepository } = createBacklogRepositories({
+                apiKey,
+                domain,
+                onRateLimitExceeded: (waitSeconds) => this.log(`レート制限の上限に達しました。${waitSeconds}秒待機します...`),
+            });
             // 出力ディレクトリの作成
-            await createOutputDirectory(outputDir);
+            await ensureDirectory(outputDir);
             // プロジェクトキーからプロジェクトIDを取得
-            const projectId = await validateAndGetProjectId(domain, projectIdOrKey, apiKey);
+            const projectId = await projectRepository.resolveProjectId(projectIdOrKey);
             this.log(`プロジェクトID: ${projectId} を使用します`);
             // 設定ファイルを保存
             await updateSettings(outputDir, {
                 apiKey,
                 domain,
+                downloadAttachments,
                 folderType: FolderType.ISSUE,
                 issueKeyFileName,
                 issueKeyFolder,
@@ -90,10 +107,10 @@ export default class Issue extends Command {
                 projectIdOrKey,
             });
             // 課題の取得と保存
-            await downloadIssues(this, {
-                apiKey,
+            await exportIssues({ issueRepository, logger }, {
                 count: maxCount,
                 domain,
+                downloadAttachments,
                 issueKeyFileName,
                 issueKeyFolder,
                 outputDir,

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

@@ -0,0 +1,16 @@
+import { Command } from '@oclif/core';
+export default class Prune extends Command {
+    static args: {
+        directory: import("@oclif/core/interfaces").Arg<string | undefined, Record<string, unknown>>;
+    };
+    static description: string;
+    static examples: string[];
+    static flags: {
+        apiKey: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        domain: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        force: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        projectIdOrKey: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    run(): Promise<void>;
+    private confirmPrune;
+}