Clean up imports to make Intellij code analysis happy

lib/HexUtil.js

@@ -1,4 +1,5 @@
 class HexUtil {
+    /** @param {Buffer} buffer */
     static debugDump(buffer) {
         let hexLine = '';
         let chrLine = '';

lib/index.js

@@ -101,5 +101,7 @@ class Gamedig {
     }
 
 }
+Gamedig.debug = false;
+Gamedig.isCommandLine = false;
 
 module.exports = Gamedig;

lib/reader.js

@@ -126,6 +126,7 @@ class Reader {
         return r;
     }
 
+    /** @returns Buffer */
     part(bytes) {
         let r;
         if(this.remaining() >= bytes) {

protocols/americasarmy.js

@@ -1,4 +1,6 @@
-class AmericasArmy extends require('./gamespy2') {
+const Gamespy2 = require('./gamespy2');
+
+class AmericasArmy extends Gamespy2 {
     finalizeState(state) {
         super.finalizeState(state);
         state.name = this.stripColor(state.name);

protocols/armagetron.js

@@ -1,4 +1,6 @@
-class Armagetron extends require('./core') {
+const Core = require('./core');
+
+class Armagetron extends Core {
     constructor() {
         super();
         this.encoding = 'latin1';

protocols/ase.js

@@ -1,4 +1,6 @@
-class Ase extends require('./core') {
+const Core = require('./core');
+
+class Ase extends Core {
     run(state) {
         this.udpSend('s',(buffer) => {
             const reader = this.reader(buffer);

protocols/battlefield.js

@@ -1,6 +1,7 @@
-const async = require('async');
+const async = require('async'),
+    Core = require('./core');
 
-class Battlefield extends require('./core') {
+class Battlefield extends Core {
     constructor() {
         super();
         this.encoding = 'latin1';

protocols/buildandshoot.js

@@ -1,6 +1,7 @@
-const request = require('request');
+const request = require('request'),
+    Core = require('./core');
 
-class BuildAndShoot extends require('./core') {
+class BuildAndShoot extends Core {
     run(state) {
         request({
             uri: 'http://'+this.options.address+':'+this.options.port_query+'/',

protocols/doom3.js

@@ -1,4 +1,6 @@
-class Doom3 extends require('./core') {
+const Core = require('./core');
+
+class Doom3 extends Core {
     constructor() {
         super();
         this.pretty = 'Doom 3';

protocols/ffow.js

@@ -1,4 +1,6 @@
-class Ffow extends require('./valve') {
+const Valve = require('./valve');
+
+class Ffow extends Valve {
     constructor() {
         super();
         this.byteorder = 'be';

protocols/fivem.js

@@ -1,6 +1,7 @@
-const request = require('request');
+const request = require('request'),
+    Quake2 = require('./quake2');
 
-class FiveM extends require('./quake2') {
+class FiveM extends Quake2 {
     constructor() {
         super();
         this.sendHeader = 'getinfo xxx';

protocols/gamespy1.js

@@ -1,6 +1,7 @@
-const async = require('async');
+const async = require('async'),
+    Core = require('./core');
 
-class Gamespy1 extends require('./core') {
+class Gamespy1 extends Core {
     constructor() {
         super();
         this.sessionId = 1;

protocols/gamespy2.js

@@ -1,4 +1,6 @@
-class Gamespy2 extends require('./core') {
+const Core = require('./core');
+
+class Gamespy2 extends Core {
     constructor() {
         super();
         this.sessionId = 1;

protocols/gamespy3.js

@@ -1,6 +1,7 @@
-const async = require('async');
+const async = require('async'),
+    Core = require('./core');
 
-class Gamespy3 extends require('./core') {
+class Gamespy3 extends Core {
     constructor() {
         super();
         this.sessionId = 1;
@@ -12,7 +13,10 @@ class Gamespy3 extends require('./core') {
     }
 
     run(state) {
-        let challenge,packets;
+        let challenge;
+
+        /** @type Buffer[] */
+        let packets;
 
         async.series([
             (c) => {

protocols/geneshift.js

@@ -1,6 +1,7 @@
-const request = require('request');
+const request = require('request'),
+    Core = require('./core');
 
-class GeneShift extends require('./core') {
+class GeneShift extends Core {
     run(state) {
         request({
             uri: 'http://geneshift.net/game/receiveLobby.php',

protocols/hexen2.js

@@ -1,4 +1,6 @@
-class Hexen2 extends require('./quake1') {
+const Quake1 = require('./quake1');
+
+class Hexen2 extends Quake1 {
     constructor() {
         super();
         this.sendHeader = '\xFFstatus\x0a';

protocols/jc2mp.js

@@ -1,6 +1,8 @@
+const Gamespy3 = require('./gamespy3');
+
 // supposedly, gamespy3 is the "official" query protocol for jcmp,
 // but it's broken (requires useOnlySingleSplit), and doesn't include player names
-class Jc2mp extends require('./gamespy3') {
+class Jc2mp extends Gamespy3 {
     constructor() {
         super();
         this.useOnlySingleSplit = true;

protocols/killingfloor.js

@@ -1,4 +1,6 @@
-class KillingFloor extends require('./unreal2') {
+const Unreal2 = require('./unreal2');
+
+class KillingFloor extends Unreal2 {
     readExtraInfo(reader,state) {
         state.raw.wavecurrent = reader.uint(4);
         state.raw.wavetotal = reader.uint(4);

protocols/kspdmp.js

@@ -1,6 +1,7 @@
-const request = require('request');
+const request = require('request'),
+    Core = require('./core');
 
-class Kspdmp extends require('./core') {
+class Kspdmp extends Core {
     run(state) {
         request({
             uri: 'http://'+this.options.address+':'+this.options.port_query,

protocols/m2mp.js

@@ -1,4 +1,6 @@
-class M2mp extends require('./core') {
+const Core = require('./core');
+
+class M2mp extends Core {
     constructor() {
         super();
         this.encoding = 'latin1';

protocols/minecraft.js

@@ -1,5 +1,6 @@
 const varint = require('varint'),
-    async = require('async');
+    async = require('async'),
+    Core = require('./core');
 
 function varIntBuffer(num) {
     return Buffer.from(varint.encode(num));
@@ -14,8 +15,9 @@ function buildPacket(id,data) {
     ]);
 }
 
-class Minecraft extends require('./core') {
+class Minecraft extends Core {
     run(state) {
+        /** @type Buffer */
         let receivedData;
 
         async.series([

protocols/mumble.js

@@ -1,4 +1,6 @@
-class Mumble extends require('./core') {
+const Core = require('./core');
+
+class Mumble extends Core {
     constructor() {
         super();
         this.options.socketTimeout = 5000;

protocols/mumbleping.js

@@ -1,4 +1,6 @@
-class MumblePing extends require('./core') {
+const Core = require('./core');
+
+class MumblePing extends Core {
     constructor() {
         super();
         this.byteorder = 'be';

protocols/nadeo.js

@@ -1,7 +1,8 @@
 const gbxremote = require('gbxremote'),
-    async = require('async');
+    async = require('async'),
+    Core = require('./core');
 
-class Nadeo extends require('./core') {
+class Nadeo extends Core {
     constructor() {
         super();
         this.options.port = 2350;

protocols/openttd.js

@@ -1,7 +1,8 @@
 const async = require('async'),
-    moment = require('moment');
+    moment = require('moment'),
+    Core = require('./core');
 
-class OpenTtd extends require('./core') {
+class OpenTtd extends Core {
     run(state) {
         async.series([
             (c) => {

protocols/quake1.js

@@ -1,4 +1,6 @@
-class Quake1 extends require('./quake2') {
+const Quake2 = require('./quake2');
+
+class Quake1 extends Quake2 {
     constructor() {
         super();
         this.responseHeader = 'n';

protocols/quake2.js

@@ -1,4 +1,6 @@
-class Quake2 extends require('./core') {
+const Core = require('./core');
+
+class Quake2 extends Core {
     constructor() {
         super();
         this.encoding = 'latin1';

protocols/quake3.js

@@ -1,4 +1,6 @@
-class Quake3 extends require('./quake2') {
+const Quake2 = require('./quake2');
+
+class Quake3 extends Quake2 {
     constructor() {
         super();
         this.sendHeader = 'getstatus';

protocols/starmade.js

@@ -1,4 +1,6 @@
-class Starmade extends require('./core') {
+const Core = require('./core');
+
+class Starmade extends Core {
     constructor() {
         super();
         this.encoding = 'latin1';

protocols/teamspeak2.js

@@ -1,6 +1,7 @@
-const async = require('async');
+const async = require('async'),
+    Core = require('./core');
 
-class Teamspeak2 extends require('./core') {
+class Teamspeak2 extends Core {
     run(state) {
         async.series([
             (c) => {

protocols/teamspeak3.js

@@ -1,6 +1,7 @@
-const async = require('async');
+const async = require('async'),
+    Core = require('./core');
 
-class Teamspeak3 extends require('./core') {
+class Teamspeak3 extends Core {
     run(state) {
         async.series([
             (c) => {

protocols/terraria.js

@@ -1,6 +1,7 @@
-const request = require('request');
+const request = require('request'),
+    Core = require('./core');
 
-class Terraria extends require('./core') {
+class Terraria extends Core {
     run(state) {
         request({
             uri: 'http://'+this.options.address+':'+this.options.port_query+'/v2/server/status',

protocols/tribes1.js

@@ -1,4 +1,6 @@
-class Tribes1 extends require('./core') {
+const Core = require('./core');
+
+class Tribes1 extends Core {
     constructor() {
         super();
         this.encoding = 'latin1';

protocols/tribes1master.js

@@ -1,6 +1,8 @@
+const Core = require('./core');
+
 /** Unsupported -- use at your own risk!! */
 
-class Tribes1Master extends require('./core') {
+class Tribes1Master extends Core {
     constructor() {
         super();
         this.encoding = 'latin1';

protocols/unreal2.js

@@ -1,6 +1,7 @@
-const async = require('async');
+const async = require('async'),
+    Core = require('./core');
 
-class Unreal2 extends require('./core') {
+class Unreal2 extends Core {
     constructor() {
         super();
         this.encoding = 'latin1';

protocols/ut2004.js

@@ -1,4 +1,6 @@
-class Ut2004 extends require('./unreal2') {
+const Unreal2 = require('./unreal2');
+
+class Ut2004 extends Unreal2 {
     readExtraInfo(reader,state) {
         state.raw.ping = reader.uint(4);
         state.raw.flags = reader.uint(4);

protocols/ut3.js

@@ -1,4 +1,6 @@
-class Ut3 extends require('./gamespy3') {
+const Gamespy3 = require('./gamespy3');
+
+class Ut3 extends Gamespy3 {
     finalizeState(state) {
         super.finalizeState(state);
 

protocols/valve.js

@@ -1,7 +1,8 @@
 const async = require('async'),
-    Bzip2 = require('compressjs').Bzip2;
+    Bzip2 = require('compressjs').Bzip2,
+    Core = require('./core');
 
-class Valve extends require('./core') {
+class Valve extends Core {
     constructor() {
         super();
 
@@ -128,7 +129,7 @@ class Valve extends require('./core') {
 
     queryChallenge(state,c) {
         if(this.legacyChallenge) {
-            this.sendPacket(0x57,false,false,0x41,(b) => {
+            this.sendPacket(0x57,false,null,0x41,(b) => {
                 // sendPacket will catch the response packet and
                 // save the challenge for us
                 c();
@@ -140,7 +141,7 @@ class Valve extends require('./core') {
 
     queryPlayers(state,c) {
         state.raw.players = [];
-        this.sendPacket(0x55,true,false,0x44,(b) => {
+        this.sendPacket(0x55,true,null,0x44,(b) => {
             const reader = this.reader(b);
             const num = reader.uint(1);
             for(let i = 0; i < num; i++) {
@@ -175,7 +176,7 @@ class Valve extends require('./core') {
 
     queryRules(state,c) {
         state.raw.rules = {};
-        this.sendPacket(0x56,true,false,0x45,(b) => {
+        this.sendPacket(0x56,true,null,0x45,(b) => {
             const reader = this.reader(b);
             const num = reader.uint(2);
             for(let i = 0; i < num; i++) {
@@ -237,7 +238,22 @@ class Valve extends require('./core') {
         c();
     }
 
-    sendPacket(type,sendChallenge,payload,expect,callback,ontimeout) {
+    /**
+     * @param {number} type
+     * @param {boolean} sendChallenge
+     * @param {?string|Buffer} payload
+     * @param {number} expect
+     * @param {function(Buffer)} callback
+     * @param {(function():boolean)=} ontimeout
+     **/
+    sendPacket(
+        type,
+        sendChallenge,
+        payload,
+        expect,
+        callback,
+        ontimeout
+    ) {
         const packetStorage = {};
 
         const receivedFull = (reader) => {

protocols/ventrilo.js

@@ -1,4 +1,6 @@
-class Ventrilo extends require('./core') {
+const Core = require('./core');
+
+class Ventrilo extends Core {
     constructor() {
         super();
         this.byteorder = 'be';

protocols/warsow.js

@@ -1,4 +1,6 @@
-class Warsow extends require('./quake3') {
+const Quake3 = require('./quake3');
+
+class Warsow extends Quake3 {
     finalizeState(state) {
         super.finalizeState(state);
         if(state.players) {