feat: provide better raw output handling (#16)

* chore(deps): bump sdk to version 1.2.1

* lib(util): add data output utility

* feat: add `--pretty` option for json output

* refractor: replace raw output strategy

* chore(release): bump package version to 1.3.0

commands/events.ts

@@ -4,6 +4,7 @@ import type { Command } from "commander";
 import HellHub, { type GlobalEvent } from "@hellhub-collective/sdk";
 
 import ascii from "utils/ascii";
+import output from "utils/output";
 import request from "utils/request";
 import interval from "utils/interval";
 import { createListCommand, parseListOptions } from "utils/options";
@@ -54,7 +55,7 @@ export default function events(program: Command) {
     });
 
     if (!!args[1].raw) {
-      console.log(data);
+      output(data, !!args[1].pretty);
       process.exit(0);
     }
 

commands/major.ts

@@ -5,6 +5,7 @@ import type { Command } from "commander";
 import HellHub, { type Assignment } from "@hellhub-collective/sdk";
 
 import ascii from "utils/ascii";
+import output from "utils/output";
 import request from "utils/request";
 import interval from "utils/interval";
 import { createListCommand, parseListOptions } from "utils/options";
@@ -23,7 +24,7 @@ export default function major(program: Command) {
     });
 
     if (!!args[1].raw) {
-      console.log(data);
+      output(data, !!args[1].pretty);
       process.exit(0);
     }
 

commands/planets.ts

@@ -5,6 +5,7 @@ import { formatMoney } from "accounting";
 import HellHub, { type Planet } from "@hellhub-collective/sdk";
 
 import ascii from "utils/ascii";
+import output from "utils/output";
 import request from "utils/request";
 import interval from "utils/interval";
 import { createListCommand, parseListOptions } from "utils/options";
@@ -35,7 +36,7 @@ export default function planets(program: Command) {
     });
 
     if (!!args[1].raw) {
-      console.log(data);
+      output(data, !!args[1].pretty);
       process.exit(0);
     }
 

commands/reports.ts

@@ -4,6 +4,7 @@ import type { Command } from "commander";
 import HellHub, { type Report } from "@hellhub-collective/sdk";
 
 import ascii from "utils/ascii";
+import output from "utils/output";
 import request from "utils/request";
 import interval from "utils/interval";
 import { createListCommand, parseListOptions } from "utils/options";
@@ -54,7 +55,7 @@ export default function reports(program: Command) {
     });
 
     if (!!args[1].raw) {
-      console.log(data);
+      output(data, !!args[1].pretty);
       process.exit(0);
     }
 

commands/sectors.ts

@@ -4,6 +4,7 @@ import type { Command } from "commander";
 import HellHub, { type Sector } from "@hellhub-collective/sdk";
 
 import ascii from "utils/ascii";
+import output from "utils/output";
 import request from "utils/request";
 import interval from "utils/interval";
 import { createListCommand, parseListOptions } from "utils/options";
@@ -17,7 +18,7 @@ export default function sectors(program: Command) {
     });
 
     if (!!args[1].raw) {
-      console.log(data);
+      output(data, !!args[1].pretty);
       process.exit(0);
     }
 

commands/statistics.ts

@@ -5,6 +5,7 @@ import type { Command } from "commander";
 import HellHub, { type Stat } from "@hellhub-collective/sdk";
 
 import ascii from "utils/ascii";
+import output from "utils/output";
 import request from "utils/request";
 import interval from "utils/interval";
 import { createListCommand, parseListOptions } from "utils/options";
@@ -19,7 +20,7 @@ export default function statistics(program: Command) {
     });
 
     if (!!args[1].raw) {
-      console.log(data);
+      output(data, !!args[1].pretty);
       process.exit(0);
     }
 

commands/stratagems.ts

@@ -4,6 +4,7 @@ import type { Command } from "commander";
 import HellHub, { type Stratagem } from "@hellhub-collective/sdk";
 
 import ascii from "utils/ascii";
+import output from "utils/output";
 import request from "utils/request";
 import interval from "utils/interval";
 import { createListCommand, parseListOptions } from "utils/options";
@@ -17,7 +18,7 @@ export default function stratagems(program: Command) {
     });
 
     if (!!args[1].raw) {
-      console.log(data);
+      output(data, !!args[1].pretty);
       process.exit(0);
     }
 

package.json

@@ -3,7 +3,7 @@
   "license": "MIT",
   "private": false,
   "description": "A CLI for Helldivers 2: View the war progress without leaving your terminal! Powered by the HellHub API.",
-  "version": "1.2.6",
+  "version": "1.3.0",
   "main": "build/index.mjs",
   "types": "build/index.d.ts",
   "keywords": [
@@ -54,7 +54,7 @@
     "email": "[email protected]"
   },
   "dependencies": {
-    "@hellhub-collective/sdk": "latest",
+    "@hellhub-collective/sdk": "^1.2.1",
     "accounting": "^0.4.1",
     "boxen": "^7.1.1",
     "chalk": "^5.3.0",

utils/options.ts

@@ -14,8 +14,9 @@ export function createListCommand(
     .argument("[id]", "the id of the entry to be fetched")
     .option("-u, --url [boolean]", "prints the request url")
     .option("-o, --order-by <string>", "the field to order by")
-    .option("-r, --raw [boolean]", "outputs the raw response body")
     .option("-a, --no-ascii [boolean]", "disables the ascii art headers")
+    .option("-r, --raw [boolean]", "outputs the raw response data as json")
+    .option("-p, --pretty [boolean]", "use with --raw to pretty print the json")
     .option("-s, --start <number>", "the number of entries to skip", parseInt)
     .option("-l, --limit <number>", "the number of entries to fetch", parseInt)
     .option(

utils/output.ts

@@ -0,0 +1,5 @@
+import type { Entity } from "@hellhub-collective/sdk";
+
+export default function output(data: Entity | Array<Entity>, pretty = true) {
+  console.log(JSON.stringify(data, null, pretty ? 1 : 0));
+}