xstate-hive
v3.0.1
Published
An opinionated application state generator with XState for React application
Downloads
19
Readme
XState Hive (Code generator)
About
This library is still in preliminiary phase.
Usage
$ npm install -g xstate-hive
$ xstate-hive COMMAND
running command...
$ xstate-hive (--version)
xstate-hive/3.0.1 darwin-arm64 node-v16.15.1
$ xstate-hive --help [COMMAND]
USAGE
$ xstate-hive COMMAND
...
Commands
xstate-hive block [MACHINENAME] [TARGETSTATEPATH]
xstate-hive help [COMMANDS]
xstate-hive info
xstate-hive init
xstate-hive machine [MACHINENAME] [MACHINEPATH]
xstate-hive block [MACHINENAME] [TARGETSTATEPATH]
Inject a block of funcionality into the machine
USAGE
$ xstate-hive block [MACHINENAME] [TARGETSTATEPATH]
ARGUMENTS
MACHINENAME A machine name
TARGETSTATEPATH The path to the machine state to inject into (e.g. "core", "core.operational")
DESCRIPTION
Inject a block of funcionality into the machine
EXAMPLES
$ xstate-hive block inject [machine-name]
See code: dist/commands/block/index.ts
xstate-hive help [COMMANDS]
Display help for xstate-hive.
USAGE
$ xstate-hive help [COMMANDS] [-n]
ARGUMENTS
COMMANDS Command to show help for.
FLAGS
-n, --nested-commands Include all nested commands in the output.
DESCRIPTION
Display help for xstate-hive.
See code: @oclif/plugin-help
xstate-hive info
USAGE
$ xstate-hive info
EXAMPLES
$ xstate-hive info
See code: dist/commands/info/index.ts
xstate-hive init
Create a configuration file for xstate-hive on the root of your project
USAGE
$ xstate-hive init
DESCRIPTION
Create a configuration file for xstate-hive on the root of your project
EXAMPLES
$ xstate-hive init
See code: dist/commands/init/index.ts
xstate-hive machine [MACHINENAME] [MACHINEPATH]
Create a new machine to manage a new feature
USAGE
$ xstate-hive machine [MACHINENAME] [MACHINEPATH]
ARGUMENTS
MACHINENAME A machine name
MACHINEPATH Destination path
DESCRIPTION
Create a new machine to manage a new feature
EXAMPLES
$ xstate-hive machine quick-polls ./src/machines
$ xstate-hive machine quick-polls
$ xstate-hive machine
See code: dist/commands/machine/index.ts