Merge pull request #26 from aymenn/eslint-config

Implement standard eslint styleguide and lint project

Author: cweems

.eslintrc.js

@@ -0,0 +1,31 @@
+{
+    "env": {
+        "browser": true,
+        "es2021": true,
+        "node": true
+    },
+    "extends": [
+        "standard"
+    ],
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+        "ecmaVersion": 12,
+        "sourceType": "module"
+    },
+    "plugins": [
+        "@typescript-eslint"
+    ],
+    "rules": {
+    },
+    "overrides": [
+        {
+          "files": [
+            "**/*.test.js",
+            "**/*.test.ts"
+          ],
+          "env": {
+            "jest": true
+          }
+        }
+    ]
+}

.eslintrc.json

@@ -3,4 +3,4 @@ module.exports = {
   preset: 'ts-jest',
   testEnvironment: 'node',
   setupFiles: ['<rootDir>/tests/.jest/setEnvVars.js']
-};
+}

jest.config.js

@@ -20,6 +20,13 @@
     "@types/morgan": "^1.9.3",
     "@types/node": "^18.0.1",
     "@types/supertest": "^2.0.12",
+    "@typescript-eslint/eslint-plugin": "^5.32.0",
+    "@typescript-eslint/parser": "^5.32.0",
+    "eslint": "^8.21.0",
+    "eslint-config-standard": "^17.0.0",
+    "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-n": "^15.2.4",
+    "eslint-plugin-promise": "^6.0.0",
     "jest": "^28.1.3",
     "node-fetch": "2",
     "nodemon": "^2.0.19",
@@ -28,11 +35,14 @@
     "ts-node": "^10.8.2",
     "typescript": "^4.7.4"
   },
-  "name": "masked-communications",
+  "name": "masked-comms-app",
   "scripts": {
     "dev": "nodemon -r dotenv/config index.ts",
     "loadtest": "node ./tests/loadtest.js",
     "test": "jest"
   },
-  "version": "1.0.0"
+  "version": "1.0.0",
+  "main": "index.js",
+  "repository": "[email protected]:aymenn/masked-comms-app.git",
+  "license": "MIT"
 }

package.json

@@ -1,10 +1,10 @@
-import type { Request } from "express";
-import { ConversationListInstanceCreateOptions } from "twilio/lib/rest/conversations/v1/conversation";
+import type { Request } from 'express'
+import { ConversationListInstanceCreateOptions } from 'twilio/lib/rest/conversations/v1/conversation'
 
 export interface SessionPostBody extends ConversationListInstanceCreateOptions {
   addresses: Array<string>;
 }
-  
+
 export interface ConversationsPostEventBody {
   AccountSid: string;
   Attributes: string;
@@ -41,4 +41,4 @@ export interface JoinConferenceParams extends Request {
 export interface ParticipantToDial {
   address: string,
   proxyAddress: string
-}
+}

src/@types/types.ts

@@ -3,7 +3,7 @@ function shouldValidate () {
 }
 
 export const webhookConfig = {
-    protocol: 'https',
-    host: process.env.DOMAIN,
-    validate: shouldValidate()
-}
+  protocol: 'https',
+  host: process.env.DOMAIN,
+  validate: shouldValidate()
+}

src/config/webhookValidationConfig.ts

@@ -1,6 +1,6 @@
-import type { Request, Response } from "express";
-import { ConversationsPostEventBody } from "../@types/types";
-import { deleteConversation } from "../utils/deleteConversation.util";
+import type { Request, Response } from 'express'
+import { ConversationsPostEventBody } from '../@types/types'
+import { deleteConversation } from '../utils/deleteConversation.util'
 
 export const post = async (
   req: Request<{}, {}, ConversationsPostEventBody>,
@@ -10,15 +10,15 @@ export const post = async (
     EventType: eventType,
     State: state,
     ConversationSid: conversationSid
-  } = req.body;
-  
-  if (eventType === "onConversationUpdated" && state === "closed") {
+  } = req.body
+
+  if (eventType === 'onConversationUpdated' && state === 'closed') {
     try {
       await deleteConversation(conversationSid)
-    } catch(err) {
+    } catch (err) {
       return res.status(500).send(`${conversationSid} failed to delete: ${err}`)
     }
     return res.status(200).send(`${conversationSid} deleted`)
   }
   return res.status(200).send('not processed')
-};
+}

src/controllers/conversationsPostEvent.ts

@@ -1,5 +1,5 @@
-import type { Request, Response } from "express";
-import { generateTwiml } from "../services/inboundCall.service";
+import type { Request, Response } from 'express'
+import { generateTwiml } from '../services/inboundCall.service'
 
 export const post = async (
   req: Request,
@@ -8,9 +8,8 @@ export const post = async (
   const from = req.body.From
   const to = req.body.Called
 
-  const twiml = await generateTwiml(from, to);
+  const twiml = await generateTwiml(from, to)
 
   res.set('Content-Type', 'text/xml')
   res.send(twiml.toString())
-
-};
+}

src/controllers/inboundCall.ts

@@ -1,4 +1,4 @@
-export * as conversationsPostEvent from "./conversationsPostEvent";
-export * as inboundCall from "./inboundCall";
-export * as session from "./session";
-export * as joinConference from "./joinConference"
+export * as conversationsPostEvent from './conversationsPostEvent'
+export * as inboundCall from './inboundCall'
+export * as session from './session'
+export * as joinConference from './joinConference'

src/controllers/index.ts

@@ -1,11 +1,11 @@
-import type { Response } from "express";
-import { JoinConferenceParams } from "../@types/types";
-import VoiceResponse from "twilio/lib/twiml/VoiceResponse";
+import type { Response } from 'express'
+import { JoinConferenceParams } from '../@types/types'
+import VoiceResponse from 'twilio/lib/twiml/VoiceResponse'
 
 function joinConferenceTwiml (conferenceName: string) : VoiceResponse {
   const response = new VoiceResponse()
-  const dial = response.dial();
-  dial.conference(`${decodeURIComponent(conferenceName)}`);
+  const dial = response.dial()
+  dial.conference(`${decodeURIComponent(conferenceName)}`)
 
   return response
 }
@@ -15,8 +15,8 @@ export const get = async (
   res: Response
 ) => {
   const conferenceName = req.query.conferenceName
-  const twiml = await joinConferenceTwiml(conferenceName as string);
+  const twiml = await joinConferenceTwiml(conferenceName as string)
 
   res.set('Content-Type', 'text/xml')
   res.send(twiml.toString())
-};
+}