Parse description field in StateNode

statelyai · Feb 25, 2022 · 47a1af0 · 47a1af0
1 parent 957947d
commit 47a1af0
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 0 deletions.
diff --git a/examples/description.ts b/examples/description.ts
@@ -0,0 +1,11 @@
+import { createMachine } from "xstate";
+
+export const descriptionMachine = createMachine({
+  initial: "wow",
+  description: "hello!",
+  states: {
+    wow: {
+      description: "WOWZA!",
+    },
+  },
+});
diff --git a/src/stateNode.ts b/src/stateNode.ts
@@ -50,6 +50,7 @@ export type StateNodeReturn = {
   states?: GetParserResult<AnyParser<ObjectOfReturn<StateNodeReturn>>>;
   node: t.Node;
   meta?: GetParserResult<typeof StateMeta>;
+  description?: GetParserResult<typeof StringLiteral>;
   tsTypes?: GetParserResult<typeof TsTypes>;
   context?: GetParserResult<typeof Context>;
   data?: GetParserResult<typeof AnyNode>;
@@ -81,6 +82,7 @@ const StateNodeObject: AnyParser<StateNodeReturn> = objectTypeWithKnownKeys(
     context: Context,
     data: AnyNode,
     preserveActionOrder: BooleanLiteral,
+    description: StringLiteral,
   }),
 );
 

diff --git a/src/toMachineConfig.ts b/src/toMachineConfig.ts
@@ -83,6 +83,10 @@ const parseStateNode = (
     };
   }
 
+  if (astResult.description) {
+    config.description = astResult.description.value;
+  }
+
   if (astResult.onDone) {
     // @ts-ignore
     config.onDone = getTransitions(astResult.onDone);