qunitjs / qunit / 9449827430

59%

main: 90%

Build Type

push

github

Committed by Krinkle

Commit Message

Core: Remove internal use of `details` param from QUnit.done()

* There is now only one number claiming to measure the runtime of the
  test run, and that is the `runtime` property of the runEvent event,
  as calculated in src/reports/suite.js. Previously, a nearly-identical
  runtime was computed here in PQ for the QUnit.done() event.

* Fix reorderError1/reorderError2 to no longer use the `details` param,
  and use the test counts of the runEnd event instead, per the reasons
  and caveats laid out in https://qunitjs.com/api/callbacks/QUnit.done/.

* I'm changing this parameter from "deprecated" to "discouraged".
  It was never deprecated with warnings, and upon closer review of
  the ecosystem, it seems too impactful to remove for virtually no
  gain. Most uses of it do no report the assertion count, but use
  it either as event notification only, or to access safe numbers like
  "runtime" or "total". I guess this is largely because people have
  eventually found the caveats and avoided them or worked around them.

  I'm keeping the discouragement warning in docs as-is, so as to
  make sure new plugin/integration makers use the runEnd instead,
  which is easier and un-caveat-ed. It should also avoid introducing
  new usage of confusing assertion counts where developers expect
  test counts instead.

Examples:

* Testem relies on QUnit.done() to access "runtime" in its
  qunit_adapter. It is not trivial for them to migrate as they still
  support and ship with QUnit 1.x. This could change, but would require
  an update churn that I'd rather avoid. The usage is fine.

* grunt-contrib-qunit uses `QUnit.done()`, not for any specific
  function but rather to forward it to Grunt's event system. It
  unfortunately chooses a different signature for the forwarded
  event and thus manually accesses each property even if nobody
  subscribes to the event (or if subscribers avoided the deprecated
  parameters), thus causing a crash for all ways the Grunt plugin
... (continued)

Run Details

4 of 4 new or added lines in 1 file covered. (100.0%)

414 existing lines in 15 files now uncovered.

1201 of 2047 relevant lines covered (58.67%)

90.52 hits per line