search

SitePen / remap-istanbul

A tool for remapping Istanbul coverage via Source Maps
Other
240 stars 79 forks source link

Shouldn't this library become deprecated? #177

Open nadavye opened 5 years ago

nadavye commented 5 years ago

Hi,

Since this library is using a deprecated version of Istanbul, I wonder if there's a point in maintaining this library as it just confuses end users?

Deprecated version of Istanbul: https://github.com/gotwarlost/istanbul Latest version of Istanbul: https://github.com/istanbuljs

Thoughts?

Nadav

dylans commented 5 years ago

Eventually yes. But many projects are still stuck in pre 1.0 Istanbul because it was a fairly significant change with the rewrite for new Istanbul.

nadavye commented 5 years ago

I understand that, but I think that if this package (and others) will have a clear indication that there's a new Istanbul version and point users on how to set it up, users will migrate.

Note that most of the users are simply unaware of the new version as they are not in the Code Coverage field. They just find the first article in Google and copy-paste the example.

I think that this is our responsibility to push this forward as the JS world already lacks standardization which make it very hard to handle, maintain and write tools for.

dylans commented 5 years ago

Ok I think something at the top of the readme that points people to the newer Istanbul and explains that this functionality is already provided with 1.0+ (pretty much the same code here was added to Istanbul though it’s diverged since then) and that this package is for pre-1.0 Istanbul. If you want to create a PR that would be great as I’m on holiday, otherwise I’ll get to it when I return.

nadavye commented 5 years ago

Hן @dylans, No problem. What do you think about the following message.

"Note: This packages uses a deprecated version of Istanbul. Since IstanbulJS (new & maintained version) already contains this functionality, I strongly encourage you to work with it instead of the old version."

Feel free to modify or update to something more accurate and I'll create a PR :-)

dylans commented 5 years ago

Maybe something a bit more complete like:

Note: This package adds remapping functionality for the deprecated 0.x version of Istanbul. The newer and actively maintained IstanbulJS includes remapping functionality directly, so this package is not needed for anyone working with IstanbulJS. We strongly encourage developers to leverage IstanbulJS, and only use this rempa-istanbul package when needing to support legacy versions of Istanbul.

nadavye commented 5 years ago

See the following PR: https://github.com/SitePen/remap-istanbul/pull/178