backlog-exporter 0.6.1 → 0.7.0

package/oclif.manifest.json

@@ -1,386 +1,4 @@
 {
-  "commands": {
-    "all": {
-      "aliases": [],
-      "args": {},
-      "description": "Backlogから課題・Wiki・ドキュメントを取得してMarkdownファイルとして保存する",
-      "examples": [
-        "<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY\n課題・Wiki・ドキュメントをMarkdownファイルとして保存する\n",
-        "<%= 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"
-      ],
-      "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": true,
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "exclude": {
-          "description": "Exclude the specified types, separated by commas (e.g., 'documents,wiki')",
-          "name": "exclude",
-          "required": false,
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "maxCount": {
-          "char": "m",
-          "description": "一度に取得する課題の最大数（デフォルト: 5000）",
-          "name": "maxCount",
-          "required": false,
-          "default": 5000,
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "only": {
-          "description": "Export only the specified types, separated by commas (e.g., 'issues,wiki')",
-          "name": "only",
-          "required": false,
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "output": {
-          "char": "o",
-          "description": "出力ディレクトリパス",
-          "name": "output",
-          "required": false,
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "projectIdOrKey": {
-          "description": "Backlog project ID or key",
-          "name": "projectIdOrKey",
-          "required": true,
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        }
-      },
-      "hasDynamicHelp": false,
-      "hiddenAliases": [],
-      "id": "all",
-      "pluginAlias": "backlog-exporter",
-      "pluginName": "backlog-exporter",
-      "pluginType": "core",
-      "strict": true,
-      "enableJsonFlag": false,
-      "isESM": true,
-      "relativePath": [
-        "dist",
-        "commands",
-        "all",
-        "index.js"
-      ]
-    },
-    "document": {
-      "aliases": [],
-      "args": {},
-      "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"
-      ],
-      "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": true,
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "keyword": {
-          "description": "検索キーワード",
-          "name": "keyword",
-          "required": false,
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "output": {
-          "char": "o",
-          "description": "出力ディレクトリパス",
-          "name": "output",
-          "required": false,
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "projectIdOrKey": {
-          "description": "Backlog project ID or key",
-          "name": "projectIdOrKey",
-          "required": true,
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        }
-      },
-      "hasDynamicHelp": false,
-      "hiddenAliases": [],
-      "id": "document",
-      "pluginAlias": "backlog-exporter",
-      "pluginName": "backlog-exporter",
-      "pluginType": "core",
-      "strict": true,
-      "enableJsonFlag": false,
-      "isESM": true,
-      "relativePath": [
-        "dist",
-        "commands",
-        "document",
-        "index.js"
-      ]
-    },
-    "issue": {
-      "aliases": [],
-      "args": {},
-      "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"
-      ],
-      "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": true,
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "maxCount": {
-          "char": "m",
-          "description": "一度に取得する課題の最大数（デフォルト: 5000）",
-          "name": "maxCount",
-          "required": false,
-          "default": 5000,
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "output": {
-          "char": "o",
-          "description": "出力ディレクトリパス",
-          "name": "output",
-          "required": false,
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "projectIdOrKey": {
-          "description": "Backlog project ID or key",
-          "name": "projectIdOrKey",
-          "required": true,
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "statusId": {
-          "description": "ステータスID（カンマ区切りで複数指定可能）",
-          "name": "statusId",
-          "required": false,
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        }
-      },
-      "hasDynamicHelp": false,
-      "hiddenAliases": [],
-      "id": "issue",
-      "pluginAlias": "backlog-exporter",
-      "pluginName": "backlog-exporter",
-      "pluginType": "core",
-      "strict": true,
-      "enableJsonFlag": false,
-      "isESM": true,
-      "relativePath": [
-        "dist",
-        "commands",
-        "issue",
-        "index.js"
-      ]
-    },
-    "update": {
-      "aliases": [],
-      "args": {
-        "directory": {
-          "description": "更新対象のディレクトリ（設定ファイルが保存されている場所）",
-          "name": "directory",
-          "required": false
-        }
-      },
-      "description": "Backlogから最新データを取得して更新する",
-      "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"
-      ],
-      "flags": {
-        "apiKey": {
-          "description": "Backlog API key (環境変数 BACKLOG_API_KEY からも自動読み取り可能)",
-          "name": "apiKey",
-          "required": false,
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "documentsOnly": {
-          "description": "ドキュメントのみを更新する",
-          "name": "documentsOnly",
-          "required": false,
-          "allowNo": false,
-          "type": "boolean"
-        },
-        "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"
-        },
-        "issuesOnly": {
-          "description": "課題のみを更新する",
-          "name": "issuesOnly",
-          "required": false,
-          "allowNo": false,
-          "type": "boolean"
-        },
-        "projectIdOrKey": {
-          "description": "Backlog project ID or key",
-          "name": "projectIdOrKey",
-          "required": false,
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "wikisOnly": {
-          "description": "Wikiのみを更新する",
-          "name": "wikisOnly",
-          "required": false,
-          "allowNo": false,
-          "type": "boolean"
-        }
-      },
-      "hasDynamicHelp": false,
-      "hiddenAliases": [],
-      "id": "update",
-      "pluginAlias": "backlog-exporter",
-      "pluginName": "backlog-exporter",
-      "pluginType": "core",
-      "strict": true,
-      "enableJsonFlag": false,
-      "isESM": true,
-      "relativePath": [
-        "dist",
-        "commands",
-        "update",
-        "index.js"
-      ]
-    },
-    "wiki": {
-      "aliases": [],
-      "args": {},
-      "description": "Backlogから Wiki を取得してMarkdownファイルとして保存する",
-      "examples": [
-        "<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY\nWikiをダウンロードする\n",
-        "<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --output ./my-project\n指定したディレクトリにWikiを保存する\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": true,
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "output": {
-          "char": "o",
-          "description": "出力ディレクトリパス",
-          "name": "output",
-          "required": false,
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "projectIdOrKey": {
-          "description": "Backlog project ID or key",
-          "name": "projectIdOrKey",
-          "required": true,
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        }
-      },
-      "hasDynamicHelp": false,
-      "hiddenAliases": [],
-      "id": "wiki",
-      "pluginAlias": "backlog-exporter",
-      "pluginName": "backlog-exporter",
-      "pluginType": "core",
-      "strict": true,
-      "enableJsonFlag": false,
-      "isESM": true,
-      "relativePath": [
-        "dist",
-        "commands",
-        "wiki",
-        "index.js"
-      ]
-    }
-  },
-  "version": "0.6.1"
+  "commands": {},
+  "version": "0.7.0"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "backlog-exporter",
   "description": "A new CLI generated with oclif",
-  "version": "0.6.1",
+  "version": "0.7.0",
   "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",

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

@@ -1,15 +0,0 @@
-import { Command } from '@oclif/core';
-export default class All extends Command {
-    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, import("@oclif/core/interfaces").CustomOptions>;
-        exclude: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
-        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>;
-        projectIdOrKey: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
-    };
-    run(): Promise<void>;
-}

package/dist/commands/all/index.js

@@ -1,189 +0,0 @@
-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';
-// .envファイルを読み込む
-dotenv.config();
-export default class All extends Command {
-    static description = 'Backlogから課題・Wiki・ドキュメントを取得してMarkdownファイルとして保存する';
-    static examples = [
-        `<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY
-課題・Wiki・ドキュメントをMarkdownファイルとして保存する
-`,
-        `<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --output ./my-project
-指定したディレクトリに課題・Wiki・ドキュメントを保存する
-`,
-        `<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --only issues,wiki
-課題とWikiのみを取得する
-`,
-        `<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --exclude documents
-ドキュメント以外（課題とWiki）を取得する
-`,
-        `<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --maxCount 1000
-最大1000件の課題を取得する（デフォルトは5000件）
-`,
-    ];
-    static flags = {
-        apiKey: Flags.string({
-            description: 'Backlog API key (環境変数 BACKLOG_API_KEY からも自動読み取り可能)',
-            required: false,
-        }),
-        domain: Flags.string({
-            description: 'Backlog domain (e.g. example.backlog.jp)',
-            required: true,
-        }),
-        exclude: Flags.string({
-            description: "Exclude the specified types, separated by commas (e.g., 'documents,wiki')",
-            required: false,
-        }),
-        maxCount: Flags.integer({
-            char: 'm',
-            default: 5000,
-            description: '一度に取得する課題の最大数（デフォルト: 5000）',
-            required: false,
-        }),
-        only: Flags.string({
-            description: "Export only the specified types, separated by commas (e.g., 'issues,wiki')",
-            required: false,
-        }),
-        output: Flags.string({
-            char: 'o',
-            description: '出力ディレクトリパス',
-            required: false,
-        }),
-        projectIdOrKey: Flags.string({
-            description: 'Backlog project ID or key',
-            required: true,
-        }),
-    };
-    async run() {
-        const { flags } = await this.parse(All);
-        try {
-            const { domain, exclude, maxCount, only, projectIdOrKey } = flags;
-            const apiKey = flags.apiKey || getApiKey(this);
-            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,
-                    outputDir: issueOutput,
-                    projectIdOrKey,
-                });
-                // 課題の取得と保存
-                this.log('課題の取得を開始します...');
-                await downloadIssues(this, {
-                    apiKey,
-                    count: maxCount,
-                    domain,
-                    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('ドキュメントの取得が完了しました');
-            }
-            this.log('すべてのデータの取得が完了しました！');
-        }
-        catch (error) {
-            const errorMessage = error instanceof Error ? error.message : String(error);
-            this.error(`データの取得に失敗しました: ${errorMessage}`);
-        }
-    }
-}

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

@@ -1,13 +0,0 @@
-import { Command } from '@oclif/core';
-export default class Document extends Command {
-    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, import("@oclif/core/interfaces").CustomOptions>;
-        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>;
-    };
-    run(): Promise<void>;
-}