[No Ticket] Format the code and add linting rules (#104)

* [No Ticket] Format the code and add linting rules

* readd comment

.eslintrc.json

@@ -0,0 +1,59 @@
+{
+  "root": true,
+  "env": {
+    "browser": true,
+    "commonjs": true,
+    "es6": true,
+    "node": true,
+    "mocha": true
+  },
+  "plugins": [
+    "wdio",
+    "@typescript-eslint",
+    "typescript-formatter"
+  ],
+  "extends": [
+    "standard",
+    "plugin:wdio/recommended",
+    "plugin:@typescript-eslint/recommended"
+  ],
+  "globals": {},
+  "rules": {
+    "semi": "off", // handled by typescript-formatter/format
+    "space-before-function-paren": "off", // handled by typescript-formatter/format
+    "indent": ["error", 2],
+    "@typescript-eslint/ban-ts-comment": "off",
+    "@typescript-eslint/no-explicit-any": "error",
+    "typescript-formatter/format": [
+      "error",
+      {
+        "baseIndentSize": 0,
+        "indentSize": 2,
+        "tabSize": 2,
+        "newLineCharacter": "\n",
+        "convertTabsToSpaces": true,
+        "indentStyle": 2,
+        "trimTrailingWhitespace": true,
+        "insertSpaceAfterCommaDelimiter": true,
+        "insertSpaceAfterSemicolonInForStatements": true,
+        "insertSpaceBeforeAndAfterBinaryOperators": true,
+        "insertSpaceAfterConstructor": true,
+        "insertSpaceAfterKeywordsInControlFlowStatements": true,
+        "insertSpaceAfterFunctionKeywordForAnonymousFunctions": true,
+        "insertSpaceAfterOpeningAndBeforeClosingNonemptyParenthesis": false,
+        "insertSpaceAfterOpeningAndBeforeClosingNonemptyBrackets": false,
+        "insertSpaceAfterOpeningAndBeforeClosingNonemptyBraces": true,
+        "insertSpaceAfterOpeningAndBeforeClosingEmptyBraces": false,
+        "insertSpaceAfterOpeningAndBeforeClosingTemplateStringBraces": false,
+        "insertSpaceAfterOpeningAndBeforeClosingJsxExpressionBraces": false,
+        "insertSpaceAfterTypeAssertion": false,
+        "insertSpaceBeforeFunctionParenthesis": false,
+        "placeOpenBraceOnNewLineForFunctions": false,
+        "placeOpenBraceOnNewLineForControlBlocks": false,
+        "insertSpaceBeforeTypeAnnotation": false,
+        "indentMultiLineObjectLiteralBeginningOnBlankLine": false,
+        "semicolons": "remove"
+      }
+    ]
+  }
+}

package.json

@@ -97,6 +97,7 @@
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-promise": "^4.2.1",
     "eslint-plugin-standard": "^4.0.1",
+    "eslint-plugin-typescript-formatter": "0.0.2",
     "eslint-plugin-wdio": "^7.18.0",
     "express": "^4.17.1",
     "fs-extra": "^9.0.1",

src/config-validators/remove-invalid-pairs.ts

@@ -1,6 +1,6 @@
 import { EventBus, LiveConnectConfig } from '../types'
 
-export function removeInvalidPairs (config: LiveConnectConfig, eventBus: EventBus): LiveConnectConfig {
+export function removeInvalidPairs(config: LiveConnectConfig, eventBus: EventBus): LiveConnectConfig {
   if (config && config.appId && config.distributorId) {
     const distributorId = config.distributorId
     delete config.distributorId

src/enrichers/identifiers-nohash.ts

@@ -3,7 +3,7 @@ import { safeToString, isArray, trim } from '../utils/types'
 import { EventBus, RetrievedIdentifier, State } from '../types'
 import { MinimalStorageHandler } from '../handlers/storage-handler'
 
-export function enrich (state: State, storageHandler: MinimalStorageHandler, eventBus: EventBus): State {
+export function enrich(state: State, storageHandler: MinimalStorageHandler, eventBus: EventBus): State {
   try {
     return _parseIdentifiersToResolve(state, storageHandler)
   } catch (e) {
@@ -12,7 +12,7 @@ export function enrich (state: State, storageHandler: MinimalStorageHandler, eve
   }
 }
 
-function _parseIdentifiersToResolve (state: State, storageHandler: MinimalStorageHandler): State {
+function _parseIdentifiersToResolve(state: State, storageHandler: MinimalStorageHandler): State {
   state.identifiersToResolve = state.identifiersToResolve || []
   const cookieNames = isArray(state.identifiersToResolve) ? state.identifiersToResolve : safeToString(state.identifiersToResolve).split(',')
   const identifiers: RetrievedIdentifier[] = []

src/enrichers/identifiers.ts

@@ -3,7 +3,7 @@ import { safeToString, isString, isArray } from '../utils/types'
 import { EventBus, HashedEmail, State, RetrievedIdentifier } from '../types'
 import { MinimalStorageHandler } from '../handlers/storage-handler'
 
-export function enrich (state: State, storageHandler: MinimalStorageHandler, eventBus: EventBus): State {
+export function enrich(state: State, storageHandler: MinimalStorageHandler, eventBus: EventBus): State {
   try {
     return _getIdentifiers(_parseIdentifiersToResolve(state), storageHandler)
   } catch (e) {
@@ -14,7 +14,7 @@ export function enrich (state: State, storageHandler: MinimalStorageHandler, eve
   }
 }
 
-function _parseIdentifiersToResolve (state: State): string[] {
+function _parseIdentifiersToResolve(state: State): string[] {
   let cookieNames: string[] = []
   if (state.identifiersToResolve) {
     if (isArray(state.identifiersToResolve)) {
@@ -29,7 +29,7 @@ function _parseIdentifiersToResolve (state: State): string[] {
   return cookieNames
 }
 
-function _getIdentifiers (cookieNames: string[], storageHandler: MinimalStorageHandler): State {
+function _getIdentifiers(cookieNames: string[], storageHandler: MinimalStorageHandler): State {
   const identifiers: RetrievedIdentifier[] = []
   let hashes: HashedEmail[] = []
   for (let i = 0; i < cookieNames.length; i++) {
@@ -50,7 +50,7 @@ function _getIdentifiers (cookieNames: string[], storageHandler: MinimalStorageH
   }
 }
 
-function _deduplicateHashes (hashes: HashedEmail[]): HashedEmail[] {
+function _deduplicateHashes(hashes: HashedEmail[]): HashedEmail[] {
   const seen = new Set<string>()
   const result: HashedEmail[] = []
   for (let i = 0; i < hashes.length; i++) {

src/enrichers/page.ts

@@ -1,12 +1,9 @@
 import { State } from '../types'
 import { getPage, getReferrer, getContextElements } from '../utils/page'
 
-/**
- * @private
- */
 let _currentPage: State | null = null
 
-export function enrich (state: State): State {
+export function enrich(state: State): State {
   if (_currentPage) {
     return _currentPage
   } else {

src/enrichers/people-verified.ts

@@ -2,7 +2,7 @@ import { PEOPLE_VERIFIED_LS_ENTRY } from '../utils/consts'
 import { EventBus, State } from '../types'
 import { MinimalStorageHandler } from '../handlers/storage-handler'
 
-export function enrich (state: State, storageHandler: MinimalStorageHandler, eventBus: EventBus): State {
+export function enrich(state: State, storageHandler: MinimalStorageHandler, eventBus: EventBus): State {
   try {
     return { peopleVerifiedId: state.peopleVerifiedId || storageHandler.getDataFromLocalStorage(PEOPLE_VERIFIED_LS_ENTRY) || undefined }
   } catch (e) {

src/enrichers/privacy-config.ts

@@ -1,7 +1,7 @@
 import { State } from '../types'
 import { isNonEmpty } from '../utils/types'
 
-export function enrich (state: State): State {
+export function enrich(state: State): State {
   if (isNonEmpty(state) && isNonEmpty(state.gdprApplies)) {
     const privacyMode = !!state.gdprApplies
     return {

src/events/error-pixel.ts

@@ -15,7 +15,7 @@ const _defaultReturn: State = {
   }
 }
 
-function _asInt (field: unknown): number | undefined {
+function _asInt(field: unknown): number | undefined {
   try {
     const intValue = (field as number) * 1
     return isNaN(intValue) ? undefined : intValue
@@ -24,7 +24,7 @@ function _asInt (field: unknown): number | undefined {
   }
 }
 
-function _truncate (value: unknown): string | undefined {
+function _truncate(value: unknown): string | undefined {
   try {
     if (isString(value) && value.length && value.length > MAX_ERROR_FIELD_LENGTH) {
       return `${value.substr(0, MAX_ERROR_FIELD_LENGTH)}...`
@@ -35,7 +35,7 @@ function _truncate (value: unknown): string | undefined {
   }
 }
 
-export function asErrorDetails (e: unknown): State {
+export function asErrorDetails(e: unknown): State {
   if (isRecord(e)) {
     return {
       errorDetails: {
@@ -52,7 +52,7 @@ export function asErrorDetails (e: unknown): State {
   }
 }
 
-export function register (state: State, callHandler: CallHandler, eventBus: EventBus): void {
+export function register(state: State, callHandler: CallHandler, eventBus: EventBus): void {
   try {
     const pixelSender = new PixelSender(state, callHandler, eventBus)
 

src/events/event-bus.ts

@@ -4,15 +4,15 @@ import * as C from '../utils/consts'
 import { isFunction } from '../utils/types'
 import { EventBus } from '../types'
 
-function initBus (size?: number): EventBus {
+function initBus(size?: number): EventBus {
   if (typeof size === 'number' && size >= 0) {
     return new ReplayEmitter(size)
   } else {
     return new ReplayEmitter(5)
   }
 }
 
-function extendBusIfNeeded (bus: EventBus) {
+function extendBusIfNeeded(bus: EventBus) {
   if (isFunction(bus.emitErrorWithMessage) && isFunction(bus.emitError)) {
     return
   }
@@ -27,11 +27,11 @@ function extendBusIfNeeded (bus: EventBus) {
   }
 }
 
-export function LocalEventBus (size = 5) {
+export function LocalEventBus(size = 5) {
   return initBus(size)
 }
 
-export function GlobalEventBus (name: string, size: number, errorCallback: (error: unknown) => void): EventBus {
+export function GlobalEventBus(name: string, size: number, errorCallback: (error: unknown) => void): EventBus {
   try {
     if (!window) {
       errorCallback(new Error('Bus can only be attached to the window, which is not present'))
@@ -47,7 +47,7 @@ export function GlobalEventBus (name: string, size: number, errorCallback: (erro
   }
 }
 
-export function getAvailableBus (name: string): EventBus {
+export function getAvailableBus(name: string): EventBus {
   const eventBus = window[name].eventBus || window[C.EVENT_BUS_NAMESPACE]
   extendBusIfNeeded(eventBus)
   return eventBus

src/events/replayemitter.ts

@@ -3,14 +3,14 @@ import { ErrorDetails, EventBus } from '../types'
 import { isObject } from '../utils/types'
 
 interface EventHandler {
-  callback: (data: unknown) => void;
-  unbound: (data: unknown) => void;
+  callback: (data: unknown) => void
+  unbound: (data: unknown) => void
 }
 
 export class ReplayEmitter implements EventBus {
-  private h: Record<string, EventHandler[]>;
-  private q: Record<string, unknown[]>;
-  size: number;
+  private h: Record<string, EventHandler[]>
+  private q: Record<string, unknown[]>
+  size: number
 
   constructor (replaySize: number | string) {
     this.size = 5
@@ -25,7 +25,7 @@ export class ReplayEmitter implements EventBus {
     this.q = {}
   }
 
-  on <F extends ((event: unknown) => void)> (name: string, callback: F, ctx?: ThisParameterType<F>): this {
+  on<F extends ((event: unknown) => void)>(name: string, callback: F, ctx?: ThisParameterType<F>): this {
     const handler: EventHandler = {
       callback: callback.bind(ctx),
       unbound: callback
@@ -41,7 +41,7 @@ export class ReplayEmitter implements EventBus {
     return this
   }
 
-  once <F extends ((event: unknown) => void)> (name: string, callback: F, ctx?: ThisParameterType<F>): this {
+  once<F extends ((event: unknown) => void)>(name: string, callback: F, ctx?: ThisParameterType<F>): this {
     const eventQueue = this.q[name] || []
     if (eventQueue.length > 0) {
       callback.call(ctx, eventQueue[0])
@@ -57,7 +57,7 @@ export class ReplayEmitter implements EventBus {
     }
   }
 
-  emit (name: string, event: unknown): this {
+  emit(name: string, event: unknown): this {
     const evtArr = (this.h[name] || []).slice()
     let i = 0
     const len = evtArr.length
@@ -75,7 +75,7 @@ export class ReplayEmitter implements EventBus {
     return this
   }
 
-  off (name: string, callback: (event: unknown) => void): this {
+  off(name: string, callback: (event: unknown) => void): this {
     const handlers = this.h[name]
     const liveEvents = []
 
@@ -94,18 +94,18 @@ export class ReplayEmitter implements EventBus {
     return this
   }
 
-  emitErrorWithMessage (name: string, message: string, exception: unknown): this {
+  emitErrorWithMessage(name: string, message: string, exception: unknown): this {
     const wrappedError = wrapError(name, message, exception)
     return this.emit(C.ERRORS_PREFIX, wrappedError)
   }
 
-  emitError (name: string, exception: unknown): this {
+  emitError(name: string, exception: unknown): this {
     const wrappedError = wrapError(name, undefined, exception)
     return this.emit(C.ERRORS_PREFIX, wrappedError)
   }
 }
 
-export function wrapError (name: string, message?: string, e?: unknown): ErrorDetails {
+export function wrapError(name: string, message?: string, e?: unknown): ErrorDetails {
   if (isObject(e)) {
     let error: ErrorDetails
     if ('message' in e && typeof e.message === 'string') {

src/handlers/call-handler.ts

@@ -7,11 +7,11 @@ interface WrappedExternalCallHandler {
     onSuccess: (responseText: string, response: unknown) => void,
     onError?: (error: unknown) => void,
     timeout?: number
-  ) => void;
+  ) => void
   pixelGet: (
-      url: string,
-      onLoad?: () => void
-  ) => void;
+    url: string,
+    onLoad?: () => void
+  ) => void
 }
 
 export class CallHandler {
@@ -28,7 +28,7 @@ export class CallHandler {
     wrapper.reportErrors()
   }
 
-  ajaxGet (
+  ajaxGet(
     url: string,
     onSuccess: (responseText: string, response: unknown) => void,
     onError?: (error: unknown) => void,
@@ -37,7 +37,7 @@ export class CallHandler {
     this.functions.ajaxGet(url, onSuccess, onError, timeout)
   }
 
-  pixelGet (
+  pixelGet(
     url: string,
     onLoad?: () => void
   ): void {