backlog-exporter 0.1.1 → 0.2.0

package/README.md

@@ -59,7 +59,7 @@ $ npm install -g backlog-exporter
 $ backlog-exporter COMMAND
 running command...
 $ backlog-exporter (--version)
-backlog-exporter/0.1.1 linux-x64 node-v23.9.0
+backlog-exporter/0.2.0 linux-x64 node-v23.9.0
 $ backlog-exporter --help [COMMAND]
 USAGE
   $ backlog-exporter COMMAND
@@ -215,7 +215,7 @@ EXAMPLES
   指定したディレクトリに課題とWikiを保存する
 ```
 
-_See code: [src/commands/all/index.ts](https://github.com/ShuntaToda/backlog-exporter/blob/v0.1.1/src/commands/all/index.ts)_
+_See code: [src/commands/all/index.ts](https://github.com/ShuntaToda/backlog-exporter/blob/v0.2.0/src/commands/all/index.ts)_
 
 ## `backlog-exporter help [COMMAND]`
 
@@ -262,7 +262,7 @@ EXAMPLES
   指定したディレクトリに課題を保存する
 ```
 
-_See code: [src/commands/issue/index.ts](https://github.com/ShuntaToda/backlog-exporter/blob/v0.1.1/src/commands/issue/index.ts)_
+_See code: [src/commands/issue/index.ts](https://github.com/ShuntaToda/backlog-exporter/blob/v0.2.0/src/commands/issue/index.ts)_
 
 ## `backlog-exporter plugins`
 
@@ -591,7 +591,7 @@ EXAMPLES
   指定したディレクトリの設定を使用して更新する
 ```
 
-_See code: [src/commands/update/index.ts](https://github.com/ShuntaToda/backlog-exporter/blob/v0.1.1/src/commands/update/index.ts)_
+_See code: [src/commands/update/index.ts](https://github.com/ShuntaToda/backlog-exporter/blob/v0.2.0/src/commands/update/index.ts)_
 
 ## `backlog-exporter wiki`
 
@@ -618,7 +618,7 @@ EXAMPLES
   指定したディレクトリにWikiを保存する
 ```
 
-_See code: [src/commands/wiki/index.ts](https://github.com/ShuntaToda/backlog-exporter/blob/v0.1.1/src/commands/wiki/index.ts)_
+_See code: [src/commands/wiki/index.ts](https://github.com/ShuntaToda/backlog-exporter/blob/v0.2.0/src/commands/wiki/index.ts)_
 <!-- commandsstop -->
 
 # 出力形式

package/dist/commands/all/index.js

@@ -55,7 +55,13 @@ export default class All extends Command {
             await createOutputDirectory(wikiOutput);
             // 課題の取得と保存
             this.log('課題の取得を開始します...');
-            await downloadIssues(this, domain, projectId, apiKey, issueOutput, 100);
+            await downloadIssues(this, {
+                apiKey,
+                count: 100,
+                domain,
+                outputDir: issueOutput,
+                projectId,
+            });
             // 課題フォルダに設定ファイルを保存
             await updateSettings(issueOutput, {
                 apiKey,
@@ -68,7 +74,12 @@ export default class All extends Command {
             this.log('課題の取得が完了しました');
             // Wikiの取得と保存
             this.log('Wikiの取得を開始します...');
-            await downloadWikis(this, domain, projectIdOrKey, apiKey, wikiOutput);
+            await downloadWikis(this, {
+                apiKey,
+                domain,
+                outputDir: wikiOutput,
+                projectIdOrKey,
+            });
             // Wikiフォルダに設定ファイルを保存
             await updateSettings(wikiOutput, {
                 apiKey,

package/dist/commands/issue/index.js

@@ -47,7 +47,13 @@ export default class Issue extends Command {
             const projectId = await validateAndGetProjectId(domain, projectIdOrKey, apiKey);
             this.log(`プロジェクトID: ${projectId} を使用します`);
             // 課題の取得と保存
-            await downloadIssues(this, domain, projectId, apiKey, outputDir, 100);
+            await downloadIssues(this, {
+                apiKey,
+                count: 100,
+                domain,
+                outputDir,
+                projectId,
+            });
             // 設定ファイルを保存
             await updateSettings(outputDir, {
                 apiKey,

package/dist/commands/update/index.js

@@ -207,7 +207,16 @@ export default class Update extends Command {
     // 課題の更新
     async updateIssues(options) {
         this.log('課題の更新を開始します...');
-        await downloadIssues(this, options.domain, options.projectId, options.apiKey, options.targetDir, 100);
+        // 設定ファイルから前回の更新日時を取得
+        const { lastUpdated } = await loadSettings(options.targetDir);
+        await downloadIssues(this, {
+            apiKey: options.apiKey,
+            count: 100,
+            domain: options.domain,
+            lastUpdated,
+            outputDir: options.targetDir,
+            projectId: options.projectId,
+        });
         // 設定ファイルを更新
         await updateSettings(options.targetDir, {
             apiKey: options.apiKey,
@@ -222,7 +231,15 @@ export default class Update extends Command {
     // Wikiの更新
     async updateWikis(options) {
         this.log('Wikiの更新を開始します...');
-        await downloadWikis(this, options.domain, options.projectIdOrKey, options.apiKey, options.targetDir);
+        // 設定ファイルから前回の更新日時を取得
+        const { lastUpdated } = await loadSettings(options.targetDir);
+        await downloadWikis(this, {
+            apiKey: options.apiKey,
+            domain: options.domain,
+            lastUpdated,
+            outputDir: options.targetDir,
+            projectIdOrKey: options.projectIdOrKey,
+        });
         // 設定ファイルを更新
         await updateSettings(options.targetDir, {
             apiKey: options.apiKey,

package/dist/commands/wiki/index.js

@@ -43,7 +43,12 @@ Wikiをダウンロードする
             // 出力ディレクトリの作成
             await createOutputDirectory(outputDir);
             // Wikiの取得と保存
-            await downloadWikis(this, domain, projectIdOrKey, apiKey, outputDir);
+            await downloadWikis(this, {
+                apiKey,
+                domain,
+                outputDir,
+                projectIdOrKey,
+            });
             // 設定ファイルを保存
             await updateSettings(outputDir, {
                 apiKey,

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

@@ -2,20 +2,26 @@ import { Command } from '@oclif/core';
 /**
  * Backlogから課題をダウンロードする
  * @param command コマンドインスタンス
- * @param domain Backlogドメイン
- * @param projectId プロジェクトID
- * @param apiKey APIキー
- * @param outputDir 出力ディレクトリ
- * @param count 一度に取得する課題数
- * @param statusId ステータスID（オプション）
+ * @param options 課題ダウンロードのオプション
  */
-export declare function downloadIssues(command: Command, domain: string, projectId: number, apiKey: string, outputDir: string, count: number, statusId?: string): Promise<void>;
+export declare function downloadIssues(command: Command, options: {
+    apiKey: string;
+    count: number;
+    domain: string;
+    lastUpdated?: string;
+    outputDir: string;
+    projectId: number;
+    statusId?: string;
+}): Promise<void>;
 /**
  * BacklogからWikiをダウンロードする
  * @param command コマンドインスタンス
- * @param domain Backlogドメイン
- * @param projectIdOrKey プロジェクトIDまたはキー
- * @param apiKey APIキー
- * @param outputDir 出力ディレクトリ
+ * @param options Wikiダウンロードのオプション
  */
-export declare function downloadWikis(command: Command, domain: string, projectIdOrKey: string, apiKey: string, outputDir: string): Promise<void>;
+export declare function downloadWikis(command: Command, options: {
+    apiKey: string;
+    domain: string;
+    lastUpdated?: string;
+    outputDir: string;
+    projectIdOrKey: string;
+}): Promise<void>;

package/dist/utils/backlog-api.js

@@ -5,42 +5,51 @@ import { sanitizeFileName, sanitizeWikiFileName } from './common.js';
 /**
  * Backlogから課題をダウンロードする
  * @param command コマンドインスタンス
- * @param domain Backlogドメイン
- * @param projectId プロジェクトID
- * @param apiKey APIキー
- * @param outputDir 出力ディレクトリ
- * @param count 一度に取得する課題数
- * @param statusId ステータスID（オプション）
+ * @param options 課題ダウンロードのオプション
  */
-export async function downloadIssues(command, domain, projectId, apiKey, outputDir, count, statusId) {
-    const baseUrl = `https://${domain}/api/v2`;
+export async function downloadIssues(command, options) {
+    const baseUrl = `https://${options.domain}/api/v2`;
     command.log('課題の取得を開始します...');
     // APIパラメータの構築
     const params = new URLSearchParams({
-        apiKey,
-        count: count.toString(),
-        'projectId[]': projectId.toString(),
+        apiKey: options.apiKey,
+        count: options.count.toString(),
+        'projectId[]': options.projectId.toString(),
     });
     // ステータスIDが指定されている場合は追加
-    if (statusId) {
-        params.append('statusId[]', statusId);
+    if (options.statusId) {
+        params.append('statusId[]', options.statusId);
     }
     const issues = await ky.get(`${baseUrl}/issues?${params.toString()}`).json();
     command.log(`${issues.length}件の課題が見つかりました。`);
+    // 前回の更新日時より新しい課題のみをフィルタリング
+    let filteredIssues = issues;
+    if (options.lastUpdated) {
+        const lastUpdatedDate = new Date(options.lastUpdated);
+        filteredIssues = issues.filter((issue) => {
+            const issueUpdatedDate = new Date(issue.updated);
+            return issueUpdatedDate > lastUpdatedDate;
+        });
+        command.log(`前回の更新日時(${options.lastUpdated})以降に更新された${filteredIssues.length}件の課題を処理します。`);
+    }
+    if (filteredIssues.length === 0) {
+        command.log('更新が必要な課題はありません。');
+        return;
+    }
     // 各課題の詳細情報を取得して保存
     command.log('課題を保存しています...');
     // Promise.allを使用して並列処理
-    const issuePromises = issues.map(async (issue) => {
+    const issuePromises = filteredIssues.map(async (issue) => {
         try {
             // 課題の詳細情報をJSONファイルとして保存
             const issueFileName = `${sanitizeFileName(issue.summary)}.md`;
-            const issueFilePath = path.join(outputDir, issueFileName);
+            const issueFilePath = path.join(options.outputDir, issueFileName);
             // BacklogのIssueへのリンクを作成
-            const backlogIssueUrl = `https://${domain}/view/${issue.issueKey}`;
+            const backlogIssueUrl = `https://${options.domain}/view/${issue.issueKey}`;
             // コメント一覧を取得
             command.log(`課題 ${issue.issueKey} のコメントを取得しています...`);
             const commentsParams = new URLSearchParams({
-                apiKey,
+                apiKey: options.apiKey,
                 count: '100', // 最大100件のコメントを取得
                 order: 'asc', // 古い順に取得
             });
@@ -86,29 +95,40 @@ ${issue.description || '詳細情報なし'}${commentsSection}`;
 /**
  * BacklogからWikiをダウンロードする
  * @param command コマンドインスタンス
- * @param domain Backlogドメイン
- * @param projectIdOrKey プロジェクトIDまたはキー
- * @param apiKey APIキー
- * @param outputDir 出力ディレクトリ
+ * @param options Wikiダウンロードのオプション
  */
-export async function downloadWikis(command, domain, projectIdOrKey, apiKey, outputDir) {
-    const baseUrl = `https://${domain}/api/v2`;
+export async function downloadWikis(command, options) {
+    const baseUrl = `https://${options.domain}/api/v2`;
     command.log('Wikiの取得を開始します...');
     // Wiki一覧の取得
     command.log('Wiki一覧を取得しています...');
     const wikis = await ky
-        .get(`${baseUrl}/wikis?apiKey=${apiKey}&projectIdOrKey=${projectIdOrKey}`)
+        .get(`${baseUrl}/wikis?apiKey=${options.apiKey}&projectIdOrKey=${options.projectIdOrKey}`)
         .json();
     command.log(`${wikis.length}件のWikiが見つかりました。`);
+    // 前回の更新日時より新しいWikiのみをフィルタリング
+    let filteredWikis = wikis;
+    if (options.lastUpdated) {
+        const lastUpdatedDate = new Date(options.lastUpdated);
+        filteredWikis = wikis.filter((wiki) => {
+            const wikiUpdatedDate = new Date(wiki.updated);
+            return wikiUpdatedDate > lastUpdatedDate;
+        });
+        command.log(`前回の更新日時(${options.lastUpdated})以降に更新された${filteredWikis.length}件のWikiを処理します。`);
+    }
+    if (filteredWikis.length === 0) {
+        command.log('更新が必要なWikiはありません。');
+        return;
+    }
     // 各Wikiの詳細情報を取得
     command.log('Wiki詳細を取得しています...');
     // Promise.allを使用して並列処理
-    const wikiPromises = wikis.map(async (wiki) => {
+    const wikiPromises = filteredWikis.map(async (wiki) => {
         const wikiId = wiki.id;
         command.log(`Wiki: ${wiki.name} (ID: ${wikiId}) を取得しています`);
         try {
             const wikiDetail = await ky
-                .get(`${baseUrl}/wikis/${wikiId}?projectIdOrKey=${projectIdOrKey}&apiKey=${apiKey}`)
+                .get(`${baseUrl}/wikis/${wikiId}?projectIdOrKey=${options.projectIdOrKey}&apiKey=${options.apiKey}`)
                 .json();
             // Wikiの名前をファイルパスとして使用
             const wikiName = wiki.name;
@@ -119,14 +139,14 @@ export async function downloadWikis(command, domain, projectIdOrKey, apiKey, out
             // ディレクトリ構造を作成（必要な場合）
             const dirPath = path.dirname(wikiFileName);
             if (dirPath !== '.') {
-                await fs.mkdir(path.join(outputDir, dirPath), { recursive: true });
+                await fs.mkdir(path.join(options.outputDir, dirPath), { recursive: true });
             }
             // Markdownファイルを保存
-            const wikiFilePath = path.join(outputDir, wikiFileName);
+            const wikiFilePath = path.join(options.outputDir, wikiFileName);
             // JSONからcontentフィールドを取得
             const content = wikiDetail.content || '';
             // BacklogのWikiへのリンクを作成
-            const backlogWikiUrl = `https://${domain}/alias/wiki/${wikiId}`;
+            const backlogWikiUrl = `https://${options.domain}/alias/wiki/${wikiId}`;
             // Markdownファイルに書き込む（タイトルとBacklogリンクを追加）
             const markdownContent = `# ${wiki.name}\n\n[Backlog Wiki Link](${backlogWikiUrl})\n\n${content}`;
             await fs.writeFile(wikiFilePath, markdownContent);

package/oclif.manifest.json

@@ -59,21 +59,13 @@
         "index.js"
       ]
     },
-    "update": {
+    "issue": {
       "aliases": [],
-      "args": {
-        "directory": {
-          "description": "更新対象のディレクトリ（設定ファイルが保存されている場所）",
-          "name": "directory",
-          "required": false
-        }
-      },
-      "description": "Backlogから最新データを取得して更新する",
+      "args": {},
+      "description": "Backlogから課題を取得してMarkdownファイルとして保存する",
       "examples": [
-        "<%= 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 %> --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-project\n指定したディレクトリに課題を保存する\n"
       ],
       "flags": {
         "apiKey": {
@@ -87,45 +79,32 @@
         "domain": {
           "description": "Backlog domain (e.g. example.backlog.jp)",
           "name": "domain",
-          "required": false,
+          "required": true,
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
-        "force": {
-          "char": "f",
-          "description": "確認プロンプトをスキップする",
-          "name": "force",
-          "required": false,
-          "allowNo": false,
-          "type": "boolean"
-        },
-        "issuesOnly": {
-          "description": "課題のみを更新する",
-          "name": "issuesOnly",
+        "output": {
+          "char": "o",
+          "description": "出力ディレクトリパス",
+          "name": "output",
           "required": false,
-          "allowNo": false,
-          "type": "boolean"
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
         },
         "projectIdOrKey": {
           "description": "Backlog project ID or key",
           "name": "projectIdOrKey",
-          "required": false,
+          "required": true,
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
-        },
-        "wikisOnly": {
-          "description": "Wikiのみを更新する",
-          "name": "wikisOnly",
-          "required": false,
-          "allowNo": false,
-          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "update",
+      "id": "issue",
       "pluginAlias": "backlog-exporter",
       "pluginName": "backlog-exporter",
       "pluginType": "core",
@@ -135,17 +114,25 @@
       "relativePath": [
         "dist",
         "commands",
-        "update",
+        "issue",
         "index.js"
       ]
     },
-    "issue": {
+    "update": {
       "aliases": [],
-      "args": {},
-      "description": "Backlogから課題を取得してMarkdownファイルとして保存する",
+      "args": {
+        "directory": {
+          "description": "更新対象のディレクトリ（設定ファイルが保存されている場所）",
+          "name": "directory",
+          "required": false
+        }
+      },
+      "description": "Backlogから最新データを取得して更新する",
       "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-project\n指定したディレクトリに課題を保存する\n"
+        "<%= 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"
       ],
       "flags": {
         "apiKey": {
@@ -159,32 +146,45 @@
         "domain": {
           "description": "Backlog domain (e.g. example.backlog.jp)",
           "name": "domain",
-          "required": true,
+          "required": false,
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
-        "output": {
-          "char": "o",
-          "description": "出力ディレクトリパス",
-          "name": "output",
+        "force": {
+          "char": "f",
+          "description": "確認プロンプトをスキップする",
+          "name": "force",
           "required": false,
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "issuesOnly": {
+          "description": "課題のみを更新する",
+          "name": "issuesOnly",
+          "required": false,
+          "allowNo": false,
+          "type": "boolean"
         },
         "projectIdOrKey": {
           "description": "Backlog project ID or key",
           "name": "projectIdOrKey",
-          "required": true,
+          "required": false,
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
+        },
+        "wikisOnly": {
+          "description": "Wikiのみを更新する",
+          "name": "wikisOnly",
+          "required": false,
+          "allowNo": false,
+          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "issue",
+      "id": "update",
       "pluginAlias": "backlog-exporter",
       "pluginName": "backlog-exporter",
       "pluginType": "core",
@@ -194,7 +194,7 @@
       "relativePath": [
         "dist",
         "commands",
-        "issue",
+        "update",
         "index.js"
       ]
     },
@@ -258,5 +258,5 @@
       ]
     }
   },
-  "version": "0.1.1"
+  "version": "0.2.0"
 }

package/package.json

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