refactor: adjust by the eslint

oct16 · Aug 13, 2020 · ed5b766 · ed5b766
1 parent d0a47ee
commit ed5b766
Show file tree

Hide file tree

Showing 23 changed files with 94 additions and 71 deletions.
diff --git a/.eslintignore b/.eslintignore
@@ -0,0 +1,2 @@
+dist
+node_modules
diff --git a/.eslintrc b/.eslintrc
@@ -1,4 +1,5 @@
 {
+    "root": true,
     "parser": "@typescript-eslint/parser",
     "parserOptions": {
         "ecmaVersion": 2020,
@@ -9,5 +10,38 @@
         "prettier/@typescript-eslint",
         "plugin:prettier/recommended"
     ],
-    "rules": {}
+    "rules": {
+        "@typescript-eslint/ban-types": [
+            "off"
+        ],
+        "@typescript-eslint/no-empty-function": [
+            "off"
+        ],
+        "@typescript-eslint/no-this-alias": [
+            "error",
+            {
+                "allowDestructuring": true, // Allow `const { props, state } = this`; false by default
+                "allowedNames": [
+                    "self",
+                    "context"
+                ] // Allow `const self = this`; `[]` by default
+            }
+        ],
+        "@typescript-eslint/no-explicit-any": [
+            "off"
+            // "error",
+            // {
+            //     "ignoreRestArgs": true
+            // }
+        ],
+        "prefer-rest-params": [
+            "off"
+        ],
+        "@typescript-eslint/no-non-null-assertion": [
+            "off"
+        ],
+        "@typescript-eslint/explicit-module-boundary-types": [
+            "off"
+        ]
+    }
 }
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -31,7 +31,7 @@
         "doc": "npx typedoc",
         "embed": "cp packages/timecat/dist/timecatjs.min.js ../TimeCatChrome/src/assets/",
         "count": "find ./packages -type f -not -path **/*.spec.ts -not -path **/global.* -not -path './node_modules/*' -not -path '**/dist/*'  -name '*.ts' | xargs wc -l",
-        "lint": "eslint '*/**/*.{js,ts,tsx}' --quiet --fix"
+        "lint": "eslint 'packages/**/*.{js,ts}' --quiet --fix"
     },
     "devDependencies": {
         "@microsoft/api-extractor": "^7.8.9",
@@ -46,7 +46,6 @@
         "@types/node": "^13.9.2",
         "@types/pako": "^1.0.1",
         "@types/smoothscroll-polyfill": "^0.3.1",
-        "@types/socket.io-client": "^1.4.32",
         "@zerollup/ts-transform-paths": "^1.7.17",
         "diff": "^4.0.2",
         "execa": "^4.0.0",
@@ -65,11 +64,16 @@
         "rollup-plugin-typescript2": "^0.26.0",
         "rollup-plugin-visualizer": "^4.0.4",
         "smoothscroll-polyfill": "^0.4.4",
-        "socket.io": "^2.3.0",
         "ts-jest": "^26.1.0",
         "ttypescript": "^1.5.10",
         "typedoc": "^0.17.7",
-        "typescript": "^4.0.0-beta"
+        "typescript": "^3.9.7",
+        "@typescript-eslint/eslint-plugin": "^3.9.0",
+        "@typescript-eslint/parser": "^3.9.0",
+        "eslint": "^7.6.0",
+        "eslint-config-prettier": "^6.11.0",
+        "eslint-plugin-prettier": "^3.1.4",
+        "prettier": "^2.0.5"
     },
     "repository": {
         "type": "git",
@@ -82,12 +86,5 @@
     "files": [
         "lib"
     ],
-    "dependencies": {
-        "@typescript-eslint/eslint-plugin": "^3.9.0",
-        "@typescript-eslint/parser": "^3.9.0",
-        "eslint": "^7.6.0",
-        "eslint-config-prettier": "^6.11.0",
-        "eslint-plugin-prettier": "^3.1.4",
-        "prettier": "^2.0.5"
-    }
+    "dependencies": {}
 }
