backlog-exporter 1.1.0 → 1.2.0

package/dist/modules/prune/use-case/prune-exports.js

@@ -1,4 +1,5 @@
-import { collectDocumentTreePaths, resolveDocumentLeafPaths } from '../../document/domain/document-path.js';
+import { addFallbackDocumentPaths, collectDocumentTreePaths, resolveDocumentLeafPaths, } from '../../document/domain/document-path.js';
+import { findDocumentsMissingFromTree } from '../../document/domain/document-tree-gap.js';
 import { buildIssueExpectedPaths } from '../../issue/domain/issue-path.js';
 import { buildWikiExpectedPaths } from '../../wiki/domain/wiki-path.js';
 import { pruneLocalMarkdownFiles } from '../repository/prune-walker.js';
@@ -7,19 +8,21 @@ export async function pruneDocuments(deps, options) {
     logger.log('Backlogのドキュメントツリーを取得しています...');
     const documentTree = await documentRepository.fetchTree(options.projectId);
     const expected = collectDocumentTreePaths(documentTree.activeTree.children);
-    // 保存時のファイル名は詳細のtitle基準のため、一覧APIでタイトルを解決してから期待パスを確定する
-    let titlesById = new Map();
-    if (expected.leafNodes.length > 0) {
-        logger.log(`${expected.leafNodes.length}件のドキュメントの正規ファイル名を確認しています...`);
-        try {
-            titlesById = await documentRepository.fetchAllTitles(options.projectId);
-        }
-        catch (error) {
-            // 一覧に欠けが生じると実在ドキュメントを誤削除するため、何も削除せずに中止する
-            throw new Error(`ドキュメント一覧の取得に失敗しました。誤削除を防ぐため、何も削除せずに中止します: ${error instanceof Error ? error.message : String(error)}`);
-        }
+    // 保存時のファイル名は詳細のtitle基準のため、一覧APIでタイトルを解決してから期待パスを確定する。
+    // 一覧はツリーに現れないドキュメントを拾う台帳でもあるため、リーフの有無に関わらず取得する
+    logger.log('ドキュメント一覧でファイル名を確認しています...');
+    let titlesById;
+    try {
+        titlesById = await documentRepository.fetchAllTitles(options.projectId);
+    }
+    catch (error) {
+        // 一覧に欠けが生じると実在ドキュメントを誤削除するため、何も削除せずに中止する
+        throw new Error(`ドキュメント一覧の取得に失敗しました。誤削除を防ぐため、何も削除せずに中止します: ${error instanceof Error ? error.message : String(error)}`);
     }
     resolveDocumentLeafPaths(expected, titlesById);
+    // 取得側はツリーに現れないドキュメントを出力ルート直下に保存するため、同じ配置を期待集合に加える
+    // （加えないと、補完して取得したファイルをpruneが即座に削除してしまう）
+    addFallbackDocumentPaths(expected, findDocumentsMissingFromTree(documentTree, titlesById));
     return pruneLocalMarkdownFiles({
         expected,
         label: 'ドキュメント',

package/oclif.manifest.json

@@ -189,6 +189,71 @@
         "index.js"
       ]
     },
+    "prune": {
+      "aliases": [],
+      "args": {
+        "directory": {
+          "description": "対象ディレクトリ（設定ファイルが保存されている場所）",
+          "name": "directory",
+          "required": false
+        }
+      },
+      "description": "Backlog上で削除・移動された課題・ドキュメント・Wikiのローカルファイルを削除し、Backlogと同じ状態に揃える",
+      "examples": [
+        "<%= config.bin %> <%= command.id %>\nカレントディレクトリ配下の設定ファイルを探索し、Backlog上に存在しないドキュメントファイルを削除する\n",
+        "<%= config.bin %> <%= command.id %> ./backlog-documents\n指定したディレクトリを対象にする\n",
+        "<%= config.bin %> <%= command.id %> --force\n確認プロンプトをスキップして削除する\n"
+      ],
+      "flags": {
+        "apiKey": {
+          "description": "Backlog API key (環境変数 BACKLOG_API_KEY からも自動読み取り可能)",
+          "name": "apiKey",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "domain": {
+          "description": "Backlog domain (e.g. example.backlog.jp)",
+          "name": "domain",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "force": {
+          "char": "f",
+          "description": "確認プロンプトをスキップする",
+          "name": "force",
+          "required": false,
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "projectIdOrKey": {
+          "description": "Backlog project ID or key",
+          "name": "projectIdOrKey",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "prune",
+      "pluginAlias": "backlog-exporter",
+      "pluginName": "backlog-exporter",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "prune",
+        "index.js"
+      ]
+    },
     "issue": {
       "aliases": [],
       "args": {},
@@ -294,71 +359,6 @@
         "index.js"
       ]
     },
-    "prune": {
-      "aliases": [],
-      "args": {
-        "directory": {
-          "description": "対象ディレクトリ（設定ファイルが保存されている場所）",
-          "name": "directory",
-          "required": false
-        }
-      },
-      "description": "Backlog上で削除・移動された課題・ドキュメント・Wikiのローカルファイルを削除し、Backlogと同じ状態に揃える",
-      "examples": [
-        "<%= config.bin %> <%= command.id %>\nカレントディレクトリ配下の設定ファイルを探索し、Backlog上に存在しないドキュメントファイルを削除する\n",
-        "<%= config.bin %> <%= command.id %> ./backlog-documents\n指定したディレクトリを対象にする\n",
-        "<%= config.bin %> <%= command.id %> --force\n確認プロンプトをスキップして削除する\n"
-      ],
-      "flags": {
-        "apiKey": {
-          "description": "Backlog API key (環境変数 BACKLOG_API_KEY からも自動読み取り可能)",
-          "name": "apiKey",
-          "required": false,
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "domain": {
-          "description": "Backlog domain (e.g. example.backlog.jp)",
-          "name": "domain",
-          "required": false,
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "force": {
-          "char": "f",
-          "description": "確認プロンプトをスキップする",
-          "name": "force",
-          "required": false,
-          "allowNo": false,
-          "type": "boolean"
-        },
-        "projectIdOrKey": {
-          "description": "Backlog project ID or key",
-          "name": "projectIdOrKey",
-          "required": false,
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        }
-      },
-      "hasDynamicHelp": false,
-      "hiddenAliases": [],
-      "id": "prune",
-      "pluginAlias": "backlog-exporter",
-      "pluginName": "backlog-exporter",
-      "pluginType": "core",
-      "strict": true,
-      "enableJsonFlag": false,
-      "isESM": true,
-      "relativePath": [
-        "dist",
-        "commands",
-        "prune",
-        "index.js"
-      ]
-    },
     "update": {
       "aliases": [],
       "args": {
@@ -566,5 +566,5 @@
       ]
     }
   },
-  "version": "1.1.0"
+  "version": "1.2.0"
 }

package/package.json

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