cleanup todos

Author: ShMcK

src/actions/tutorialConfig.ts

@@ -26,7 +26,7 @@ const tutorialConfig = async (
       })
     })
 
-    // TODO: if remote not already set
+    // TODO if remote not already set
     await git.setupRemote(config.repo.uri).catch(error => {
       onError({ title: error.message, description: 'Remove your current Git project and restarting' })
     })

src/actions/utils/openFiles.ts

@@ -8,7 +8,7 @@ const openFiles = async (files: string[]) => {
   }
   for (const filePath of files) {
     try {
-      // TODO: figure out why this does not work
+      // TODO figure out why this does not work
       // 	try {
       // 		const absoluteFilePath = join(workspaceRoot.uri.path, filePath)
       // 		const doc = await vscode.workspace.openTextDocument(absoluteFilePath)

src/channel/index.ts

@@ -114,11 +114,6 @@ class Channel implements Channel {
           onError,
         )
         return
-      case 'EDITOR_SYNC_PROGRESS':
-        // sync client progress on server
-        this.context.position.set(action.payload.position)
-        this.context.progress.set(action.payload.progress)
-        return
       // load step actions (git commits, commands, open files)
       case 'SETUP_ACTIONS':
         vscode.commands.executeCommand(COMMANDS.SET_CURRENT_STEP, action.payload)

src/channel/state/Position.ts

@@ -13,18 +13,25 @@ class Position {
     this.value = defaultValue
   }
   public get = () => {
+    if (!this.value.levelId || !this.value.stepId) {
+      console.log('NO POSITION RETURNED')
+    }
+    console.log(this.value)
     return this.value
   }
   public set = (value: CR.Position) => {
+    console.log('--- position set')
+    console.log(value)
     this.value = value
   }
   public reset = () => {
     this.value = defaultValue
   }
   // calculate the current position based on the saved progress
   public setPositionFromProgress = (tutorial: G.Tutorial, progress: CR.Progress): CR.Position => {
+    console.log('--- set position from progress')
     // tutorial already completed
-    // TODO: handle start again?
+    // TODO handle start again?
     if (progress.complete) {
       return this.value
     }
@@ -36,7 +43,7 @@ class Position {
     const { levels } = tutorial.version.data
 
     const lastLevelIndex: number | undefined = levels.findIndex((l: G.Level) => !progress.levels[l.id])
-    // TODO: consider all levels complete as progress.complete
+    // TODO consider all levels complete as progress.complete
     if (lastLevelIndex >= levels.length) {
       throw new Error('Error setting progress level')
     }
@@ -56,6 +63,9 @@ class Position {
       levelId: currentLevel.id,
       stepId: currentStep.id,
     }
+
+    console.log('--- calculated set position from progress')
+    console.log(this.value)
     return this.value
   }
 }

src/channel/state/Progress.ts

@@ -43,6 +43,9 @@ class Progress {
   public setStepComplete = (stepId: string): CR.Progress => {
     const next = this.value
     next.steps[stepId] = true
+
+    // TODO validate if progress is complete for a level or tutorial
+
     return this.set(next)
   }
 }

src/channel/state/Tutorial.ts

@@ -6,20 +6,21 @@ import Storage from '../../services/storage'
 // Tutorial
 class Tutorial {
   private storage: Storage<G.Tutorial | null>
-  private value: G.Tutorial | null
+  private value: G.Tutorial | null = null
   constructor(workspaceState: vscode.Memento) {
     this.storage = new Storage<G.Tutorial | null>({
       key: 'coderoad:currentTutorial',
       storage: workspaceState,
       defaultValue: null,
     })
-    this.value = null
     // set value from storage
     this.storage.get().then((value: G.Tutorial | null) => {
       this.value = value
     })
   }
-  public get = () => this.value
+  public get = () => {
+    return this.value
+  }
   public set = (value: G.Tutorial | null) => {
     this.value = value
     this.storage.set(value)

src/editor/commands.ts

@@ -26,7 +26,7 @@ export const createCommands = ({ extensionPath, workspaceState, workspaceRoot }:
   return {
     // initialize
     [COMMANDS.START]: async () => {
-      // TODO: replace with a prompt to open a workspace
+      // TODO replace with a prompt to open a workspace
       // await isEmptyWorkspace()
 
       let webviewState: 'INITIALIZING' | 'RESTARTING'
@@ -58,6 +58,7 @@ export const createCommands = ({ extensionPath, workspaceState, workspaceRoot }:
           // send test pass message back to client
           vscode.window.showInformationMessage('PASS')
           webview.send({ type: 'TEST_PASS', payload })
+          // update local storage
         },
         onFail: (payload: Payload, message: string) => {
           // send test fail message back to client
@@ -75,7 +76,6 @@ export const createCommands = ({ extensionPath, workspaceState, workspaceRoot }:
       })
     },
     [COMMANDS.SET_CURRENT_STEP]: ({ stepId }: Payload) => {
-      // NOTE: as async, may sometimes be inaccurate
       // set from last setup stepAction
       currentStepId = stepId
     },

src/services/git/index.ts

@@ -119,7 +119,7 @@ export async function checkRemoteExists(): Promise<boolean> {
       return false
     }
     // string match on remote output
-    // TODO: improve the specificity of this regex
+    // TODO improve the specificity of this regex
     return !!stdout.match(gitOrigin)
   } catch (error) {
     return false

src/services/storage/index.ts

@@ -16,10 +16,10 @@ class Storage<T> {
     this.defaultValue = defaultValue
   }
   public get = async (): Promise<T> => {
-    // const value: string | undefined = await this.storage.get(this.key)
-    // if (value) {
-    // 	return JSON.parse(value)
-    // }
+    const value: string | undefined = await this.storage.get(this.key)
+    if (value) {
+      return JSON.parse(value)
+    }
     return this.defaultValue
   }
   public set = (value: T): void => {

src/webview/index.ts

@@ -12,7 +12,7 @@ interface ReactWebViewProps {
 
 const createReactWebView = ({ extensionPath, workspaceState, workspaceRoot }: ReactWebViewProps) => {
   let loaded = false
-  // TODO: add disposables
+  // TODO add disposables
   const disposables: vscode.Disposable[] = []
 
   function createWebViewPanel(): vscode.WebviewPanel {