coapjs / node-coap

CoAP - Node.js style
MIT License
528 stars 154 forks source link

docs: describe compatible node versions in README #341

Closed JKRhb closed 2 years ago

JKRhb commented 2 years ago

As we only test for node 12 and above at the moment, it probably makes sense to only test for these versions. As soon as node 12 is EOL, we should bump the version to 14.

coveralls commented 2 years ago

Pull Request Test Coverage Report for Build 2216207240


Totals Coverage Status
Change from base Build 2216151827: 0.007%
Covered Lines: 2821
Relevant Lines: 3033

💛 - Coveralls
Apollon77 commented 2 years ago

Hm ... honestly ... I personally have no issue in stating in readme for which versions we test and that older versions might work (unless we explicitely know of a breakage), and so set the minimum version to "reality" ...

I personally hate libraries that block out users of older versions because the reality is that many users do "never change a running version". So increase version when needed - fine, but else allow others to use also older versions (at their own risk). As soon as we learn or break it with a dep then we should increase it.

But this is more a "paradigm discussion" :-)

JKRhb commented 2 years ago

That is actually a very good point :) I guess one benefit of the typescript compilation is that we can easily target older versions. Should we add node 10 back to the CI then as well, and only add the engines entry if things should break for that version?

Apollon77 commented 2 years ago

I think nodejs 10 will break in testing because testing libs kicked it ... so as said ... I would just state in Readme which versions are tested but that also nodejs 10 should work from current knowledge

JKRhb commented 2 years ago

I updated the PR accordingly :) Feel free to make suggestions for a better wording :)

Apollon77 commented 2 years ago

Perfect