Added lint task and enforced code style in static_generation and test.

.eslintrc.json

@@ -22,6 +22,10 @@
         "@typescript-eslint/explicit-member-accessibility": "off",
         "@typescript-eslint/no-explicit-any": "off",
         "@typescript-eslint/no-inferrable-types": "warn",
+        "@typescript-eslint/no-object-literal-type-assertion": [
+            "warn",
+            { "allowAsParameter": true }
+        ],
         "@typescript-eslint/no-parameter-properties": "off",
         "@typescript-eslint/no-use-before-define": "off",
         "@typescript-eslint/prefer-interface": "off",

package.json

@@ -34,7 +34,8 @@
     "build": "craco build",
     "test": "craco test",
     "update_generic_data": "ts-node --project=tsconfig-scripts.json static_generation/update_generic_data.ts",
-    "update_ephinea_data": "ts-node --project=tsconfig-scripts.json static_generation/update_ephinea_data.ts"
+    "update_ephinea_data": "ts-node --project=tsconfig-scripts.json static_generation/update_ephinea_data.ts",
+    "lint": "prettier --check \"{src,static_generation,test}/**/*.{ts,tsx}\" && eslint \"{src,static_generation,test}/**/*.{ts,tsx}\" && echo All code passes the prettier and eslint checks."
   },
   "eslintConfig": {
     "extends": "react-app"

src/data_formats/BufferCursor.test.ts

@@ -47,7 +47,7 @@ test("reallocation of internal buffer when necessary", () => {
     expect(cursor.buffer.byteLength).toBeGreaterThanOrEqual(4);
 });
 
-function test_integer_read(method_name: string) {
+function test_integer_read(method_name: string): void {
     test(method_name, () => {
         const bytes = parseInt(method_name.replace(/^[iu](\d+)$/, "$1"), 10) / 8;
         let test_number_1 = 0;
@@ -98,7 +98,7 @@ test("u8_array", () => {
     expect(cursor.seek_start(5).u8_array(3)).toEqual([6, 7, 8]);
 });
 
-function test_string_read(method_name: string, char_size: number) {
+function test_string_read(method_name: string, char_size: number): void {
     test(method_name, () => {
         const char_array = [7, 65, 66, 0, 255, 13];
 
@@ -145,7 +145,7 @@ function test_string_read(method_name: string, char_size: number) {
 test_string_read("string_ascii", 1);
 test_string_read("string_utf16", 2);
 
-function test_integer_write(method_name: string) {
+function test_integer_write(method_name: string): void {
     test(method_name, () => {
         const bytes = parseInt(method_name.replace(/^write_[iu](\d+)$/, "$1"), 10) / 8;
         let test_number_1 = 0;

src/data_formats/compression/prs/index.test.ts

@@ -1,7 +1,7 @@
 import { BufferCursor } from "../../BufferCursor";
 import { compress, decompress } from "../prs";
 
-function test_with_bytes(bytes: number[], expected_compressed_size: number) {
+function test_with_bytes(bytes: number[], expected_compressed_size: number): void {
     const cursor = new BufferCursor(new Uint8Array(bytes).buffer, true);
 
     for (const byte of bytes) {
@@ -38,7 +38,7 @@ test("PRS compression and decompression, worst case", () => {
     const prng = new Prng();
 
     // Compression factor: 1.124
-    test_with_bytes(new Array(1000).fill(0).map(_ => prng.next_integer(0, 255)), 1124);
+    test_with_bytes(new Array(1000).fill(0).map(() => prng.next_integer(0, 255)), 1124);
 });
 
 test("PRS compression and decompression, typical case", () => {

src/data_formats/encryption/prc.ts

@@ -48,7 +48,7 @@ class PrcDecryptor {
         return out_cursor;
     }
 
-    private construct_keys(key: number) {
+    private construct_keys(key: number): void {
         this.keys[55] = key;
 
         let idx;
@@ -68,7 +68,7 @@ class PrcDecryptor {
         this.mix_keys();
     }
 
-    private mix_keys() {
+    private mix_keys(): void {
         let ptr = 1;
 
         for (let i = 24; i; --i, ++ptr) {
@@ -82,7 +82,7 @@ class PrcDecryptor {
         }
     }
 
-    private decrypt_u32(data: number) {
+    private decrypt_u32(data: number): number {
         if (this.key_pos === 56) {
             this.mix_keys();
             this.key_pos = 1;

src/data_formats/parsing/quest/index.test.ts

@@ -51,7 +51,7 @@ test("parse_quest and write_quest_qst", () => {
     expect(testable_area_variants(test_quest)).toEqual(testable_area_variants(orig_quest));
 });
 
-function testable_objects(quest: Quest) {
+function testable_objects(quest: Quest): any[][] {
     return quest.objects.map(object => [
         object.area_id,
         object.section_id,
@@ -60,10 +60,10 @@ function testable_objects(quest: Quest) {
     ]);
 }
 
-function testable_npcs(quest: Quest) {
+function testable_npcs(quest: Quest): any[][] {
     return quest.npcs.map(npc => [npc.area_id, npc.section_id, npc.position, npc.type]);
 }
 
-function testable_area_variants(quest: Quest) {
+function testable_area_variants(quest: Quest): any[][] {
     return quest.area_variants.map(av => [av.area.id, av.id]);
 }

static_generation/update_drops_ephinea.ts

@@ -7,7 +7,7 @@ import Logger from "js-logger";
 
 const logger = Logger.get("static/update_drops_ephinea");
 
-export async function update_drops_from_website(item_types: ItemTypeDto[]) {
+export async function update_drops_from_website(item_types: ItemTypeDto[]): Promise<void> {
     logger.info("Updating item drops.");
 
     const normal = await download(item_types, Difficulty.Normal);
@@ -38,15 +38,15 @@ async function download(
     item_types: ItemTypeDto[],
     difficulty: Difficulty,
     difficulty_url: string = Difficulty[difficulty].toLowerCase()
-) {
+): Promise<{ enemy_drops: EnemyDropDto[]; box_drops: BoxDropDto[]; items: Set<string> }> {
     const response = await fetch(`https://ephinea.pioneer2.net/drop-charts/${difficulty_url}/`);
     const body = await response.text();
     const $ = cheerio.load(body);
 
     let episode = 1;
     const data: {
-        enemy_drops: Array<EnemyDropDto>;
-        box_drops: Array<BoxDropDto>;
+        enemy_drops: EnemyDropDto[];
+        box_drops: BoxDropDto[];
         items: Set<string>;
     } = {
         enemy_drops: [],

static_generation/update_ephinea_data.ts

@@ -33,6 +33,10 @@ const RESOURCE_DIR = "./static/resources/ephinea";
  * Used by production code.
  */
 const PUBLIC_DIR = "./public";
+/**
+ * Enable this if we ever get the Ephinea ItemPT.gsl file.
+ */
+const USE_ITEMPT = false;
 
 update().catch(e => logger.error(e));
 
@@ -43,18 +47,21 @@ update().catch(e => logger.error(e));
  *  - Clio is equipable by HUnewearls
  *  - Red Ring has a requirement of 180, not 108
  */
-async function update() {
+async function update(): Promise<void> {
     logger.info("Updating static Ephinea data.");
 
     const unitxt = load_unitxt();
     const item_names = unitxt[1];
     const items = update_items(item_names);
-    await update_drops_from_website(items);
-    update_quests();
 
-    // Use this if we ever get the Ephinea drop files.
-    // const item_pt = await load_item_pt();
-    // await update_drops(item_pt);
+    if (USE_ITEMPT) {
+        const item_pt = await load_item_pt();
+        await update_drops(item_pt);
+    } else {
+        await update_drops_from_website(items);
+    }
+
+    update_quests();
 
     logger.info("Done updating static Ephinea data.");
 }
@@ -72,7 +79,7 @@ async function update() {
  *  - The Value of Money (quest3_e.dat, can't be parsed, luckily doesn't have enemies)
  * Note: The MA4R quests use a random area variation per area from the ABC MA quests. E.g. MA4-1R will use a random caves 2 variation from MA4-1A, MA4-1B or MA4-1C. Same for mines 2 and ruins 2.
  */
-function update_quests() {
+function update_quests(): Promise<void> {
     logger.info("Updating quest data.");
 
     const quests = new Array<QuestDto>();
@@ -97,7 +104,7 @@ function update_quests() {
     logger.info("Done updating quest data.");
 }
 
-function process_quest_dir(path: string, quests: QuestDto[]) {
+function process_quest_dir(path: string, quests: QuestDto[]): void {
     const stat = fs.statSync(path);
 
     if (stat.isFile()) {
@@ -109,7 +116,7 @@ function process_quest_dir(path: string, quests: QuestDto[]) {
     }
 }
 
-function process_quest(path: string, quests: QuestDto[]) {
+function process_quest(path: string, quests: QuestDto[]): void {
     try {
         const buf = fs.readFileSync(path);
         const q = parse_quest(new BufferCursor(buf.buffer, true), true);
@@ -157,7 +164,7 @@ function load_unitxt(): Unitxt {
     return unitxt;
 }
 
-function update_items(item_names: Array<string>): ItemTypeDto[] {
+function update_items(item_names: string[]): ItemTypeDto[] {
     logger.info("Updating item type data.");
 
     const buf = fs.readFileSync(`${RESOURCE_DIR}/ship-config/param/ItemPMT.bin`);
@@ -262,7 +269,7 @@ function update_items(item_names: Array<string>): ItemTypeDto[] {
     return item_types;
 }
 
-function update_drops(item_pt: ItemPt) {
+function update_drops(item_pt: ItemPt): void {
     logger.info("Updating drop data.");
 
     const enemy_drops = new Array<EnemyDropDto>();
@@ -295,7 +302,7 @@ function update_drops(item_pt: ItemPt) {
 type ItemP = {
     dar_table: Map<NpcType, number>;
 };
-type ItemPt = Array<Array<Array<ItemP>>>;
+type ItemPt = ItemP[][][];
 
 async function load_item_pt(): Promise<ItemPt> {
     logger.info("Loading ItemPT.gsl.");
@@ -560,8 +567,8 @@ function load_box_drops(
     difficulty: Difficulty,
     episode: Episode,
     section_id: SectionId
-): Array<BoxDropDto> {
-    const drops: Array<BoxDropDto> = [];
+): BoxDropDto[] {
+    const drops: BoxDropDto[] = [];
     const drops_buf = fs.readFileSync(
         `${RESOURCE_DIR}/login-config/drop/ep${episode}_box_${difficulty}_${section_id}.txt`
     );
@@ -599,7 +606,18 @@ function load_box_drops(
     return drops;
 }
 
-function get_stat_boosts(item_pmt: ItemPmt, stat_boost_index: number) {
+function get_stat_boosts(
+    item_pmt: ItemPmt,
+    stat_boost_index: number
+): {
+    atp: number;
+    ata: number;
+    minEvp: number;
+    minDfp: number;
+    mst: number;
+    hp: number;
+    lck: number;
+} {
     const stat_boost = item_pmt.stat_boosts[stat_boost_index];
     let atp = 0;
     let ata = 0;
@@ -675,7 +693,7 @@ function get_stat_boosts(item_pmt: ItemPmt, stat_boost_index: number) {
     return { atp, ata, minEvp: min_evp, minDfp: min_dfp, mst, hp, lck };
 }
 
-function get_enemy_type(episode: Episode, index: number) {
+function get_enemy_type(episode: Episode, index: number): NpcType | undefined {
     if (episode === Episode.I) {
         return [
             undefined,

static_generation/update_generic_data.ts

@@ -18,7 +18,7 @@ const PUBLIC_DIR = "./public";
 
 update();
 
-function update() {
+function update(): void {
     logger.info("Updating generic static data.");
 
     logger.info("Extracting player animations.");

test/src/utils.ts

@@ -8,7 +8,7 @@ import * as fs from "fs";
 export function walk_qst_files(
     f: (path: string, file_name: string, contents: Buffer) => void,
     dir: string = "test/resources/tethealla_v0.143_quests"
-) {
+): void {
     for (const [path, file] of get_qst_files(dir)) {
         f(path, file, fs.readFileSync(path));
     }