Add prettier integration.

Also formatted files.

Dude `types/barrage.ts` is fuggin gnarly just ignore it.

Author: Sp3cker

.eslintrc.json

@@ -1,3 +1,4 @@
 {
-  "extends": "@augu/eslint-config/ts.js"
+  "plugins": ["prettier"],
+  "extends": ["@augu/eslint-config/ts.js", "plugin:prettier/recommended"]
 }

.prettierignore

@@ -0,0 +1,5 @@
+.github
+build
+bundles
+docs
+node_modules

.prettierrc.json

@@ -0,0 +1,5 @@
+{
+  "singleQuote": true,
+  "printWidth": 100,
+  "semi": true
+}

CONTRIBUTING.md

@@ -0,0 +1,22 @@
+# Contributing
+
+## Formatting & Style 👨‍🎨
+
+### Explanation for using both `eslint` and `prettier`
+
+Code style is handled with `eslint`, but _formatting_ is handled with `prettier`.
+
+\<opinion>&nbsp;
+Though `eslint` can format code, `prettier` is easier to configure for the sole purpose of formatting code _and_ is already assigned as a keyboard shortcut in VS Code for me _and_ it's muscle-memory for me to format before saving.
+
+So that's why there's two formatters.
+\</opinion>
+
+Two packages are crucial in this rigamarole:
+
+- `eslint-plugin-prettier`
+- `eslint-config-prettier` (notice **config** in the name)
+
+The `eslint-plugin-prettier` is an `eslint` plugin that runs `prettier` after fixing code style. `eslint-**config**-prettier` is an `eslint` config that overules and ignores any `eslint` formatting rules, leaving it all up to `prettier` for how the code should look.
+
+Apparently, `eslint-config-prettier` is necessary to prevent `eslint` and `prettier` from bickering; more on [the repo page](https://github.com/prettier/eslint-plugin-prettier#recommended-configuration)

package-lock.json

@@ -47,8 +47,11 @@
         "@typescript-eslint/eslint-plugin": "^5.30.5",
         "@typescript-eslint/parser": "^5.30.5",
         "eslint": "^8.19.0",
+        "eslint-config-prettier": "^8.5.0",
+        "eslint-plugin-prettier": "^4.2.1",
         "jest": "^26.4.2",
         "jest-teamcity": "^1.9.0",
+        "prettier": "^2.7.1",
         "ts-jest": "^26.4.0",
         "typedoc": "^0.22.10",
         "typescript": "^4.1.5"

package.json

@@ -9,26 +9,26 @@ import { check, fetch } from './UpdateChecker';
 import { AzurAPI } from './Client';
 
 export default class Updater {
-    public cron?: NodeJS.Timeout;
-    private client: AzurAPI;
+  public cron?: NodeJS.Timeout;
+  private client: AzurAPI;
 
-    /**
-     * Constructor
-     * @param client AzurAPI instance
-     */
-    constructor(client: AzurAPI) {
-      this.client = client;
-    }
-
-    /**
-     * Check for updates then update and load cache
-     */
-    async update() {
-      const updates = await check();
-      if (updates.length > 0) {
-        this.client.emit('updateAvalible', updates);
-        return Promise.all(updates.map(async (type) => {
+  /**
+   * Constructor
+   * @param client AzurAPI instance
+   */
+  constructor(client: AzurAPI) {
+    this.client = client;
+  }
 
+  /**
+   * Check for updates then update and load cache
+   */
+  async update() {
+    const updates = await check();
+    if (updates.length > 0) {
+      this.client.emit('updateAvalible', updates);
+      return Promise.all(
+        updates.map(async (type) => {
           const raw = JSON.parse(await fetch(data[type])) ?? [];
 
           if (type === 'voicelines') {
@@ -49,44 +49,52 @@ export default class Updater {
             this.client.set(type, raw);
           }
           fs.writeFileSync(local[type], JSON.stringify(raw));
-        }));
-      }
+        })
+      );
     }
+  }
 
-    /**
-     * Start cron job
-     */
-    start() {
-      if (!this.cron) this.client.emit('debug', 'Notify for new data updates enabled. AzurAPI Client will check for data updates every hour.');
-      if (this.cron) clearInterval(this.cron);
-      this.cron = setInterval(() => this.update(), this.client.rate);
-    }
+  /**
+   * Start cron job
+   */
+  start() {
+    if (!this.cron)
+      this.client.emit(
+        'debug',
+        'Notify for new data updates enabled. AzurAPI Client will check for data updates every hour.'
+      );
+    if (this.cron) clearInterval(this.cron);
+    this.cron = setInterval(() => this.update(), this.client.rate);
+  }
 
-    /**
-     * Stop cron job
-     */
-    stop() {
-      if (this.cron) clearInterval(this.cron);
-      this.cron = undefined;
-    }
+  /**
+   * Stop cron job
+   */
+  stop() {
+    if (this.cron) clearInterval(this.cron);
+    this.cron = undefined;
+  }
 
-    /**
-     * Check if folder and JSON files exist then load cache
-     */
-    async init() {
-      if (!fs.existsSync(baseFolder)) fs.mkdirSync(baseFolder);
-      await this.load();
-      this.client.emit('ready');
-    }
+  /**
+   * Check if folder and JSON files exist then load cache
+   */
+  async init() {
+    if (!fs.existsSync(baseFolder)) fs.mkdirSync(baseFolder);
+    await this.load();
+    this.client.emit('ready');
+  }
 
-    /**
-     * Load the cache
-     */
-    load() {
-      for (let i = 0; i < Object.keys(local).length; i++) {
-        let key = Object.keys(local)[i];
-        if (!fs.existsSync(local[key])) return this.update();
-        this.client.set(key as datatype, Object.values(JSON.parse(fs.readFileSync(local[key]).toString()) || []));
-      }
+  /**
+   * Load the cache
+   */
+  load() {
+    for (let i = 0; i < Object.keys(local).length; i++) {
+      let key = Object.keys(local)[i];
+      if (!fs.existsSync(local[key])) return this.update();
+      this.client.set(
+        key as datatype,
+        Object.values(JSON.parse(fs.readFileSync(local[key]).toString()) || [])
+      );
     }
+  }
 }

src/core/CacheUpdater.ts

@@ -7,7 +7,7 @@ import { Chapters } from './api/api_chapter';
 import { Voicelines } from './api/api_voiceline';
 import { datatype } from './Data';
 
-export type Source = 'uncached' | 'local'
+export type Source = 'uncached' | 'local';
 
 export interface CacheOptions {
   source?: Source;
@@ -36,7 +36,7 @@ export class AzurAPI extends EventEmitter {
     equipments: this.equipments,
     chapters: this.chapters,
     voicelines: this.voicelines,
-    barrages: this.barrages
+    barrages: this.barrages,
   };
 
   /**
@@ -46,7 +46,10 @@ export class AzurAPI extends EventEmitter {
   constructor(options?: CacheOptions) {
     super();
     //Make sure people are using Node <=14
-    if (parseFloat(process.version.replace('v', '')) <= 14) throw new Error('AzurAPI requires Node v14 or above, if you would like to use an older Node version, please use any version of this package below v0.2.13 (Not Recommended)');
+    if (parseFloat(process.version.replace('v', '')) <= 14)
+      throw new Error(
+        'AzurAPI requires Node v14 or above, if you would like to use an older Node version, please use any version of this package below v0.2.13 (Not Recommended)'
+      );
     this.options = options ? options : { source: 'local', autoupdate: true, rate: 3600000 };
     this.source = this.options.source ? this.options.source : 'local';
     this.autoupdate = true;
@@ -59,13 +62,12 @@ export class AzurAPI extends EventEmitter {
       equipments: this.equipments,
       chapters: this.chapters,
       voicelines: this.voicelines,
-      barrages: this.barrages
+      barrages: this.barrages,
     };
     this.updater = new Updater(this);
     this.updater.init();
     if (this.autoupdate && this.source === 'local') this.updater.start();
     this.emit('ready');
-
   }
 
   /**
@@ -89,7 +91,7 @@ export class AzurAPI extends EventEmitter {
   /**
    * Another bodge...
    */
-  getShipIdByName(name: string){
+  getShipIdByName(name: string) {
     return this.ships.getShipIdByName(name);
   }
 }