setup xstate with interpreter

.vscode/settings.json

@@ -16,7 +16,6 @@
     "source.fixAll": true,
   },
   "tslint.enable": true,
-  "tslint.jsEnable": true,
   "[javascript]": {
     "editor.formatOnSave": true
   },

package.json

@@ -11,20 +11,21 @@
 	],
 	"publisher": "Shawn McKay <[email protected]>",
 	"activationEvents": [
-		"onCommand:coderoad.tutorial_load"
+		"onCommand:coderoad.start"
 	],
 	"main": "./out/extension.js",
 	"contributes": {
 		"commands": [
 			{
-				"command": "coderoad.tutorial_load",
-				"title": "Load Tutorial",
+				"command": "coderoad.start",
+				"title": "Start",
 				"category": "CodeRoad"
 			}
 		]
 	},
 	"scripts": {
 		"vscode:prepublish": "npm run compile",
+		"machine": "node ./out/state/index.js",
 		"compile": "tsc -p ./",
 		"watch": "tsc -watch -p ./",
 		"postinstall": "node ./node_modules/vscode/bin/install",

src/editor/commands/index.ts

@@ -1,22 +1,23 @@
 import * as vscode from 'vscode'
 
 // import runTest from './runTest'
-import tutorialLoad from './tutorialLoad'
+import start from './start'
 // import loadSolution from './loadSolution'
 // import quit from './quit'
 
 const COMMANDS = {
   // TUTORIAL_SETUP: 'coderoad.tutorial_setup',
-  TUTORIAL_LOAD: 'coderoad.tutorial_load',
+  START: 'coderoad.start',
   // RUN_TEST: 'coderoad.test_run',
   // LOAD_SOLUTION: 'coderoad.solution_load',
   // QUIT: 'coderoad.quit',
 }
 
 export default (context: vscode.ExtensionContext): void => {
   const commands = {
-    [COMMANDS.TUTORIAL_LOAD](): void {
-      tutorialLoad(context)
+    [COMMANDS.START](): void {
+      console.log('TUTORIAL_START')
+      start(context)
     },
     // [COMMANDS.RUN_TEST]: runTest,
     // [COMMANDS.LOAD_SOLUTION]: loadSolution,

src/editor/commands/tutorialLoad.ts → src/editor/commands/start.ts

@@ -1,27 +1,25 @@
 import * as vscode from 'vscode'
 import * as CR from 'typings'
 
-import api from '../../services/api'
 import tutorialSetup from '../../services/tutorialSetup'
-import { loadProgressPosition } from '../../services/position'
-import * as storage from '../../services/storage'
-import rootSetup from '../../services/rootSetup'
 import { isEmptyWorkspace, openReadme } from '../workspace'
-import * as git from '../../services/git'
+import { setWorkspaceRoot } from '../../services/node'
+import { setStorage } from '../../editor/storage'
+import createStateMachine from '../../state'
 
 /*
 new
 if current workspace is empty, use it
 if not, open a new folder then start
 */
 
-async function continueTutorial() {
-  // TODO: verify that tutorial is loaded in workspace
-  // TODO: verify progress
-  // TODO: verify setup
-  await loadProgressPosition()
-  await openReadme()
-}
+// async function continueTutorial() {
+//   // TODO: verify that tutorial is loaded in workspace
+//   // TODO: verify progress
+//   // TODO: verify setup
+//   await loadProgressPosition()
+//   await openReadme()
+// }
 
 async function newTutorial(tutorial: CR.Tutorial) {
   // if workspace isn't empty, clear it out if given permission
@@ -40,23 +38,15 @@ async function newTutorial(tutorial: CR.Tutorial) {
 }
 
 
-async function validateCanContinue(): Promise<boolean> {
-  // validate tutorial & progress found in local storage
-  // validate git is setup with a remote
-  const [tutorial, progress, hasGit, hasGitRemote] = await Promise.all([
-    storage.getTutorial(),
-    storage.getProgress(),
-    git.gitVersion(),
-    git.gitCheckRemoteExists(),
-  ])
-  return !!(tutorial && progress && hasGit && hasGitRemote)
-}
-
-export default async function tutorialLoad(context: vscode.ExtensionContext): Promise<void> {
-  console.log(`tutorialLoad ${JSON.stringify(context)}`)
+export default async function start(context: vscode.ExtensionContext): Promise<void> {
+  console.log('start', context)
 
   // setup connection to workspace
-  await rootSetup(context)
+  await setWorkspaceRoot()
+  // set workspace context path
+  await setStorage(context.workspaceState)
+  // initiate the state machine
+  createStateMachine()
   return;
 
   // const modes = ['New']

src/editor/init.ts

@@ -0,0 +1,33 @@
+// The module 'vscode' contains the VS Code extensibility API
+// Import the module and reference it with the alias vscode in your code below
+import * as vscode from 'vscode'
+
+import createCommands from './commands'
+import createViews from './views'
+import createStateMachine from '../state'
+
+// this method is called when your extension is activated
+// your extension is activated the very first time the command is executed
+export function activate(context: vscode.ExtensionContext) {
+    console.log('ACTIVATE!')
+
+    // commands
+    createCommands(context)
+
+    // tasks
+    // add tasks here
+
+    // views
+    createViews(context)
+
+
+}
+
+// this method is called when your extension is deactivated
+export function deactivate(context: vscode.ExtensionContext): void {
+    // cleanup subscriptions/tasks
+    console.log('deactivate context', context)
+    for (const disposable of context.subscriptions) {
+        disposable.dispose()
+    }
+}

src/extension.ts

@@ -1,30 +1,2 @@
-// The module 'vscode' contains the VS Code extensibility API
-// Import the module and reference it with the alias vscode in your code below
-import * as vscode from 'vscode'
+export { activate, deactivate } from './editor/init'
 
-import createCommands from './editor/commands'
-import createViews from './views'
-
-// this method is called when your extension is activated
-// your extension is activated the very first time the command is executed
-export function activate(context: vscode.ExtensionContext) {
-	console.log('ACTIVATE!')
-
-	// commands
-	createCommands(context)
-
-	// tasks
-	// add tasks here
-
-	// views
-	createViews(context)
-}
-
-// this method is called when your extension is deactivated
-export function deactivate(context: vscode.ExtensionContext): void {
-	// cleanup subscriptions/tasks
-	console.log('deactivate context', context)
-	for (const disposable of context.subscriptions) {
-		disposable.dispose()
-	}
-}

src/state/actions/index.ts

@@ -13,6 +13,7 @@ let initialProgress: CR.Progress = {
 
 export default {
     start: async () => {
+        console.log('ACTION: start')
         // verify that the user has a tutorial & progress
         // verify git is setup with a coderoad remote
         const [tutorial, progress, hasGit, hasGitRemote] = await Promise.all([
@@ -31,16 +32,19 @@ export default {
     tutorialLoad: assign({
         // load initial data, progress & position
         data(): CR.TutorialData {
+            console.log('ACTION: tutorialLoad.data')
             if (!initialTutorial) {
                 throw new Error('No Tutorial loaded')
             }
             return initialTutorial.data
 
         },
         progress(): CR.Progress {
+            console.log('ACTION: tutorialLoad.progress')
             return initialProgress
         },
         position() {
+            console.log('ACTION: tutorialLoad.position')
             if (!initialTutorial) {
                 throw new Error('No Tutorial loaded')
             }

src/state/guards/index.ts

@@ -3,6 +3,7 @@ import * as CR from 'typings'
 export default {
     // skip to the stage if the level has already been started
     hasNoNextLevelProgress: (context: CR.MachineContext): boolean => {
+        console.log('GUARD: hasNoNextLevelProgress')
         return false
     },
 }

src/state/index.ts

@@ -0,0 +1,28 @@
+import { interpret } from 'xstate'
+import machine from './machine'
+
+
+const createStateMachine = () => {
+    const machineOptions = {
+        logger: console.log,
+        devTools: true,
+        deferEvents: true,
+        execute: true
+    }
+    // machine interpreter
+    // https://xstate.js.org/docs/guides/interpretation.html
+    const service = interpret(machine, machineOptions)
+        // logging
+        .onTransition(state => {
+            console.log('state', state)
+            if (state.changed) {
+                console.log('transition')
+                console.log(state.value)
+            }
+        })
+    // initialize
+    service.start()
+    return service
+}
+
+export default createStateMachine

src/state/machine.ts

@@ -5,9 +5,7 @@ import actions from './actions'
 import guards from './guards'
 import initialContext from './context'
 
-// TODO: replace with API
-
-export const tutorialMachine = Machine<
+export const machine = Machine<
     CR.MachineContext,
     CR.MachineStateSchema,
     CR.MachineEvent
@@ -18,6 +16,7 @@ export const tutorialMachine = Machine<
         initial: 'Start',
         states: {
             Start: {
+                initial: 'Initial',
                 states: {
                     Initial: {
                         onEntry: 'start',
@@ -157,3 +156,5 @@ export const tutorialMachine = Machine<
         activities: {},
     },
 )
+
+export default machine