Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

250 fsm state diagram mermaid generator #251

Merged
merged 56 commits into from
Feb 24, 2023

Conversation

quekyj
Copy link
Contributor

@quekyj quekyj commented Jan 30, 2023

Description & Motivation

It's easier if we can visualize the state diagram in the FSM from the implementation.

Related Issue(s)

Fix #250

Testing

Added unit test to make sure the diagram is generated and there the word "mermaid" inside the file.

Backwards-compatibility

Yes.

Documentation

Yes. Added the documentation.

example/counter.dart Outdated Show resolved Hide resolved
example/oven_fsm.dart Outdated Show resolved Hide resolved
example/oven_fsm.dart Outdated Show resolved Hide resolved
example/oven_fsm.dart Show resolved Hide resolved
lib/src/state_machine.dart Outdated Show resolved Hide resolved
lib/src/state_machine.dart Outdated Show resolved Hide resolved
@quekyj quekyj requested a review from mkorbel1 February 13, 2023 07:44
Copy link
Contributor

@chykon chykon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great! I really liked the example. Here are my suggestions:

oven_fsm.md Outdated Show resolved Hide resolved
oven_fsm.md Outdated Show resolved Hide resolved
oven_fsm.md Outdated Show resolved Hide resolved
oven_fsm.md Outdated Show resolved Hide resolved
example/oven_fsm.dart Outdated Show resolved Hide resolved
example/oven_fsm.dart Outdated Show resolved Hide resolved
example/oven_fsm.dart Outdated Show resolved Hide resolved
example/oven_fsm.dart Outdated Show resolved Hide resolved
example/oven_fsm.dart Outdated Show resolved Hide resolved
example/oven_fsm.dart Outdated Show resolved Hide resolved
@quekyj
Copy link
Contributor Author

quekyj commented Feb 15, 2023

@chykon the code looks a lot cleaner now 🤣.

@quekyj quekyj requested a review from mkorbel1 February 15, 2023 04:15
Copy link
Contributor

@chykon chykon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great job! I'm just learning how to do code reviews, so I'm sorry if I was not quite correct somewhere or pointed out very minor details. I hope that helped you look from the outside 😄

Copy link
Contributor

@mkorbel1 mkorbel1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is looking really great!

example/oven_fsm.dart Outdated Show resolved Hide resolved
example/oven_fsm.dart Outdated Show resolved Hide resolved
example/oven_fsm.dart Show resolved Hide resolved
Copy link
Contributor

@chykon chykon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe add oven_fsm.dart to test/example_test.dart?

example/oven_fsm.dart Show resolved Hide resolved
example/oven_fsm.dart Outdated Show resolved Hide resolved
example/oven_fsm.dart Outdated Show resolved Hide resolved
Copy link
Contributor

@chykon chykon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tiny notes:

example/oven_fsm.dart Outdated Show resolved Hide resolved
example/oven_fsm.dart Outdated Show resolved Hide resolved
example/oven_fsm.dart Outdated Show resolved Hide resolved
example/oven_fsm.dart Outdated Show resolved Hide resolved
.gitignore Outdated Show resolved Hide resolved
Copy link
Contributor

@mkorbel1 mkorbel1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great, awesome contribution, thank you!

@mkorbel1 mkorbel1 merged commit 36ffc75 into intel:main Feb 24, 2023
@quekyj quekyj deleted the 250-fsm-state-diagram-mermaid-generator branch August 8, 2023 05:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

FSM State diagram generator in mermaid
3 participants