diff --git a/packages/player/src/dom.ts b/packages/player/src/dom.ts
@@ -97,7 +97,7 @@ export async function updateDom(this: PlayerComponent, Record: RecordData) {
 
         case RecordType.SCROLL: {
             const { top, left, id } = data as ScrollWatcherData
-            let target = id ? (nodeStore.getNode(id) as HTMLElement) : this.c.sandBoxDoc.documentElement
+            const target = id ? (nodeStore.getNode(id) as HTMLElement) : this.c.sandBoxDoc.documentElement
 
             const curTop = target.scrollTop
 
@@ -274,7 +274,7 @@ export async function updateDom(this: PlayerComponent, Record: RecordData) {
             if (src) {
                 const image = new Image()
                 image.src = src
-                image.onload = function(this: HTMLImageElement) {
+                image.onload = function (this: HTMLImageElement) {
                     ctx.drawImage(this, 0, 0)
                 }
             } else {

diff --git a/packages/player/src/keyboard.ts b/packages/player/src/keyboard.ts
@@ -35,7 +35,7 @@ export class KeyboardComponent {
         this.detectWindowIsActive()
     }
 
-    dispatchPlay(speed: number = 0) {
+    dispatchPlay(speed = 0) {
         reduxStore.dispatch({
             type: PlayerTypes.SPEED,
             data: {

diff --git a/packages/player/src/player.ts b/packages/player/src/player.ts
@@ -90,13 +90,7 @@ export class PlayerComponent {
         }
 
         if (this.audioData.src) {
-            this.audioBlobUrl =
-                location.href
-                    .split('/')
-                    .slice(0, -1)
-                    .join('/') +
-                '/' +
-                this.audioData.src
+            this.audioBlobUrl = location.href.split('/').slice(0, -1).join('/') + '/' + this.audioData.src
         } else {
             const bufferStrList = this.audioData.bufferStrList
             if (!bufferStrList.length) {

diff --git a/packages/record/src/audio/audio-recorder.ts b/packages/record/src/audio/audio-recorder.ts
@@ -37,7 +37,7 @@ export class Recorder {
 
         this.mediaNode = this.audioContext.createMediaStreamSource(this.mediaStream)
 
-        let createScript = this.audioContext.createScriptProcessor
+        const createScript = this.audioContext.createScriptProcessor
 
         this.processNode = createScript.call(this.audioContext, 4096, this.opts.channelCount, this.opts.channelCount)
 

diff --git a/packages/record/src/watchers/canvas.ts b/packages/record/src/watchers/canvas.ts
@@ -40,7 +40,7 @@ export class CanvasWatcher extends Watcher<CanvasRecord> {
                     const id = self.getNodeId(this.canvas)!
 
                     return typeof method === 'function'
-                        ? function() {
+                        ? function () {
                               const args = [...arguments]
                               if (name === 'drawImage') {
                                   args[0] = id
@@ -51,7 +51,7 @@ export class CanvasWatcher extends Watcher<CanvasRecord> {
                           }
                         : null
                 },
-                set: function(value: any) {
+                set: function (value: any) {
                     const id = self.getNodeId(this.canvas)!
                     self.aggregateDataEmitter(id, name, value)
 
@@ -82,7 +82,7 @@ export class CanvasWatcher extends Watcher<CanvasRecord> {
 
         const blockInstances = [CanvasGradient]
 
-        return function(this: any, id: number, prop: Prop, args: any) {
+        return function (this: any, id: number, prop: Prop, args: any) {
             const context = this
 
             function emitData(id: number) {

diff --git a/packages/record/src/watchers/dom.ts b/packages/record/src/watchers/dom.ts
@@ -128,7 +128,7 @@ export class DOMWatcher extends Watcher<DOMRecord> {
 
             const isParentSVG = parentVn && parentVn.extra.isSVG
 
-            let vn = addedSiblingMap.get(node)!
+            const vn = addedSiblingMap.get(node)!
 
             if (isParentSVG && isVNode(vn)) {
                 ;(vn as VNode).extra.isSVG = true

diff --git a/packages/record/src/watchers/form-element.ts b/packages/record/src/watchers/form-element.ts
@@ -37,9 +37,9 @@ export class FormElementWatcher extends Watcher<FormElementRecord> {
                     const inputType = target.getAttribute('type') || 'text'
 
                     let key = 'value'
-                    let value: any = target.value || ''
+                    const value: any = target.value || ''
                     let newValue: any = ''
-                    let patches: ReturnType<typeof getStrDiffPatches> = []
+                    const patches: ReturnType<typeof getStrDiffPatches> = []
 
                     if (inputType === 'checkbox' || inputType === 'radio') {
                         if (eventType === 'input') {
@@ -115,7 +115,7 @@ export class FormElementWatcher extends Watcher<FormElementRecord> {
                 const [target, key] = item
                 const original = context.Object.getOwnPropertyDescriptor(target, key)
                 context.Object.defineProperty(target, key, {
-                    set: function(value: string | boolean) {
+                    set: function (value: string | boolean) {
                         setTimeout(() => {
                             handleEvent.call(this, key, value)
                         })

diff --git a/packages/record/src/watchers/location.ts b/packages/record/src/watchers/location.ts
@@ -27,7 +27,7 @@ export class LocationWatcher extends Watcher<LocationRecord> {
     kidnapLocation(type: 'pushState' | 'replaceState') {
         const original = this.context.history[type]
 
-        return function(this: any) {
+        return function (this: any) {
             const e = new Event(type)
             e.arguments = arguments
             this.context.dispatchEvent(e)

diff --git a/packages/share/src/index.ts b/packages/share/src/index.ts
@@ -118,7 +118,7 @@ export interface DOMRecord {
     data: DOMWatcherData
     time: string
 }
-export interface DOMWatcherData extends DOMUpdateDataType {}
+export type DOMWatcherData = DOMUpdateDataType
 
 export interface AttributesUpdateData {
     id: number

diff --git a/packages/utils/src/redux/create-store.ts b/packages/utils/src/redux/create-store.ts
@@ -57,13 +57,13 @@ export function createStore(reducer: Reducer, initState: States = {}) {
     function getState(): StateMap
 
     function getState<T extends keyof StateMap>(name?: T): StateMap[T]
-    
+
     function getState<T extends keyof StateMap>(name?: T) {
         const s = state as StateMap
         if (name) {
             return s[name] as StateMap[T]
         }
-        return s 
+        return s
     }
 
     function getTypeInTopics(type: TopicName): TopicName | undefined {
@@ -72,7 +72,7 @@ export function createStore(reducer: Reducer, initState: States = {}) {
             progress: Object.keys(ProgressTypes)
         }
 
-        for (let [key, enums] of Object.entries(topics)) {
+        for (const [key, enums] of Object.entries(topics)) {
             if (enums.includes(type)) {
                 return key as TopicName
             }

diff --git a/packages/utils/src/redux/reducers/player.ts b/packages/utils/src/redux/reducers/player.ts
@@ -1,4 +1,4 @@
-let initState = {
+const initState = {
     speed: 0
 }
 

diff --git a/packages/utils/src/tools/dom.ts b/packages/utils/src/tools/dom.ts
@@ -76,7 +76,7 @@ export function completeAttrHref(str: string, node?: Element) {
             const doc = node.getRootNode() as Document
             const context = doc.defaultView as Window
 
-            let { href, path } = context?.__ReplayLocation__ || {}
+            const { href, path } = context?.__ReplayLocation__ || {}
 
             if (path && href) {
                 const relationHref = new URL(path, href)

diff --git a/packages/utils/src/tools/output.ts b/packages/utils/src/tools/output.ts
@@ -112,7 +112,7 @@ async function initOptions(html: Document, exportOptions: ExportOptions) {
 
 async function injectScripts(html: Document, scripts?: ScriptItem[]) {
     if (scripts) {
-        for (let scriptItem of scripts) {
+        for (const scriptItem of scripts) {
             const { src, name } = scriptItem
             let scriptContent = src
             const script = document.createElement('script')
@@ -193,7 +193,7 @@ async function injectData(html: Document, exportOptions: ExportOptions) {
     const jsonStrData = JSON.stringify(extractedData)
 
     const zipArray = pako.gzip(jsonStrData)
-    let outputStr: string = ''
+    let outputStr = ''
 
     for (let i = 0; i < zipArray.length; i++) {
         let num = zipArray[i]

diff --git a/packages/utils/src/tools/scroll.ts b/packages/utils/src/tools/scroll.ts
@@ -22,7 +22,7 @@ export function disableScrolling(target: Document) {
             'test' as any,
             () => {},
             Object.defineProperty({}, 'passive', {
-                get: function() {
+                get: function () {
                     supportsPassive = true
                 }
             })

diff --git a/packages/utils/src/tools/tool.ts b/packages/utils/src/tools/tool.ts
@@ -37,10 +37,10 @@ export function objectEquals(x: any, y: any): boolean {
     // recursive object equality check
     const p = Object.keys(x)
     return (
-        Object.keys(y).every(function(i) {
+        Object.keys(y).every(function (i) {
             return p.indexOf(i) !== -1
         }) &&
-        p.every(function(i) {
+        p.every(function (i) {
             return objectEquals(x[i], y[i])
         })
     )
@@ -57,13 +57,13 @@ export function throttle(
     let timeout: any = null
     let previous = 0
 
-    const later = function() {
+    const later = function () {
         previous = options.leading === false ? 0 : Date.now()
         timeout = null
         result = func.apply(context, args)
         if (!timeout) context = args = null
     }
-    return function(this: any) {
+    return function (this: any) {
         const now = Date.now()
         if (!previous && options.leading === false) previous = now
         const remaining = wait - (now - previous)
@@ -99,10 +99,10 @@ export function debounce<F extends Procedure>(
 ): (this: ThisParameterType<F>, ...args: Parameters<F>) => void {
     let timeoutId: ReturnType<typeof setTimeout> | undefined
 
-    return function(this: ThisParameterType<F>, ...args: Parameters<F>) {
+    return function (this: ThisParameterType<F>, ...args: Parameters<F>) {
         const context = this
 
-        const doLater = function() {
+        const doLater = function () {
             timeoutId = undefined
             if (!options.isImmediate) {
                 func.apply(context, args)