feat: added tslint to the mixture

Author: jscriptcoder

package-lock.json

@@ -3,11 +3,14 @@
   "version": "0.4.1",
   "description": "WebSocket client that consumes an API wrapping OpenAI Gym or gym-like environments such as Gym Retro or Unity ML-Agents.",
   "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "scripts": {
     "preinstall": "pip install -r requirements.txt",
     "prebuild": "rm -rf dist",
     "build": "tsc",
-    "postinstall": "npm run build",
+    "predocs": "rm -rf docs",
+    "docs": "typedoc",
+    "lint": "tslint src/**/*.ts",
     "start-server": "python -m gymie &",
     "kill-server": "./shutdown.sh",
     "test-gymie": "ts-node src/Gymie.test.ts",
@@ -29,8 +32,7 @@
     "prerun-action-sample": "npm run start-server",
     "run-action-sample": "ts-node examples/actionSample.ts",
     "postrun-action-sample": "npm run kill-server 5000",
-    "predocs": "rm -rf docs",
-    "docs": "typedoc"
+    "prepublish": "npm run build && npm run lint"
   },
   "repository": {
     "type": "git",
@@ -57,6 +59,7 @@
     "@types/yargs": "^15.0.8",
     "tape": "^5.0.1",
     "ts-node": "^9.0.0",
+    "tslint": "^6.1.3",
     "typedoc": "^0.19.2",
     "typescript": "^4.0.3"
   },

package.json

@@ -11,20 +11,20 @@ type PromiseReject = (reason?: any) => void
 /**
  * Returns an object with a promise on the way and two methods, 
  * `resolve()` and `reject()`, to change its state.
- * @see {@link https://developer.mozilla.org/en-US/docs/Mozilla/JavaScript_code_modules/Promise.jsm/Deferred Deferred object}
+ * @see {@link https://mzl.la/34i6vXn Deferred object}
  * @typeParam T Data wrapped in the promise.
  */
 export default class Deferred<T> {
 
   /**
    * Changes the state of the promise to `resolved`
-   * @see {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/resolve Promise.resolve()}
+   * @see {@link https://mzl.la/3johZwY Promise.resolve()}
    */
   resolve: PromiseResolve<T> = null
 
   /**
    * Changes the state of the promise to `rejected`
-   * @see {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/reject Promise.reject()}
+   * @see {@link https://mzl.la/2TbqLDw Promise.reject()}
    */
   reject: PromiseReject = null
   promise: Promise<T> = null

src/Deferred.ts

@@ -30,7 +30,7 @@ export default class Gymie {
 
   /**
    * Callback function wrapping the socket's sending mechanism.
-   * See {@link https://github.com/theturtle32/WebSocket-Node/blob/master/docs/WebSocketConnection.md#sendutfstring WebSocketConnection#sendUTF}
+   * See {@link https://bit.ly/3kjFcBp WebSocketConnection#sendUTF}
    * @param cmd Command to be sent to the server.
    */
   sender = (cmd: Command) => {
@@ -39,7 +39,7 @@ export default class Gymie {
 
   /**
    * Callback function for `message` event. Resolves the promise of the incoming message.
-   * See {@link https://github.com/theturtle32/WebSocket-Node/blob/master/docs/WebSocketConnection.md#message WebSocketConnection.onmessage}
+   * See {@link https://bit.ly/3m59QPB WebSocketConnection.onmessage}
    * @param message Message received from the server (plus type).
    */
   onMessage = (message: IMessage) => {
@@ -48,7 +48,7 @@ export default class Gymie {
 
   /**
    * Callback function for `error` event. Rejects the promise of the incoming message with {@link ConnectionError}.
-   * See {@link https://github.com/theturtle32/WebSocket-Node/blob/master/docs/WebSocketConnection.md#error WebSocketConnection.onerror}
+   * See {@link https://bit.ly/2HjgWRs WebSocketConnection.onerror}
    * @param err Thrown exception.
    */
   onError = (err: Error) => {
@@ -60,8 +60,8 @@ export default class Gymie {
 
   /**
    * Callback function for `close` event. Rejects the promise of the incoming message with {@link ConnectionClosed}.
-   * @see {@link https://github.com/theturtle32/WebSocket-Node/blob/master/docs/WebSocketConnection.md#closereasoncode-description WebSocketConnection.onclose}
-   * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/CloseEvent#Status_codes Status Codes}
+   * @see {@link https://bit.ly/2HbUb2l WebSocketConnection.onclose}
+   * @see {@link https://mzl.la/37qVPHV Status Codes}
    * @param code Close code sent by the server.
    * @param desc Reason why the server closed the connection. 
    */

src/Gymie.ts

@@ -2,10 +2,11 @@
  * Compilation of custom errors.
  */
 
+// tslint:disable:max-classes-per-file
 
 /**
  * Emitted when there is an error connecting to the remote host or the handshake response sent by the server is invalid.
- * @see {@link https://github.com/theturtle32/WebSocket-Node/blob/master/docs/WebSocketClient.md#connectfailed WebSocketClient.onConnectionFailed}
+ * @see {@link https://bit.ly/2TcFJcv WebSocketClient.onConnectionFailed}
  */
 export class ConnectFailed extends Error {
   name: string = 'ConnectFailed'
@@ -27,7 +28,7 @@ export class NoConnected extends Error {
 
 /**
  * Emitted when the connection has been fully closed and the socket is no longer connected.
- * @see {@link https://github.com/theturtle32/WebSocket-Node/blob/master/docs/WebSocketConnection.md#closereasoncode-description WebSocketConnection.onClose}
+ * @see {@link https://bit.ly/3kiSePP WebSocketConnection.onClose}
  */
 export class ConnectionClosed extends Error {
   name: string = 'ConnectionClosed'
@@ -38,7 +39,7 @@ export class ConnectionClosed extends Error {
 
 /**
  * Emitted when there has been a socket error. If this occurs, a close event will also be emitted.
- * @see {@link https://github.com/theturtle32/WebSocket-Node/blob/master/docs/WebSocketConnection.md#error WebSocketConnection.onError}
+ * @see {@link https://bit.ly/31v9Wbw WebSocketConnection.onError}
  */
 export class ConnectionError extends Error {
   name: string = 'ConnectionError'

src/errors.ts

@@ -11,7 +11,7 @@ export type Dict<T> = {[key: string]: T}
 /**
  * Empty function used as default value.
  */
-export const noop = () => {}
+export const noop = () => { /* noop */ }
 
 /**
  * Converts a JS value to a JSON string.