chore(gatsby-cli): migrate redux folder to typescript

packages/gatsby-cli/src/reporter/redux/action-types.ts

@@ -0,0 +1,138 @@
+import { Actions, ActivityStatuses } from "../constants"
+import { IActivity } from "./reducer"
+import { Dispatch, AnyAction } from "redux"
+
+type dispatchAction = (dispatch: Dispatch<AnyAction>) => void
+
+export type actionsToEmitType = Array<
+  dispatchAction | { type: Actions; payload: Partial<IActivity> }
+>
+
+export interface IActionTypes {
+  setStatus(
+    status: string,
+    force?: boolean | undefined
+  ): (dispatch: Dispatch<AnyAction>) => void
+  createLog(arg0: {
+    text: string
+    level: string
+    duration: number
+    group?: string
+    code?: string
+    type?: string
+    filePath?: string
+    location?: string
+    docsUrl?: string
+    context?: string
+    statusText?: string
+    activity_uuid: string
+    activity_current: string
+    activity_total: number
+    activity_type: string
+    stack?: string
+  }): {
+    type: Actions
+    payload: {
+      level: string
+      text: string
+      statusText: string | undefined
+      duration: number
+      group: string | undefined
+      code: string | undefined
+      type: string | undefined
+      filePath: string | undefined
+      location: string | undefined
+      docsUrl: string | undefined
+      context: string | undefined
+      activity_current: string
+      activity_total: number
+      activity_type: string
+      activity_uuid: string
+      timestamp: string
+      stack: string | undefined
+    }
+  }
+
+  startActivity: ({
+    id,
+    text,
+    type,
+    status,
+    current,
+    total,
+  }: {
+    id: string
+    text: string
+    type: string
+    status?: ActivityStatuses | undefined
+    current: string
+    total: number
+  }) => actionsToEmitType
+
+  endActivity: ({
+    id,
+    status,
+  }: {
+    id: string
+    status: ActivityStatuses
+  }) => actionsToEmitType | null
+
+  createPendingActivity: ({
+    id,
+    status,
+  }: {
+    id: string
+    status?: ActivityStatuses | undefined
+  }) => actionsToEmitType
+
+  updateActivity: (
+    activity: Partial<IActivity>
+  ) => {
+    type: Actions
+    payload: Partial<IActivity>
+  } | null
+
+  setActivityErrored: ({
+    id,
+  }: {
+    id: string
+  }) => {
+    type: Actions
+    payload: {
+      id: IActivity["id"]
+    }
+  } | null
+
+  setActivityStatusText: ({
+    id,
+    statusText,
+  }: {
+    id: string
+    statusText: string
+  }) => {
+    type: Actions
+    payload: Partial<IActivity>
+  } | null
+
+  setActivityTotal: ({
+    id,
+    total,
+  }: {
+    id: string
+    total: number
+  }) => {
+    type: Actions
+    payload: Partial<IActivity>
+  } | null
+
+  activityTick: ({
+    id,
+    increment,
+  }: {
+    id: string
+    increment?: number | undefined
+  }) => {
+    type: Actions
+    payload: Partial<IActivity>
+  } | null
+}

packages/gatsby-cli/src/reporter/redux/actions.js → packages/gatsby-cli/src/reporter/redux/actions.ts

@@ -1,23 +1,31 @@
-// @flow
-const uuidv4 = require(`uuid/v4`)
-const convertHrtime = require(`convert-hrtime`)
-const { trackCli } = require(`gatsby-telemetry`)
-const { bindActionCreators } = require(`redux`)
-const { dispatch, getStore } = require(`./index`)
-const {
+/* eslint-disable @typescript-eslint/camelcase */
+
+import uuidv4 from "uuid/v4"
+import convertHrtime from "convert-hrtime"
+import { trackCli } from "gatsby-telemetry"
+import { bindActionCreators } from "redux"
+
+import { iface } from "./index"
+import {
   Actions,
   ActivityLogLevels,
   ActivityStatuses,
   ActivityTypes,
-} = require(`../constants`)
-const signalExit = require(`signal-exit`)
+} from "../constants"
+import signalExit from "signal-exit"
+
+import { IActivity } from "./reducer"
+import { IActionTypes, actionsToEmitType } from "./action-types"
 
-const getActivity = id => getStore().getState().logs.activities[id]
+const { dispatch, getStore } = iface
+
+const getActivity = (id: string): IActivity =>
+  getStore().getState().logs.activities[id]
 
 /**
  * @returns {Number} Milliseconds from activity start
  */
