refactor(grabber): rewrite to typescript

Author: SilentDepth

.eslintrc.js

@@ -7,10 +7,14 @@ module.exports = {
     node: true,
   },
   parserOptions: {
-    parser: 'babel-eslint',
+    parser: '@typescript-eslint/parser',
   },
+  plugins: [
+    '@typescript-eslint',
+  ],
   extends: [
     'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
   ],
   rules: {
     'no-var': 'error',

helper.js renamed to helper.ts

@@ -1,17 +1,20 @@
-const fs = require('fs-extra')
-const axios = require('axios')
-const inquirer = require('inquirer')
+import fs from 'fs-extra'
+import axios from 'axios'
+import inquirer from 'inquirer'
 
-const logger = require('./logger')
+import * as logger from './logger'
 
-exports.download = async function download (apiPath, dest) {
+export async function download (apiPath: string, dest: string): Promise<void> {
   logger.Assets.info('DOWNLOAD', apiPath)
-  const {data} = await axios.get(apiPath, {responseType: 'stream'})
-    .catch(err => logger.Assets.error('DOWNLOAD', apiPath, err.toJSON()))
-  data.pipe(fs.createWriteStream(dest))
+  const {data} = await axios.get<fs.ReadStream>(apiPath, {responseType: 'stream'})
+    .catch(err => {
+      logger.Assets.error('DOWNLOAD', apiPath, err.toJSON())
+      return {data: null}
+    })
+  data?.pipe(fs.createWriteStream(dest))
 }
 
-exports.writeJSON = function writeJSON (dest, data) {
+export function writeJSON (dest: string, data: never): void {
   fs.writeFile(dest, JSON.stringify(data), (err) => {
     if (err) {
       logger.WriteJSON.error('CREATE', dest, err)
@@ -21,11 +24,11 @@ exports.writeJSON = function writeJSON (dest, data) {
   })
 }
 
-exports.mergeStats = function mergeStats (data) {
-  let merged = {}
+export function mergeStats (data: McPlayerStatsJson): McPlayerStatsJson {
+  const merged: McPlayerStatsJson = {}
   if (Object.prototype.hasOwnProperty.call(data, 'stats')) {
-    for (let key in data.stats) {
-      for (let s in data.stats[key]) {
+    for (const key in data.stats) {
+      for (const s in data.stats[key]) {
         merged[key + '/' + s] = data.stats[key][s]
       }
     }
@@ -34,18 +37,18 @@ exports.mergeStats = function mergeStats (data) {
   return data
 }
 
-exports.defaultSkin = function defaultSkin (uuid) {
+export function defaultSkin (uuid: LongUuid): string {
   // great thanks to Minecrell for research into Minecraft and Java's UUID hashing!
   // https://git.io/xJpV
   // MC uses `uuid.hashCode() & 1` for alex
   // that can be compacted to counting the LSBs of every 4th byte in the UUID
   // an odd sum means alex, an even sum means steve
   // XOR-ing all the LSBs gives us 1 for alex and 0 for steve
-  const isEven = (c) => {
+  const isEven = (c: string) => {
     if (c >= '0' && c <= '9') {
-      return (c & 1) === 0
+      return (Number(c) & 1) === 0
     } else if (c >= 'a' && c <= 'f') {
-      return (c & 1) === 1
+      return (Number(c) & 1) === 1
     }
     console.log('Invalid digit', c)
     return null
@@ -55,10 +58,10 @@ exports.defaultSkin = function defaultSkin (uuid) {
   return lsbsEven ? 'Alex' : 'Steve'
 }
 
-exports.confirm = async function confirm (message, _default = true) {
+export async function confirm (message: string, _default = true): Promise<boolean> {
   const prompt = inquirer.createPromptModule()
   try {
-    const res = await prompt({
+    const res = await prompt<{confirm: boolean}>({
       type: 'confirm',
       name: 'confirm',
       default: _default,
@@ -71,6 +74,6 @@ exports.confirm = async function confirm (message, _default = true) {
   }
 }
 
-exports.delay = function delay (ms) {
+export function delay (ms: number): Promise<void> {
   return new Promise(resolve => setTimeout(resolve, ms))
 }

index.js renamed to index.ts

@@ -1,10 +1,10 @@
-const fs = require('fs-extra')
-const path = require('path')
+import fs from 'fs-extra'
+import path from 'path'
 
-const Utils = require('./utils')
-const {writeJSON, confirm} = require('./helper')
-const logger = require('./logger')
-const ProgressBar = require('./progressbar')
+import Utils from './utils'
+import {confirm, writeJSON} from './helper'
+import * as logger from './logger'
+import ProgressBar from './progressbar'
 
 process.on('SIGINT', () => {
   process.exit()
@@ -16,10 +16,8 @@ const utils = new Utils()
 const config = utils.getConfig()
 
 void async function main () {
-  /** @type {string[]} */
   const bannedUuidList = config.render['banned-players'] ? utils.getBannedPlayers() : []
 
-  /** @type {string[]} */
   const uuidList = (() => {
     let list = config.render.whitelist ? utils.getWhitelistedPlayers() : utils.getAllPlayers()
     if (!config.render['render-banned'] && bannedUuidList.length) {
@@ -33,11 +31,11 @@ void async function main () {
     logger.Default.info('Advancements is set: Render mode set to 1.12+')
   } else {
     logger.Default.info('Advancements not set: Render mode set to 1.11')
-
   }
-  const outputDir = path.join(config.BASEPATH, config.render.output)
 
+  const outputDir = path.join(config.BASEPATH, config.render.output)
   logger.Default.info('CREATE OUTPUT DIR', outputDir)
+
   if (config.render['confirm-clear-data'] !== false) {
     const prompt = await confirm('Do you want to clean the output folder?')
     if (prompt) {
@@ -49,7 +47,6 @@ void async function main () {
     }
   }
 
-  /** @type {object[]} */
   const players = []
 
   const progress = new ProgressBar(uuidList.length)
@@ -78,14 +75,14 @@ void async function main () {
 
   progress.stop()
 
-  players.sort((a, b) => b.seen - a.seen)
-  writeJSON(path.join(outputDir, 'players.json'), players)
+  players.sort((a, b) => (b.seen ?? 0) - (a.seen ?? 0))
+  writeJSON(path.join(outputDir, 'players.json'), players as never)
 
-  let worldTime = await utils.getWorldTime()
+  const worldTime = await utils.getWorldTime()
   writeJSON(path.join(outputDir, 'info.json'), {
     worldTime,
     timeFormat: config.render['time-format'],
     lastUpdate: Date.now(),
     ...config.web,
-  })
+  } as never)
 }()

logger.js

@@ -0,0 +1,25 @@
+import log4js from 'log4js'
+
+log4js.configure({
+  appenders: {
+    Default: {type: 'stdout'},
+    Config: {type: 'stdout'},
+    PlayerData: {type: 'stdout'},
+    MojangAPI: {type: 'stdout'},
+    Assets: {type: 'stdout'},
+    WriteJSON: {type: 'stdout'},
+  },
+  categories: {
+    default: {
+      appenders: ['Default'],
+      level: 'info',
+    },
+  },
+})
+
+export const Default = log4js.getLogger('Default')
+export const Config = log4js.getLogger('Config')
+export const PlayerData = log4js.getLogger('PlayerData')
+export const MojangAPI = log4js.getLogger('MojangAPI')
+export const Assets = log4js.getLogger('Assets')
+export const WriteJSON = log4js.getLogger('WriteJSON')