search

unional / ava-fixture

Fixture test for https://github.com/avajs/ava
MIT License
5 stars 1 forks source link

misleading documentation #8

Closed flying-sheep closed 7 years ago

flying-sheep commented 7 years ago

under Usage it says

// path is the path to the fixture-name folder.

which isn’t true. path is { casePath: <fixture-name folder> }

unional commented 7 years ago

Thanks. I need to update the Readme. I just added the baseline functionality.

The option is optional.

- fixture
  - cases
  - baselines
  - results
fixture(ava, 'fixture/cases') // path = path to the root folder of all fixture cases

fixture(test, 'fixture', { casesPath: 'cases', baselinesPath: 'baselines', resultsPath: 'results' }) // path = path to the relative root of the fixtures.
unional commented 7 years ago

Now as I think of it, the API is not good. I'll update the API and make another release.

unional commented 7 years ago

0.5 released and updated README. Please see if it is more helpful.

unional commented 7 years ago

Released 0.7. It should be ok now. Feel free to continue the discussion.

flying-sheep commented 7 years ago

cool!