-const getElapsedTimeMS = activity => {
+const getElapsedTimeMS = (activity: IActivity): number => {
   const elapsed = process.hrtime(activity.startTime)
   return convertHrtime(elapsed).milliseconds
 }
@@ -28,7 +36,7 @@ const ActivityStatusToLogLevel = {
   [ActivityStatuses.Success]: ActivityLogLevels.Success,
 }
 
-const getGlobalStatus = (id, status) => {
+const getGlobalStatus = (id: string, status: ActivityStatuses): string => {
   const { logs } = getStore().getState()
 
   const currentActivities = [id, ...Object.keys(logs.activities)]
@@ -57,32 +65,36 @@ const getGlobalStatus = (id, status) => {
   }, ActivityStatuses.Success)
 }
 
-let cancelDelayedSetStatus = null
+type voidFunc = () => void
+
+let cancelDelayedSetStatus: voidFunc | null = null
 let weShouldExit = false
 signalExit(() => {
   weShouldExit = true
 })
+
 /**
  * Like setTimeout, but also handle signalExit
  */
-const delayedCall = (fn, timeout) => {
-  const fnWrap = () => {
+const delayedCall = (fn: voidFunc, timeout: number): voidFunc => {
+  const fnWrap = (): void => {
     fn()
+    // eslint-disable-next-line @typescript-eslint/no-use-before-define
     clear()
   }
 
   const timeoutID = setTimeout(fnWrap, timeout)
   const cancelSignalExit = signalExit(fnWrap)
 
-  const clear = () => {
+  const clear = (): void => {
     clearTimeout(timeoutID)
     cancelSignalExit()
   }
 
   return clear
 }
 
-const actions = {
+const actions: IActionTypes = {
   createLog: ({
     level,
     text,
@@ -125,7 +137,7 @@ const actions = {
     }
   },
   createPendingActivity: ({ id, status = ActivityStatuses.NotStarted }) => {
-    const actionsToEmit = []
+    const actionsToEmit: actionsToEmitType = []
 
     const logsState = getStore().getState().logs
 
@@ -146,7 +158,7 @@ const actions = {
 
     return actionsToEmit
   },
-  setStatus: (status, force = false) => dispatch => {
+  setStatus: (status, force = false) => (dispatch): void => {
     const currentStatus = getStore().getState().logs.status
 
     if (cancelDelayedSetStatus) {
@@ -175,7 +187,7 @@ const actions = {
     current,
     total,
   }) => {
-    const actionsToEmit = []
+    const actionsToEmit: actionsToEmitType = []
 
     const logsState = getStore().getState().logs
 
@@ -209,7 +221,7 @@ const actions = {
     if (!activity) {
       return null
     }
-    const actionsToEmit = []
+    const actionsToEmit: actionsToEmitType = []
     if (activity.type === ActivityTypes.Pending) {
       actionsToEmit.push({
         type: Actions.CancelActivity,
@@ -278,7 +290,7 @@ const actions = {
     return actionsToEmit
   },
 
-  updateActivity: ({ id, ...rest }) => {
+  updateActivity: ({ id = ``, ...rest }) => {
     const activity = getActivity(id)
     if (!activity) {
       return null
@@ -293,7 +305,7 @@ const actions = {
       },
     }
   },
-  setActivityErrored: ({ id, ...rest }) => {
+  setActivityErrored: ({ id }) => {
     const activity = getActivity(id)
     if (!activity) {
       return null
@@ -329,4 +341,4 @@ const actions = {
   },
 }
 
-module.exports = bindActionCreators(actions, dispatch)
+module.exports = bindActionCreators<any, any>(actions, dispatch)

packages/gatsby-cli/src/reporter/redux/index.js → packages/gatsby-cli/src/reporter/redux/index.ts

@@ -1,19 +1,30 @@
-const Redux = require(`redux`)
-const reducer = require(`./reducer`)
+import {
+  createStore,
+  combineReducers,
+  AnyAction,
+  Dispatch,
+  CombinedState,
+  Store,
+} from "redux"
+import { reducer, IState } from "./reducer"
 
-const { ActivityTypes, Actions } = require(`../constants`)
+import { ActivityTypes, Actions } from "../constants"
 
-let store = Redux.createStore(
-  Redux.combineReducers({
+let store = createStore(
+  combineReducers({
     logs: reducer,
   }),
   {}
 )
 
-const storeSwapListeners = []
-const onLogActionListeners = new Set()
+type store = Store<CombinedState<{ logs: IState }>, AnyAction>
 
-const isInternalAction = action => {
+type storeListener = (store: store) => void
+
+const storeSwapListeners: storeListener[] = []
+const onLogActionListeners = new Set<Dispatch<AnyAction>>()
+
+const isInternalAction = (action): boolean => {
   if (
     [
       Actions.PendingActivity,
@@ -31,7 +42,15 @@ const isInternalAction = action => {
   return false
 }
 
-const iface = {
+interface IIface {
+  dispatch(dispatch: any)
+  getStore: () => store
+  onStoreSwap: (fn: storeListener) => void
+  onLogAction: (fn: Dispatch<AnyAction>) => () => void
+  setStore: (s: store) => void
+}
+
+export const iface: IIface = {
   getStore: () => store,
   dispatch: action => {
     if (!action) {
@@ -67,7 +86,7 @@ const iface = {
   },
   onLogAction: fn => {
     onLogActionListeners.add(fn)
-    return () => {
+    return (): void => {
       onLogActionListeners.delete(fn)
     }
   },
@@ -80,5 +99,3 @@ const iface = {
     storeSwapListeners.forEach(fn => fn(store))
   },
 }
-
-module.exports = iface