backlog-exporter 0.0.6 → 0.1.0

package/oclif.manifest.json

@@ -2,16 +2,11 @@
   "commands": {
     "all": {
       "aliases": [],
-      "args": {
-        "url": {
-          "description": "URL to download from",
-          "name": "url",
-          "required": false
-        }
-      },
-      "description": "Backlogからissueとwikiを同時に取得する",
+      "args": {},
+      "description": "Backlogから課題とWikiを取得してMarkdownファイルとして保存する",
       "examples": [
-        "<%= config.bin %> <%= command.id %> --domain cm1.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY -o ./output-dir\nBacklogからAPIキーを使用してissueとwikiを同時に取得する\n"
+        "<%= 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"
       ],
       "flags": {
         "apiKey": {
@@ -22,16 +17,6 @@
           "multiple": false,
           "type": "option"
         },
-        "count": {
-          "char": "c",
-          "description": "一度に取得する課題数",
-          "name": "count",
-          "required": false,
-          "default": 100,
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
         "domain": {
           "description": "Backlog domain (e.g. example.backlog.jp)",
           "name": "domain",
@@ -42,7 +27,7 @@
         },
         "output": {
           "char": "o",
-          "description": "出力ディレクトリのルートパス（デフォルトはプロジェクトキー）",
+          "description": "出力ディレクトリパス",
           "name": "output",
           "required": false,
           "hasDynamicHelp": false,
@@ -56,14 +41,6 @@
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
-        },
-        "statusId": {
-          "description": "Filter issues by status ID",
-          "name": "statusId",
-          "required": false,
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
         }
       },
       "hasDynamicHelp": false,
@@ -82,24 +59,43 @@
         "index.js"
       ]
     },
-    "hello": {
+    "issue": {
       "aliases": [],
-      "args": {
-        "person": {
-          "description": "Person to say hello to",
-          "name": "person",
-          "required": true
-        }
-      },
-      "description": "Say hello",
+      "args": {},
+      "description": "Backlogから課題を取得してMarkdownファイルとして保存する",
       "examples": [
-        "<%= config.bin %> <%= command.id %> friend --from oclif\nhello friend from oclif! (./src/commands/hello/index.ts)\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": {
-        "from": {
-          "char": "f",
-          "description": "Who is saying hello",
-          "name": "from",
+        "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,
@@ -108,7 +104,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "hello",
+      "id": "issue",
       "pluginAlias": "backlog-exporter",
       "pluginName": "backlog-exporter",
       "pluginType": "core",
@@ -118,46 +114,25 @@
       "relativePath": [
         "dist",
         "commands",
-        "hello",
+        "issue",
         "index.js"
       ]
     },
-    "hello:world": {
-      "aliases": [],
-      "args": {},
-      "description": "Say hello world",
-      "examples": [
-        "<%= config.bin %> <%= command.id %>\nhello world! (./src/commands/hello/world.ts)\n"
-      ],
-      "flags": {},
-      "hasDynamicHelp": false,
-      "hiddenAliases": [],
-      "id": "hello:world",
-      "pluginAlias": "backlog-exporter",
-      "pluginName": "backlog-exporter",
-      "pluginType": "core",
-      "strict": true,
-      "enableJsonFlag": false,
-      "isESM": true,
-      "relativePath": [
-        "dist",
-        "commands",
-        "hello",
-        "world.js"
-      ]
-    },
-    "issue": {
+    "update": {
       "aliases": [],
       "args": {
-        "url": {
-          "description": "URL to download from",
-          "name": "url",
+        "directory": {
+          "description": "更新対象のディレクトリ（設定ファイルが保存されている場所）",
+          "name": "directory",
           "required": false
         }
       },
-      "description": "Backlogから課題をダウンロードする",
+      "description": "Backlogから最新データを取得して更新する",
       "examples": [
-        "<%= config.bin %> <%= command.id %> --domain cm1.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --output ./issue-data\nBacklogからAPIキーを使用して課題をダウンロードする\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": {
@@ -168,54 +143,48 @@
           "multiple": false,
           "type": "option"
         },
-        "count": {
-          "char": "c",
-          "description": "一度に取得する課題数",
-          "name": "count",
-          "required": false,
-          "default": 100,
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
         "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,
-          "default": "./backlog-issues",
-          "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"
         },
-        "statusId": {
-          "description": "Filter issues by status ID",
-          "name": "statusId",
+        "wikisOnly": {
+          "description": "Wikiのみを更新する",
+          "name": "wikisOnly",
           "required": false,
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
+          "allowNo": false,
+          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "issue",
+      "id": "update",
       "pluginAlias": "backlog-exporter",
       "pluginName": "backlog-exporter",
       "pluginType": "core",
@@ -225,22 +194,17 @@
       "relativePath": [
         "dist",
         "commands",
-        "issue",
+        "update",
         "index.js"
       ]
     },
     "wiki": {
       "aliases": [],
-      "args": {
-        "url": {
-          "description": "URL to download from",
-          "name": "url",
-          "required": false
-        }
-      },
-      "description": "BacklogからWikiコンテンツをダウンロードする",
+      "args": {},
+      "description": "Backlogから Wiki を取得してMarkdownファイルとして保存する",
       "examples": [
-        "<%= config.bin %> <%= command.id %> --domain cm1.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --output ./wiki-data\nBacklogからAPIキーを使用してWikiコンテンツをダウンロードする\n"
+        "<%= 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": {
@@ -264,7 +228,6 @@
           "description": "出力ディレクトリパス",
           "name": "output",
           "required": false,
-          "default": "./backlog-wiki",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
@@ -295,5 +258,5 @@
       ]
     }
   },
-  "version": "0.0.6"
+  "version": "0.1.0"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "backlog-exporter",
   "description": "A new CLI generated with oclif",
-  "version": "0.0.6",
+  "version": "0.1.0",
   "author": "ShuntaToda",
   "bin": {
     "backlog-exporter": "bin/run.js"
@@ -57,8 +57,8 @@
     ],
     "topicSeparator": " ",
     "topics": {
-      "hello": {
-        "description": "Say hello to the world and others"
+      "update": {
+        "description": "Backlogから最新データを取得して更新する"
       }
     }
   },

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

@@ -1,12 +0,0 @@
-import { Command } from '@oclif/core';
-export default class Hello extends Command {
-    static args: {
-        person: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
-    };
-    static description: string;
-    static examples: string[];
-    static flags: {
-        from: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
-    };
-    run(): Promise<void>;
-}

package/dist/commands/hello/index.js

@@ -1,19 +0,0 @@
-import { Args, Command, Flags } from '@oclif/core';
-export default class Hello extends Command {
-    static args = {
-        person: Args.string({ description: 'Person to say hello to', required: true }),
-    };
-    static description = 'Say hello';
-    static examples = [
-        `<%= config.bin %> <%= command.id %> friend --from oclif
-hello friend from oclif! (./src/commands/hello/index.ts)
-`,
-    ];
-    static flags = {
-        from: Flags.string({ char: 'f', description: 'Who is saying hello', required: true }),
-    };
-    async run() {
-        const { args, flags } = await this.parse(Hello);
-        this.log(`hello ${args.person} from ${flags.from}! (./src/commands/hello/index.ts)`);
-    }
-}

package/dist/commands/hello/world.d.ts

@@ -1,8 +0,0 @@
-import { Command } from '@oclif/core';
-export default class World extends Command {
-    static args: {};
-    static description: string;
-    static examples: string[];
-    static flags: {};
-    run(): Promise<void>;
-}

package/dist/commands/hello/world.js

@@ -1,14 +0,0 @@
-import { Command } from '@oclif/core';
-export default class World extends Command {
-    static args = {};
-    static description = 'Say hello world';
-    static examples = [
-        `<%= config.bin %> <%= command.id %>
-hello world! (./src/commands/hello/world.ts)
-`,
-    ];
-    static flags = {};
-    async run() {
-        this.log('hello world! (./src/commands/hello/world.ts)');
-    }
-}