expand documention on handling --help

trufflesuite · Jan 10, 2023 · 8656f79 · 8656f79
1 parent 580324e
commit 8656f79
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 0 deletions.
diff --git a/packages/core/cli.js b/packages/core/cli.js
@@ -69,7 +69,9 @@ if (
   const helpIndex = inputStrings.indexOf("--help");
 
   if (helpIndex !== -1) {
+    //remove `--help` from array
     inputStrings.splice(helpIndex, 1);
+    //insert `help` in first position
     inputStrings.unshift("help");
   }
 }

diff --git a/packages/dashboard/src/contexts/DashContext/state.ts b/packages/dashboard/src/contexts/DashContext/state.ts
@@ -49,6 +49,7 @@ export const initialState: State = {
   }
 };
 
+//To-do: set-analytics in reducer
 export const reducer = (state: State, action: Action): State => {
   const { type, data } = action;
   switch (type) {

diff --git a/packages/dashboard/src/contexts/DashContext/types/Action.ts b/packages/dashboard/src/contexts/DashContext/types/Action.ts
@@ -2,6 +2,8 @@ import type { ReceivedMessageLifecycle } from "@truffle/dashboard-message-bus-cl
 import type { Message } from "@truffle/dashboard-message-bus-common";
 import type { State } from "src/contexts/DashContext/types";
 
+//To-do: add set-analytics ActionType
+//To-do: add interface for SetAnalyticAction
 export type ActionType =
   | "set-decoder"
   | "set-chain-info"