search

winterbe / jest-teamcity-reporter

Teamcity Reporter for Jest Unittest Results
https://www.npmjs.com/package/jest-teamcity-reporter
Other
50 stars 23 forks source link

Suggestion: rename to jest-teamcity-results-processor #5

Closed ToshB closed 7 years ago

ToshB commented 7 years ago

I think the name is a bit misleading, as jest does not support custom reporters at this time. But we're getting closer: https://github.com/facebook/jest/pull/2115

And also, a reporter would report progress to teamcity as the tests are running, while this reports nothing until the test run is complete, which is not optimal if there are a lot of tests.

winterbe commented 7 years ago

Hm, I don't see where the name reporter is misleading here. The term is chosen from the context of Teamcity (not Jest) where the used technique is called Reporting Messages, see TC docs.

I appreciate your feedback, however I don't want to change the name of this project. But I'm happy to switch the implementation from resultsProcessor to something better suitable when available (or accept PRs).

ccarpita commented 6 years ago

Now that reporters is a configuration option, the name is misleading to anyone familiar with the Jest 20+ API (which is now the previous major version). One would expect to be able to drop this module name into the reporters configuration list, when in fact it is a test-results-processor.

Following the principle of least surprise, the best thing IMHO would be to split this into two modules, supporting both APIs:

And bump the major version. That way you can retain your npm name, while clearly communicating a breaking change.

I have a backlog ticket for this, but don't want to duplicate work, if you're planning on making this kind of change. If not, I'll fork internally :)