TestArmada / magellan

Large Scale Automated Testing for Mocha, Nightwatch, Appium, Nodejs, etc
MIT License
287 stars 44 forks source link

Update plugin docs to existing api #278

Closed michaeljacobdavis closed 4 years ago

michaeljacobdavis commented 4 years ago

There were a few things in the plugin doc that don't seem current.

iterator requires tests to also implement a filename property that magellan uses to print found tests. This could also be moved to use toString but I figured a doc update was simpler for now. https://github.com/TestArmada/magellan/blob/189dd6001e8eb2696caf69e6d987b3104cbd8d33/src/cli.js#L335

filters receive an array of tests (from iterator) as the first parameter and the filter as the second parameter (see magellan-nightwatch-plugin) and must return a list of tests to run.

codecov-io commented 4 years ago

Codecov Report

Merging #278 into master will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #278   +/-   ##
=======================================
  Coverage   97.22%   97.22%           
=======================================
  Files          31       31           
  Lines         972      972           
=======================================
  Hits          945      945           
  Misses         27       27

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 189dd60...7626398. Read the comment docs.