Skip to content

Provides an easy and quick way to describe your stories with an YAML file

License

Notifications You must be signed in to change notification settings

sixertoy/tell-cli

Repository files navigation

Tell-cli

MIT License

Provides an easy and quick way to describe your stories with an YAML file Can generate Mocha files from stories.yml

Install

npm install -g tell-cli

must be installed globally

Usages

An yaml file named stories.yml as describe below must be placed in your spec | tests |... folder

# output stories in console, doesn't generate spec files
tell spec
# prompts for overwite specs files - default to false
tell spec --generate
tell spec -g
# doesn't prompts
tell spec --generate --yes
tell spec -g -Y

spec/stories.yml

src/filename.js:
  render:
    - throw if no argument
    - should return a string
    - should return helloworld
  a_function_name:
    other_cases
      - returns false if no arguments
      - returns arguments is empty
      - returns false is not a plainobject
      - returns options property 'name' is not defined
      - expect to returns array of arguments
    other_other_cases:
      - returns false if no arguments
      - returns arguments is empty
      - returns false is not a plainobject
      - returns options property <name> is not defined
      - expect to returns array of arguments
src/an_other_filename.js:
  - throw if no argument
  - should return a string
  - should return helloworld

History

  • v0.1.4 Fix multiple files

Issues

  • Not tested under UNIX
  • No unit tests...

Dependencies

About

Provides an easy and quick way to describe your stories with an YAML file

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published