do something nice for typescript

ShMcK · ShMcK · commit 50b27196efa1 · 2020-08-01T17:05:47.000-07:00
Signed-off-by: shmck &lt;shawn.j.mckay@gmail.com&gt;
diff --git a/src/actions/onActions.ts b/src/actions/onActions.ts
@@ -9,7 +9,7 @@ import logger from '../services/logger'
 
 interface SetupActions {
   actions: TT.StepActions
-  send: (action: T.Action) => void // send messages to client
+  send: T.Send
   dir?: string
 }
 
diff --git a/src/actions/onErrorPage.ts b/src/actions/onErrorPage.ts
@@ -2,7 +2,7 @@ import * as T from 'typings'
 import { readFile } from '../services/node'
 import logger from '../services/logger'
 
-const onErrorPage = async (action: T.Action): void => {
+const onErrorPage = async (action: T.Action): Promise<void> => {
   // Error middleware
   if (action?.payload?.error?.type) {
     // load error markdown message
diff --git a/src/actions/onOpenLogs.ts b/src/actions/onOpenLogs.ts
@@ -1,7 +1,7 @@
 import * as T from 'typings'
 import { showOutput } from '../services/testRunner/output'
 
-export const onOpenLogs = async (action: T.Action): void => {
+export const onOpenLogs = async (action: T.Action): Promise<void> => {
   const channel = action.payload.channel
   await showOutput(channel)
 }
diff --git a/src/actions/onRunReset.ts b/src/actions/onRunReset.ts
@@ -11,7 +11,7 @@ type ResetAction = {
 }
 
 // reset to the start of the last test
-const onRunReset = async (action: ResetAction, context: Context): void => {
+const onRunReset = async (action: ResetAction, context: Context): Promise<void> => {
   // reset to timeline
   const tutorial: TT.Tutorial | null = context.tutorial.get()
   const position: T.Position = action.position ? action.position : context.position.get()
diff --git a/src/actions/onStartup.ts b/src/actions/onStartup.ts
@@ -11,7 +11,7 @@ const onStartup = async (
   context: Context,
   workspaceState: vscode.Memento,
   send: (action: T.Action) => Promise<void>,
-): void => {
+): Promise<void> => {
   try {
     // check if a workspace is open, otherwise nothing works
     const noActiveWorkspace = !WORKSPACE_ROOT.length
diff --git a/src/actions/onTutorialConfigContinue.ts b/src/actions/onTutorialConfigContinue.ts
@@ -5,7 +5,7 @@ import Context from '../services/context/context'
 import tutorialConfig from './utils/tutorialConfig'
 import { COMMANDS } from '../commands'
 
-const onTutorialConfigContinue = async (action: T.Action, context: Context, send: T.Send): void => {
+const onTutorialConfigContinue = async (action: T.Action, context: Context, send: T.Send): Promise<void> => {
   try {
     const tutorialContinue: TT.Tutorial | null = context.tutorial.get()
     if (!tutorialContinue) {
diff --git a/src/actions/onTutorialConfigNew.ts b/src/actions/onTutorialConfigNew.ts
@@ -8,7 +8,7 @@ import { version, compareVersions } from '../services/dependencies'
 import Context from '../services/context/context'
 import tutorialConfig from './utils/tutorialConfig'
 
-const onTutorialConfigNew = async (action: T.Action, context: Context, send: T.Send): void => {
+const onTutorialConfigNew = async (action: T.Action, context: Context, send: T.Send): Promise<void> => {
   try {
     const data: TT.Tutorial = action.payload.tutorial
 
diff --git a/src/actions/onValidateSetup.ts b/src/actions/onValidateSetup.ts
@@ -1,8 +1,9 @@
+import * as T from 'typings'
 import * as E from 'typings/error'
 import { version } from '../services/dependencies'
 import { checkWorkspaceEmpty } from '../services/workspace'
 
-const onValidateSetup = async (send: T.Send): void => {
+const onValidateSetup = async (send: T.Send): Promise<void> => {
   try {
     // check workspace is selected
     const isEmptyWorkspace = await checkWorkspaceEmpty()
diff --git a/src/actions/utils/loadWatchers.ts b/src/actions/utils/loadWatchers.ts
@@ -14,7 +14,7 @@ const disposeWatcher = (watcher: string) => {
   delete watcherObject[watcher]
 }
 
-const loadWatchers = (watchers: string[]) => {
+const loadWatchers = (watchers: string[]): void => {
   if (!watchers.length) {
     // remove all watchers
     for (const watcher of Object.keys(watcherObject)) {
diff --git a/src/actions/utils/openFiles.ts b/src/actions/utils/openFiles.ts
@@ -2,7 +2,7 @@ import { join } from 'path'
 import * as vscode from 'vscode'
 import { COMMANDS } from '../../commands'
 
-const openFiles = async (files: string[]) => {
+const openFiles = async (files: string[]): Promise<void> => {
   if (!files.length) {
     return
   }
diff --git a/src/actions/utils/runCommands.ts b/src/actions/utils/runCommands.ts
@@ -7,7 +7,7 @@ interface RunCommands {
   dir?: string
 }
 
-const runCommands = async ({ commands, send, dir }: RunCommands) => {
+const runCommands = async ({ commands, send, dir }: RunCommands): Promise<void> => {
   if (!commands.length) {
     return
   }
diff --git a/src/environment.ts b/src/environment.ts
@@ -1,7 +1,7 @@
 import { getWorkspaceRoot } from './services/workspace'
 import * as os from 'os'
 
-export const VERSION = require('../package.json').version
+export const VERSION = require('../package.json').version // eslint-disable-line
 
 export const EXTENSION_ID = 'coderoad'
 
diff --git a/src/services/context/state/Position.ts b/src/services/context/state/Position.ts
@@ -16,7 +16,7 @@ class Position {
   constructor() {
     this.value = defaultValue
   }
-  setTutorial(workspaceState: vscode.Memento, tutorial: TT.Tutorial) {
+  setTutorial(workspaceState: vscode.Memento, tutorial: TT.Tutorial): void {
     this.storage = new Storage<T.Position>({
       key: `coderoad:position:${tutorial.id}:${tutorial.version}`,
       storage: workspaceState,
@@ -27,7 +27,7 @@ class Position {
     // set value from storage
     this.setTutorial(workspaceState, tutorial)
     // find first level & step id
-    let initLevel = tutorial.levels.length ? tutorial.levels[0] : null
+    const initLevel = tutorial.levels.length ? tutorial.levels[0] : null
     return this.set({
       levelId: initLevel?.id || '',
       stepId: initLevel?.steps.length ? initLevel.steps[0].id : null,
@@ -36,18 +36,18 @@ class Position {
   }
   async continuePosition(workspaceState: vscode.Memento, tutorial: TT.Tutorial): Promise<T.Position> {
     this.setTutorial(workspaceState, tutorial)
-    let position: T.Position = (await this.storage?.get()) || defaultValue
+    const position: T.Position = (await this.storage?.get()) || defaultValue
     return this.set(position)
   }
-  public get = () => {
+  public get = (): T.Position => {
     return this.value
   }
-  public set = (value: T.Position) => {
+  public set = (value: T.Position): T.Position => {
     this.value = value
     this.storage?.set(value)
     return this.value
   }
-  public reset = () => {
+  public reset = (): T.Position => {
     return this.set(defaultValue)
   }
 }
diff --git a/src/services/context/state/Tutorial.ts b/src/services/context/state/Tutorial.ts
@@ -17,14 +17,14 @@ class Tutorial {
       this.value = value
     })
   }
-  public get = () => {
+  public get = (): TT.Tutorial | null => {
     return this.value
   }
-  public set = (value: TT.Tutorial | null) => {
+  public set = (value: TT.Tutorial | null): void => {
     this.value = value
     this.storage.set(value)
   }
-  public reset = () => {
+  public reset = (): void => {
     this.set(null)
   }
 }
diff --git a/src/services/logger/index.ts b/src/services/logger/index.ts
@@ -1,6 +1,6 @@
 import { LOG } from '../../environment'
 
-export type Log = string | number | object | null | undefined
+export type Log = string | number | object | null | undefined // eslint-disable-line
 
 const logger = (...messages: Log[]): void => {
   if (!LOG) {
diff --git a/src/services/reset/index.ts b/src/services/reset/index.ts
@@ -5,7 +5,9 @@ interface Input {
   branch: string
 }
 
-const ignoreError = () => {}
+const ignoreError = () => {
+  /* */
+}
 
 // note: attempted to do this as a bash script
 // but requires the bash script has git permissions
diff --git a/src/services/reset/lastHash.ts b/src/services/reset/lastHash.ts
@@ -1,7 +1,7 @@
 import * as TT from '../../../typings/tutorial'
 import * as T from '../../../typings'
 
-const getLastCommitHash = (position: T.Position, tutorial: TT.Tutorial | null) => {
+const getLastCommitHash = (position: T.Position, tutorial: TT.Tutorial | null): string => {
   if (!tutorial) {
     throw new Error('No tutorial found')
   }
diff --git a/src/services/testRunner/index.ts b/src/services/testRunner/index.ts
@@ -26,10 +26,10 @@ interface TestRunnerParams {
   onSuccess?: () => void
 }
 
-const createTestRunner = (data: TT.Tutorial, callbacks: Callbacks) => {
+const createTestRunner = (data: TT.Tutorial, callbacks: Callbacks): ((params: any) => Promise<void>) => {
   const testRunnerConfig = data.config.testRunner
   const testRunnerFilterArg = testRunnerConfig.args?.filter
-  return async ({ position, onSuccess }: TestRunnerParams): Promise<void> => {
+  return async ({ position, onSuccess }: TestRunnerParams): Promise<any> => {
     const startTime = throttle()
     // throttle time early
     if (!startTime) {
diff --git a/src/services/testRunner/output.ts b/src/services/testRunner/output.ts
@@ -1,6 +1,10 @@
 import * as vscode from 'vscode'
 
-const channels: { key: string; value: vscode.OutputChannel } | {} = {}
+const channels:
+  | { key: string; value: vscode.OutputChannel }
+  | {
+      /* */
+    } = {}
 
 const getOutputChannel = (name: string): vscode.OutputChannel => {
   if (!channels[name]) {
@@ -15,18 +19,18 @@ interface ChannelOutput {
   show?: boolean
 }
 
-export const addOutput = (params: ChannelOutput) => {
+export const addOutput = (params: ChannelOutput): void => {
   const channel = getOutputChannel(params.channel)
   channel.clear()
   channel.append(params.text)
 }
 
-export const showOutput = (channelName: string) => {
+export const showOutput = (channelName: string): void => {
   const channel = getOutputChannel(channelName)
   channel.show()
 }
 
-export const clearOutput = (channelName: string) => {
+export const clearOutput = (channelName: string): void => {
   const channel = getOutputChannel(channelName)
   channel.clear()
   channel.hide()
diff --git a/src/services/webview/index.ts b/src/services/webview/index.ts
@@ -1,3 +1,4 @@
+import * as T from 'typings'
 import * as path from 'path'
 import { Action } from 'typings'
 import * as vscode from 'vscode'
@@ -9,9 +10,16 @@ interface ReactWebViewProps {
   workspaceState: vscode.Memento
 }
 
-let state = { loaded: false }
+interface Output {
+  state: { loaded: boolean }
+  createOrShow(): void
+  send: T.Send
+  receive: T.Send
+}
+
+const state = { loaded: false }
 
-const createReactWebView = ({ extensionPath, workspaceState }: ReactWebViewProps) => {
+const createReactWebView = ({ extensionPath, workspaceState }: ReactWebViewProps): Output => {
   // TODO add disposables
   const disposables: vscode.Disposable[] = []
 

Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ import logger from '../services/logger'`
`9`	`9`
`10`	`10`	`interface SetupActions {`
`11`	`11`	`actions: TT.StepActions`
`12`		`- send: (action: T.Action) => void // send messages to client`
	`12`	`+ send: T.Send`
`13`	`13`	`dir?: string`
`14`	`14`	`}`
`15`	`15`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`import * as T from 'typings'`
`2`	`2`	`import { showOutput } from '../services/testRunner/output'`
`3`	`3`
`4`		`-export const onOpenLogs = async (action: T.Action): void => {`
	`4`	`+export const onOpenLogs = async (action: T.Action): Promise<void> => {`
`5`	`5`	`const channel = action.payload.channel`
`6`	`6`	`await showOutput(channel)`
`7`	`7`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ type ResetAction = {`
`11`	`11`	`}`
`12`	`12`
`13`	`13`	`// reset to the start of the last test`
`14`		`-const onRunReset = async (action: ResetAction, context: Context): void => {`
	`14`	`+const onRunReset = async (action: ResetAction, context: Context): Promise<void> => {`
`15`	`15`	`// reset to timeline`
`16`	`16`	`const tutorial: TT.Tutorial \| null = context.tutorial.get()`
`17`	`17`	`const position: T.Position = action.position ? action.position : context.position.get()`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ const disposeWatcher = (watcher: string) => {`
`14`	`14`	`delete watcherObject[watcher]`
`15`	`15`	`}`
`16`	`16`
`17`		`-const loadWatchers = (watchers: string[]) => {`
	`17`	`+const loadWatchers = (watchers: string[]): void => {`
`18`	`18`	`if (!watchers.length) {`
`19`	`19`	`// remove all watchers`
`20`	`20`	`for (const watcher of Object.keys(watcherObject)) {`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@ import { join } from 'path'`
`2`	`2`	`import * as vscode from 'vscode'`
`3`	`3`	`import { COMMANDS } from '../../commands'`
`4`	`4`
`5`		`-const openFiles = async (files: string[]) => {`
	`5`	`+const openFiles = async (files: string[]): Promise<void> => {`
`6`	`6`	`if (!files.length) {`
`7`	`7`	`return`
`8`	`8`	`}`