backlog-exporter 0.5.0 → 0.5.1

package/README.md

@@ -66,7 +66,7 @@ $ npm install -g backlog-exporter
 $ backlog-exporter COMMAND
 running command...
 $ backlog-exporter (--version)
-backlog-exporter/0.5.0 linux-x64 node-v24.2.0
+backlog-exporter/0.5.1 linux-x64 node-v24.2.0
 $ backlog-exporter --help [COMMAND]
 USAGE
   $ backlog-exporter COMMAND
@@ -281,7 +281,7 @@ EXAMPLES
   最大1000件の課題を取得する（デフォルトは5000件）
 ```
 
-_See code: [src/commands/all/index.ts](https://github.com/ShuntaToda/backlog-exporter/blob/v0.5.0/src/commands/all/index.ts)_
+_See code: [src/commands/all/index.ts](https://github.com/ShuntaToda/backlog-exporter/blob/v0.5.1/src/commands/all/index.ts)_
 
 ## `backlog-exporter document`
 
@@ -313,7 +313,7 @@ EXAMPLES
   キーワード「仕様書」を含むドキュメントのみを取得する
 ```
 
-_See code: [src/commands/document/index.ts](https://github.com/ShuntaToda/backlog-exporter/blob/v0.5.0/src/commands/document/index.ts)_
+_See code: [src/commands/document/index.ts](https://github.com/ShuntaToda/backlog-exporter/blob/v0.5.1/src/commands/document/index.ts)_
 
 ## `backlog-exporter help [COMMAND]`
 
@@ -369,7 +369,7 @@ EXAMPLES
   最大10000件の課題を取得する（デフォルトは5000件）
 ```
 
-_See code: [src/commands/issue/index.ts](https://github.com/ShuntaToda/backlog-exporter/blob/v0.5.0/src/commands/issue/index.ts)_
+_See code: [src/commands/issue/index.ts](https://github.com/ShuntaToda/backlog-exporter/blob/v0.5.1/src/commands/issue/index.ts)_
 
 ## `backlog-exporter plugins`
 
@@ -699,7 +699,7 @@ EXAMPLES
   指定したディレクトリの設定を使用して更新する
 ```
 
-_See code: [src/commands/update/index.ts](https://github.com/ShuntaToda/backlog-exporter/blob/v0.5.0/src/commands/update/index.ts)_
+_See code: [src/commands/update/index.ts](https://github.com/ShuntaToda/backlog-exporter/blob/v0.5.1/src/commands/update/index.ts)_
 
 ## `backlog-exporter wiki`
 
@@ -726,7 +726,7 @@ EXAMPLES
   指定したディレクトリにWikiを保存する
 ```
 
-_See code: [src/commands/wiki/index.ts](https://github.com/ShuntaToda/backlog-exporter/blob/v0.5.0/src/commands/wiki/index.ts)_
+_See code: [src/commands/wiki/index.ts](https://github.com/ShuntaToda/backlog-exporter/blob/v0.5.1/src/commands/wiki/index.ts)_
 <!-- commandsstop -->
 
 # 出力形式

package/dist/commands/all/index.js

@@ -123,6 +123,7 @@ export default class All extends Command {
                 domain,
                 outputDir: documentOutput,
                 projectId,
+                projectIdOrKey,
             });
             // ドキュメントフォルダの最終更新日時を更新
             await updateSettings(documentOutput, {

package/dist/commands/document/index.js

@@ -68,6 +68,7 @@ export default class Document extends Command {
                 keyword,
                 outputDir,
                 projectId,
+                projectIdOrKey,
             });
             // 最終更新日時を更新
             await updateSettings(outputDir, {

package/dist/commands/update/index.js

@@ -257,6 +257,7 @@ export default class Update extends Command {
             lastUpdated,
             outputDir: options.targetDir,
             projectId: options.projectId,
+            projectIdOrKey: options.projectIdOrKey,
         });
         // 設定ファイルを更新
         await updateSettings(options.targetDir, {

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

@@ -37,4 +37,5 @@ export declare function downloadDocuments(command: Command, options: {
     lastUpdated?: string;
     outputDir: string;
     projectId: number;
+    projectIdOrKey: string;
 }): Promise<void>;

package/dist/utils/backlog-api.js

@@ -320,7 +320,7 @@ export async function downloadDocuments(command, options) {
                 const dirPath = path.dirname(documentFilePath);
                 await fs.mkdir(dirPath, { recursive: true });
                 // Backlogのドキュメントへのリンクを作成
-                const backlogDocumentUrl = `https://${options.domain}/document/${node.id}`;
+                const backlogDocumentUrl = `https://${options.domain}/document/${options.projectIdOrKey}/${node.id}`;
                 // 添付ファイルリストの作成
                 let attachmentsSection = '';
                 if (documentDetail.attachments && documentDetail.attachments.length > 0) {

package/oclif.manifest.json

@@ -70,14 +70,15 @@
         "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": {
@@ -96,10 +97,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"
@@ -120,11 +123,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",
@@ -134,19 +145,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": {
@@ -165,12 +175,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"
@@ -191,19 +199,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",
@@ -213,7 +213,7 @@
       "relativePath": [
         "dist",
         "commands",
-        "issue",
+        "document",
         "index.js"
       ]
     },
@@ -364,5 +364,5 @@
       ]
     }
   },
-  "version": "0.5.0"
+  "version": "0.5.1"
 }

package/package.json

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