util: new XIVAPI CLI query tool

docs/PatchUpdateChecklist.md

@@ -32,6 +32,11 @@ in the console as the scripts are run.
 It is recommended that you choose at least the 'Alert' level to ensure you are notified
 of any problems that require manual intervetion before merging the file changes.
 
+If you run into collisions or other data issues that require resolution before merge,
+you can use the XIVAPI CLI helper utility to request and filter XIVAPI data --
+and see it as JSON console output -- by running `npm run query`.
+Use `npm run query -- -h` for info on how to use the utility.
+
 #### effect_id data
 
 As new status effects are added to the game, those names may conflict with existing names.

package.json

@@ -38,6 +38,7 @@
     "find-translations": "npm run util -- findTranslations",
     "translate-timeline": "npm run util -- translateTimeline",
     "generate": "npm run util -- generate",
+    "query": "npm run util -- query",
     "process-triggers": "node --loader=ts-node/esm util/process_triggers_folder.ts",
     "generate-log-guide": "node --loader=ts-node/esm util/gen_log_guide.ts",
     "validate-versions": "node --loader=ts-node/esm util/validate_versions.ts",

util/console_logger.ts

@@ -68,4 +68,8 @@ export class ConsoleLogger {
     console.log(`ERROR: ${msg} Exiting...`);
     process.exit(1);
   }
+
+  printNoHeader(msg: string): void {
+    console.log(`${msg}`);
+  }
 }

util/index.ts

@@ -4,6 +4,7 @@ import inquirerFuzzyPath, { FuzzyPathQuestionOptions } from 'inquirer-fuzzy-path
 
 import { registerFindMissingTranslations } from './find_missing_translations_action';
 import { registerGenerateDataFiles } from './generate_data_files';
+import { registerQueryXivApi } from './query_xivapi';
 import { registerTranslateTimeline } from './translate_timeline';
 
 declare module 'inquirer' {
@@ -34,6 +35,7 @@ const subparsers = argumentParser.addSubparsers({
 registerTranslateTimeline(actionChoices, subparsers);
 registerGenerateDataFiles(actionChoices, subparsers);
 registerFindMissingTranslations(actionChoices, subparsers);
+registerQueryXivApi(actionChoices, subparsers);
 
 inquirer.registerPrompt('fuzzypath', inquirerFuzzyPath);