Add support for generating cache diff pages (#3)

* Add support for detecting file-level changes between two caches

* diff items

* Compile resulting cache changes into one resulting object

* start of index name mapping

* Basic support for struct differences

* Add support for including added and removed files in resulting diffs

* Set up supported PerFileLoadable columns for builder

* Add build output for added diffs

* Add changed diff building

* Fix various styling bugs

* Add support for structs, enums, params, and dbrows

* changesets

* Comments

.changeset/giant-rings-pull.md

@@ -0,0 +1,5 @@
+---
+"@osrs-wiki/cache-mediawiki": minor
+---
+
+Add support for loading different cache versions

.changeset/light-dolls-sort.md

@@ -0,0 +1,5 @@
+---
+"@osrs-wiki/cache-mediawiki": minor
+---
+
+Add support for writing cache differences to a wiki page.

.changeset/many-jars-explode.md

@@ -0,0 +1,5 @@
+---
+"@osrs-wiki/cache-mediawiki": minor
+---
+
+Add support for detecting cache differences in indices, archives, and files

.github/workflows/workflow-dispatch.yml

@@ -1,4 +1,4 @@
-name: Run News Scraper
+name: Run Cache Tasks
 
 on:
   workflow_dispatch:
@@ -11,6 +11,14 @@ on:
         description: "Infobox type (optional)"
         required: false
 
+      oldCache:
+        description: "Old cache date (optional)"
+        required: false
+
+      newCache:
+        description: "New cache date (optional)"
+        required: false
+
 jobs:
   scrapeNews:
     runs-on: ubuntu-latest
@@ -30,7 +38,7 @@ jobs:
         run: yarn build
 
       - name: Run task
-        run: yarn start:node -t ${{ github.event.inputs.task }} -infobox ${{ github.event.inputs.infobox }}
+        run: yarn start:node -t ${{ github.event.inputs.task }} --infobox ${{ github.event.inputs.infobox }} --oldCache ${{ github.event.inputs.oldCache }} --newCache ${{ github.event.inputs.newCache }}
 
       - name: Upload Output
         uses: actions/upload-artifact@v3

package.json

@@ -26,7 +26,7 @@
   },
   "homepage": "https://github.com/osrs-wiki/cache-mediawiki#readme",
   "dependencies": {
-    "@osrs-wiki/mediawiki-builder": "^1.1.2",
+    "@osrs-wiki/mediawiki-builder": "^1.2.0",
     "dotenv": "^16.4.1",
     "fflate": "^0.8.1",
     "tsconfig-paths": "^4.2.0",
@@ -55,7 +55,7 @@
     "ts-jest": "^28.0.8",
     "ts-node": "^10.9.1",
     "ts-patch": "^2.1.0",
-    "typescript": "^4.6.3"
+    "typescript": "^5.3.2"
   },
   "lint-staged": {
     "src/**/*.{js,ts}": [

src/index.ts

@@ -2,15 +2,21 @@ import config from "@config";
 import { parseArgs } from "node:util";
 
 import generateCluePages from "./scripts/clues";
-import differences from "./scripts/difference/difference";
+import differencesCache from "./scripts/differences/differences";
 import infoboxGenerator from "./scripts/infoboxGenernator";
 
 console.log(`Running ${config.environment}`);
 
 const {
-  values: { task, infobox },
+  values: { oldCache, newCache, task, infobox },
 } = parseArgs({
   options: {
+    oldCache: {
+      type: "string",
+    },
+    newCache: {
+      type: "string",
+    },
     task: {
       type: "string",
       short: "t",
@@ -21,8 +27,8 @@ const {
   },
 });
 
-if (task === "differences") {
-  differences();
+if (task === "differences" || (task === "diffs" && oldCache)) {
+  differencesCache(oldCache, newCache);
 } else if (task === "infobox" && infobox) {
   infoboxGenerator(infobox);
 } else if (task === "clues") {

src/scripts/clues/utils.ts

@@ -21,11 +21,11 @@ export const getCacheProvider = async () => {
   });
 };
 
-export const getCacheProviderGithub = async () => {
+export const getCacheProviderGithub = async (version = "master") => {
   return new FlatCacheProvider({
     async getFile(name) {
       const req = await fetch(
-        `https://raw.githubusercontent.com/abextm/osrs-cache/master/${name}`
+        `https://raw.githubusercontent.com/abextm/osrs-cache/${version}/${name}`
       );
       if (!req.ok) {
         return;