[Dev] Introduce eslint and fix errors

chrispanag · Nov 20, 2020 · 7a577a3 · 7a577a3
1 parent 4265c89
commit 7a577a3
Show file tree

Hide file tree

Showing 22 changed files with 754 additions and 100 deletions.
diff --git a/examples/echo-bot/package.json b/examples/echo-bot/package.json
@@ -11,7 +11,8 @@
         "fb:config": "yarn node ./dist/scripts/install.js",
         "prettier:base": "npx prettier --config ../../.prettierrc",
         "prettier:check": "yarn run prettier:base -- --list-different \"src/**/*.{ts,tsx}\"",
-        "prettier:write": "yarn run prettier:base -- --write \"src/**/*.{ts,tsx}\""
+        "prettier:write": "yarn run prettier:base -- --write \"src/**/*.{ts,tsx}\"",
+        "lint": "eslint '*/**/*.ts' --quiet --fix -c ../../.eslintrc.js --ignore-path ../../.eslintignore"
     },
     "dependencies": {
         "@ebenos/elements": "^3.4.4",

diff --git a/package.json b/package.json
@@ -10,9 +10,13 @@
     ],
     "scripts": {},
     "devDependencies": {
+        "@typescript-eslint/eslint-plugin": "^4.8.1",
+        "@typescript-eslint/parser": "^4.8.1",
+        "eslint": "^7.13.0",
+        "eslint-config-prettier": "^6.15.0",
+        "eslint-plugin-prettier": "^3.1.4",
         "lerna": "^3.22.1",
-        "prettier": "^2.1.2",
-        "tslint": "^6.1.3",
+        "prettier": "^2.2.0",
         "typescript": "^4.1.0"
     },
     "engines": {

diff --git a/packages/elements/lib/sendAPI/attachments.ts b/packages/elements/lib/sendAPI/attachments.ts
@@ -11,14 +11,14 @@
 /** Generic attachment class */
 export class Attachment {
     public type: string;
-    public payload: {};
+    public payload: Record<string, unknown>;
 
     /**
      * Create a generic attachment
      * @param {string} type - The type of the attachment
      * @param {object} payload - The attachment
      */
-    constructor(type: string, payload: {}) {
+    constructor(type: string, payload: Record<string, unknown>) {
         this.type = type;
         this.payload = payload;
     }
@@ -50,7 +50,7 @@ export class TemplateAttachment extends Attachment {
      * A template attachment (List, Button or Generic)
      * @param {object} template - The template included within this attachment
      */
-    constructor(template: {}) {
+    constructor(template: Record<string, unknown>) {
         super('template', template);
     }
 }
diff --git a/packages/elements/lib/sendAPI/buttons.ts b/packages/elements/lib/sendAPI/buttons.ts
@@ -21,14 +21,14 @@ import { GenericTemplate } from './templates';
 /** A General button class */
 export class Button {
     public type: string;
-    public params: {};
+    public params: Record<string, unknown>;
 
     /**
      * Creates a generic button
      * @param {string} type - The type of the button
      * @param {object} params - The various parameters the button includes
      */
-    constructor(type: string, params: {} = {}) {
+    constructor(type: string, params: Record<string, unknown> = {}) {
         this.type = type;
         this.params = params;
     }
@@ -60,7 +60,7 @@ export class UrlButton extends Button {
         title: string,
         url: string,
         webview_height_ratio = 'full',
-        messenger_extensions: boolean = false
+        messenger_extensions = false
     ) {
         super('web_url', {
             title,
@@ -99,7 +99,7 @@ export class PostbackButton extends Button {
      * @param {string} title - The title of the button
      * @param {object|string} payload - The payload returned when the button is pushed
      */
-    constructor(title: string, payload: any | string = '') {
+    constructor(title: string, payload: Record<string, unknown> | string = '') {
         let serializedPayload = payload;
         if (typeof payload === 'object') {
             serializedPayload = JSON.stringify(payload);

diff --git a/packages/elements/lib/sendAPI/interfaces.ts b/packages/elements/lib/sendAPI/interfaces.ts
@@ -2,15 +2,17 @@ import { Button } from './buttons';
 import { QuickReply } from './quickreplies';
 import { Attachment } from './attachments';
 
-export function isObjectPayload(payload: string | {}): payload is {} {
+export function isObjectPayload(
+    payload: string | Record<string, unknown>
+): payload is Record<string, unknown> {
     return typeof payload === 'object';
 }
 
 export interface MessageBody {
     recipient: {
         id: string;
     };
-    message: {};
+    message: Record<string, unknown>;
     notification_type: string;
     messaging_type: string;
 }
@@ -38,7 +40,7 @@ export interface MessageOptions {
 export type SerializedMessage = SerializedAttachmentMessage | SerializedTextMessage;
 
 export interface SerializedAttachmentMessage {
-    attachment: {};
+    attachment: Record<string, unknown>;
 }
 
 export interface SerializedTextMessage {

diff --git a/packages/elements/lib/sendAPI/quickreplies.ts b/packages/elements/lib/sendAPI/quickreplies.ts
@@ -22,7 +22,11 @@ export class QuickReply {
      * @param {string} title - The title of the QuickReply
      * @param {?object|?string} payload - The payload sent when the QuickReply is pushed
      */
-    constructor(content_type: string, title: string, payload: string | {} = '') {
+    constructor(
+        content_type: string,
+        title: string,
+        payload: string | Record<string, unknown> = ''
+    ) {
         let serializedPayload = JSON.stringify(payload);
         if (!isObjectPayload(payload)) {
             serializedPayload = payload;

diff --git a/packages/elements/lib/sendAPI/templates.ts b/packages/elements/lib/sendAPI/templates.ts
@@ -85,7 +85,11 @@ export class MediaTemplate extends TemplateAttachment {
     /**
      * Create a MediaTemplate
      */
-    constructor(attachment_id: string, buttons: Button[] | null = null, media_type: 'image' | 'video' = 'image') {
+    constructor(
+        attachment_id: string,
+        buttons: Button[] | null = null,
+        media_type: 'image' | 'video' = 'image'
+    ) {
         let serializedButtons: Array<{ [key: string]: any }> = [];
         if (buttons) {
             serializedButtons = buttons.map((b) => b.serialize());

diff --git a/packages/elements/package.json b/packages/elements/package.json
@@ -12,7 +12,8 @@
         "prepare": "yarn run build",
         "prettier:base": "npx prettier --config ../../.prettierrc",
         "prettier:check": "yarn run prettier:base -- --list-different \"lib/**/*.{ts,tsx}\"",
-        "prettier:write": "yarn run prettier:base -- --write \"lib/**/*.{ts,tsx}\""
+        "prettier:write": "yarn run prettier:base -- --write \"lib/**/*.{ts,tsx}\"",
+        "lint": "eslint '*/**/*.ts' --quiet --fix -c ../../.eslintrc.js --ignore-path ../../.eslintignore"
     },
     "types": "./build/index.d.ts",
     "author": "Christos Panagiotakopoulos <chrispanag@gmail.com>",

diff --git a/packages/framework/lib/handlers/nlp.ts b/packages/framework/lib/handlers/nlp.ts
@@ -27,8 +27,8 @@ function nlpHandlerFactory<U extends User>(
     intentRouter: IntentRouter,
     options?: INLPHandlerOptions
 ) {
-    const MAX_LENGTH = options?.maxMessageLength ? options.maxMessageLength : 51
-    const MIN_CONFIDENCE = options?.confidenceThreshold ? options.confidenceThreshold : 0.9
+    const MAX_LENGTH = options?.maxMessageLength ? options.maxMessageLength : 51;
+    const MIN_CONFIDENCE = options?.confidenceThreshold ? options.confidenceThreshold : 0.9;
     function nlpHandler(this: Bot<U>, user: U, message: { text: string }, nlp: WitNLP) {
         // The NLP object doesn't exist if the user hasn't activated the built in NLP
         if (nlp) {

diff --git a/packages/framework/lib/handlers/text.ts b/packages/framework/lib/handlers/text.ts
@@ -19,7 +19,11 @@ import Bot from '../bot';
  * @returns {function} - Returns a textHandler function
  */
 
-type nlpHandlerF<U extends User> = (user: U, message: { text: string }, nlp: WitNLP) => Promise<any>;
+type nlpHandlerF<U extends User> = (
+    user: U,
+    message: { text: string },
+    nlp: WitNLP
+) => Promise<any>;
 
 function defaultNlp<U extends User>(user: U, message: { text: string }, nlp: WitNLP | undefined) {
     if (!nlp) {

diff --git a/packages/framework/lib/index.ts b/packages/framework/lib/index.ts
@@ -16,12 +16,7 @@ export { ISerializable } from './interfaces/elements';
 export { ActionMiddleware } from './utilities/actions';
 export { UserModel, IRouters, EbonyHandlers, IBaseMessage, IBaseMessageOptions } from './adapter';
 export { WitNLP } from './interfaces/nlp';
-export { GenericAttachment } from './interfaces/attachment'
+export { GenericAttachment } from './interfaces/attachment';
 export * from './interfaces/interactions';
 
-
-export {
-    Bot,
-    User,
-    GenericAdapter,
-};
+export { Bot, User, GenericAdapter };
diff --git a/packages/framework/lib/interfaces/interactions.ts b/packages/framework/lib/interfaces/interactions.ts
@@ -6,7 +6,7 @@ export interface IBaseInteraction {
     options: IBaseMessageOptions;
 }
 
-export interface IMessageInteraction<T extends {}> extends IBaseInteraction {
+export interface IMessageInteraction<T> extends IBaseInteraction {
     type: 'message';
     id: string;
     message: ISerializable;

diff --git a/packages/framework/lib/models/User.ts b/packages/framework/lib/models/User.ts
@@ -41,7 +41,7 @@ export default class User extends UserModel {
             this.handovered = false;
         }
         if (!data.context) {
-            // Initialize context 
+            // Initialize context
             this._context = {};
         }
     }

diff --git a/packages/framework/lib/routers/ReferralsRouter.ts b/packages/framework/lib/routers/ReferralsRouter.ts
@@ -28,6 +28,6 @@ export default class ReferralsRouter extends BasicRouter {
             return defaultFunc(user, ref);
         }
 
-        throw new Error("Unkown referral type " + ref);
+        throw new Error('Unkown referral type ' + ref);
     }
 }
diff --git a/packages/framework/lib/utilities/scenario.ts b/packages/framework/lib/utilities/scenario.ts
@@ -28,7 +28,7 @@ function notify<A extends GenericAdapter<U>, U extends User>(
     ...params: [string, ...any[]]
 ) {
     if (this._consolidated) {
-        throw new Error("Scenario has already ended.")
+        throw new Error('Scenario has already ended.');
     }
     this._actions.push({
         call: 'notify',
@@ -43,7 +43,7 @@ function handover<A extends GenericAdapter<U>, U extends User>(
     ...params: [string, ...any[]]
 ) {
     if (this._consolidated) {
-        throw new Error("Scenario has already ended.")
+        throw new Error('Scenario has already ended.');
     }
     this._actions.push({
         call: 'handover',
@@ -70,7 +70,7 @@ async function end<A extends GenericAdapter<U>, U extends User>(
 
 function wait<A extends GenericAdapter<U>, U extends User>(this: Scenario<A, U>, millis: number) {
     if (this._consolidated) {
-        throw new Error("Scenario has already ended.")
+        throw new Error('Scenario has already ended.');
     }
     this._actions.push({
         call: 'wait',
@@ -85,7 +85,7 @@ function send<A extends GenericAdapter<U>, U extends User>(
     options: any = {}
 ) {
     if (this._consolidated) {
-        throw new Error("Scenario has already ended.")
+        throw new Error('Scenario has already ended.');
     }
     this._actions.push({
         call: 'message',
@@ -96,7 +96,7 @@ function send<A extends GenericAdapter<U>, U extends User>(
 
 function types<A extends GenericAdapter<U>, U extends User>(this: Scenario<A, U>) {
     if (this._consolidated) {
-        throw new Error("Scenario has already ended.")
+        throw new Error('Scenario has already ended.');
     }
     this._actions.push({
         call: 'typing_on',
@@ -107,7 +107,7 @@ function types<A extends GenericAdapter<U>, U extends User>(this: Scenario<A, U>
 
 function seen<A extends GenericAdapter<U>, U extends User>(this: Scenario<A, U>) {
     if (this._consolidated) {
-        throw new Error("Scenario has already ended.")
+        throw new Error('Scenario has already ended.');
     }
     this._actions.push({
         call: 'mark_seen',
@@ -118,7 +118,7 @@ function seen<A extends GenericAdapter<U>, U extends User>(this: Scenario<A, U>)
 
 function stopTyping<A extends GenericAdapter<U>, U extends User>(this: Scenario<A, U>) {
     if (this._consolidated) {
-        throw new Error("Scenario has already ended.")
+        throw new Error('Scenario has already ended.');
     }
     this._actions.push({
         call: 'typing_off',

diff --git a/packages/framework/package.json b/packages/framework/package.json
@@ -13,7 +13,8 @@
         "test": "yarn run build && yarn node ./build/index.js",
         "prettier:base": "npx prettier --config ../../.prettierrc",
         "prettier:check": "yarn run prettier:base -- --list-different \"lib/**/*.{ts,tsx}\"",
-        "prettier:write": "yarn run prettier:base -- --write \"lib/**/*.{ts,tsx}\""
+        "prettier:write": "yarn run prettier:base -- --write \"lib/**/*.{ts,tsx}\"",
+        "lint": "eslint '*/**/*.ts' --quiet --fix -c ../../.eslintrc.js --ignore-path ../../.eslintignore"
     },
     "keywords": [
         "bot",

diff --git a/packages/messenger-adapter/lib/adapter/interfaces/webhook.ts b/packages/messenger-adapter/lib/adapter/interfaces/webhook.ts
@@ -64,7 +64,15 @@ export interface Referral {
 }
 
 // TODO: Add it
-export interface Standby {}
+export interface Standby {
+    sender: {
+        id: string;
+    };
+
+    recipient: {
+        id: string;
+    };
+}
 
 export interface Delivery {
     mids?: string[];

diff --git a/packages/messenger-adapter/lib/adapter/sender.ts b/packages/messenger-adapter/lib/adapter/sender.ts
@@ -125,7 +125,7 @@ export function senderFactory(pageToken: string, call: SenderFunction = sendAPI,
         return getUserDataCall(id, fields, qs);
     }
 
-    function handover(id: string, targetAppId: string = '263902037430900', metadata?: string) {
+    function handover(id: string, targetAppId = '263902037430900', metadata?: string) {
         return passThreadControl(id, qs, targetAppId, metadata);
     }
 

diff --git a/packages/messenger-adapter/lib/messengerApi.ts b/packages/messenger-adapter/lib/messengerApi.ts
@@ -91,7 +91,7 @@ export async function getUserDataCall(id: string, fields: UserDataFields[], qs:
 export async function passThreadControl(
     id: string,
     qs: string,
-    targetAppId: string = '263902037430900',
+    targetAppId = '263902037430900',
     metadata?: string
 ) {
     const bodyWithoutMetadata = {

diff --git a/packages/messenger-adapter/lib/webhooks/messaging.ts b/packages/messenger-adapter/lib/webhooks/messaging.ts
@@ -21,10 +21,7 @@ export default function messagingWebhook<T extends MessengerUser>(
                     // TODO: Postbacks and text handler
                     const qr = e.message.quick_reply;
                     if (qr.payload) {
-                        routerExists(routers.PostbackRouter).stringPayloadHandler(
-                            qr.payload,
-                            user
-                        );
+                        routerExists(routers.PostbackRouter).stringPayloadHandler(qr.payload, user);
                         return;
                     }
                     throw new Error('Not implemented');
@@ -59,10 +56,7 @@ export default function messagingWebhook<T extends MessengerUser>(
                 throw new Error('Not implemented');
             }
             if (e.postback.payload) {
-                routerExists(routers.PostbackRouter).stringPayloadHandler(
-                    e.postback.payload,
-                    user
-                );
+                routerExists(routers.PostbackRouter).stringPayloadHandler(e.postback.payload, user);
                 return;
             }
 

diff --git a/packages/messenger-adapter/package.json b/packages/messenger-adapter/package.json
@@ -12,7 +12,8 @@
         "prepare": "yarn run build",
         "prettier:base": "npx prettier --config ../../.prettierrc",
         "prettier:check": "yarn run prettier:base -- --list-different \"lib/**/*.{ts,tsx}\"",
-        "prettier:write": "yarn run prettier:base -- --write \"lib/**/*.{ts,tsx}\""
+        "prettier:write": "yarn run prettier:base -- --write \"lib/**/*.{ts,tsx}\"",
+        "lint": "eslint '*/**/*.ts' --quiet --fix -c ../../.eslintrc.js --ignore-path ../../.eslintignore"
     },
     "types": "./build/index.d.ts",
     "author": "Christos Panagiotakopoulos <chrispanag@gmail.com>",