feat: add --with-external-source option to use fallback source (services.api, rss feeds)

Author: mob-sakai

.vscode/launch.json

@@ -1,6 +1,18 @@
 {
   "version": "0.2.0",
   "configurations": [
+    {
+      "request": "launch",
+      "name": "list --with-external-source",
+      "type": "node",
+      "program": "${workspaceFolder}/src/cli.ts",
+      "cwd": "${workspaceFolder}",
+      "env": {},
+      "runtimeExecutable": "deno",
+      "runtimeArgs": ["run", "--unstable", "--inspect-brk", "--allow-all"],
+      "args": ["list", "--with-external-source"],
+      "attachSimplePort": 9229
+    },
     {
       "request": "launch",
       "name": "list",
@@ -9,15 +21,8 @@
       "cwd": "${workspaceFolder}",
       "env": {},
       "runtimeExecutable": "deno",
-      "runtimeArgs": [
-        "run",
-        "--unstable",
-        "--inspect-brk",
-        "--allow-all"
-      ],
-      "args": [
-        "list"
-      ],
+      "runtimeArgs": ["run", "--unstable", "--inspect-brk", "--allow-all"],
+      "args": ["list"],
       "attachSimplePort": 9229
     },
     {
@@ -28,18 +33,8 @@
       "cwd": "${workspaceFolder}",
       "env": {},
       "runtimeExecutable": "deno",
-      "runtimeArgs": [
-        "run",
-        "--unstable",
-        "--inspect-brk",
-        "--allow-all"
-      ],
-      "args": [
-        "list",
-        "--versions",
-        "--all",
-        "--all-lifecycles"
-      ],
+      "runtimeArgs": ["run", "--unstable", "--inspect-brk", "--allow-all"],
+      "args": ["list", "--versions", "--all", "--all-lifecycles"],
       "attachSimplePort": 9229
     },
     {
@@ -50,15 +45,8 @@
       "cwd": "${workspaceFolder}",
       "env": {},
       "runtimeExecutable": "deno",
-      "runtimeArgs": [
-        "run",
-        "--unstable",
-        "--inspect-brk",
-        "--allow-all"
-      ],
-      "args": [
-        "6000.0.25f1"
-      ],
+      "runtimeArgs": ["run", "--unstable", "--inspect-brk", "--allow-all"],
+      "args": ["6000.0.25f1"],
       "attachSimplePort": 9229
     },
     {
@@ -69,15 +57,8 @@
       "cwd": "${workspaceFolder}",
       "env": {},
       "runtimeExecutable": "deno",
-      "runtimeArgs": [
-        "run",
-        "--unstable",
-        "--inspect-brk",
-        "--allow-all"
-      ],
-      "args": [
-        "6000.0.25f2"
-      ],
+      "runtimeArgs": ["run", "--unstable", "--inspect-brk", "--allow-all"],
+      "args": ["6000.0.25f2"],
       "attachSimplePort": 9229
     },
     {
@@ -88,15 +69,8 @@
       "cwd": "${workspaceFolder}",
       "env": {},
       "runtimeExecutable": "deno",
-      "runtimeArgs": [
-        "run",
-        "--unstable",
-        "--inspect-brk",
-        "--allow-all"
-      ],
-      "args": [
-        "--help"
-      ],
+      "runtimeArgs": ["run", "--unstable", "--inspect-brk", "--allow-all"],
+      "args": ["--help"],
       "attachSimplePort": 9229
     }
   ]

README.md

@@ -114,6 +114,7 @@ deno install -A -f -n unity-changeset https://deno.land/x/unity_changeset/src/cl
     -h, --help     - Show this help.
     -V, --version  - Show the version number for this program.
     --db [url]     - Use cached database instead of GraphQL API. If `url` is not specified, use the default database.
+    --with-external-source  - Merge external Unity release sources into the database or GraphQL results.
 ```
 
 ```
@@ -156,6 +157,7 @@ deno install -A -f -n unity-changeset https://deno.land/x/unity_changeset/src/cl
     --minor-version-only, --minor-versions  - Outputs only the minor version (no changesets)
     --json                                  - Output in json format
     --pretty-json                           - Output in pretty json format
+    --with-external-source                  - Merge external Unity release sources into the database or GraphQL results.
 ```
 
 ### Get a changeset for specific version:
@@ -165,6 +167,13 @@ $ unity-changeset 2020.2.14f1
 d81f64f5201d
 ```
 
+### Get a changeset for specific version with external sources:
+
+```sh
+$ unity-changeset 2020.2.14f1 --with-external-source
+d81f64f5201d
+```
+
 ### Get a changeset for specific version
 
 ```sh
@@ -259,6 +268,16 @@ $ unity-changeset list --latest-patch
 2017.1.5f1      9758a36cfaa6
 ```
 
+### List changesets with external sources
+
+This option merges changesets from Unity's public release API at `services.api.unity.com` and Unity's RSS feeds.
+
+```sh
+$ unity-changeset list --all --with-external-source
+2020.2.0b13     655e1a328b90
+...
+```
+
 ### Install a specific version of Unity via UnityHub
 
 ```sh

src/cli.ts

@@ -31,8 +31,9 @@ new Command()
   .example("unity-changeset 2018.4.36f1", "Get changeset of Unity 2018.4.36f1 ('6cd387d23174' will be output).")
   .arguments("<version>")
   .option("--db [url]", "Use cached database instead of GraphQL API. If `url` is not specified, use the default database.")
+  .option("--with-external-source", "Merge external Unity release sources into the database or GraphQL results.")
   .action((options, version) => {
-    getUnityChangeset(version, options.db)
+    getUnityChangeset(version, options.db, options.withExternalSource || false)
       .then((c) => console.log(c.changeset))
       .catch(() => {
         console.error("The given version was not found.");
@@ -80,6 +81,7 @@ new Command()
       // Database options.
       .group("Database options")
       .option("--db [url]", "Use cached database instead of GraphQL API. If `url` is not specified, use the default database.")
+      .option("--with-external-source", "Merge external Unity release sources into the database or GraphQL results.")
       .action((options) => {
         // Search mode.
         const searchMode = options.all
@@ -126,7 +128,15 @@ new Command()
             ? FormatMode.PrettyJson
             : FormatMode.None;
 
-        listChangesets(searchMode, filterOptions, groupMode, outputMode, formatMode, options.db)
+        listChangesets(
+          searchMode,
+          filterOptions,
+          groupMode,
+          outputMode,
+          formatMode,
+          options.db,
+          options.withExternalSource || false,
+        )
           .then((result) => console.log(result));
       }),
   )