search

hegemonic / catharsis

A JavaScript parser for Google Closure Compiler and JSDoc type expressions.
MIT License
54 stars 14 forks source link

0.8.10 has breaking changes for node =< 8 and breaks jsdoc install, new version number requested #55

Closed derekbar90 closed 5 years ago

derekbar90 commented 5 years ago

The update 2 days ago causes build issues with servers running node lower than 8 due to dependency issues of Catharsis.

Due to this module being a dependency of jsdoc and jsdoc having a ref of ~0.8.9, the install causes breaking builds when checking the node env.

By changing the version number it will ensure backwards compat with modules linking via semver versioning schemes

I recommend viewing this for reference:

https://docs.npmjs.com/misc/semver#tilde-ranges-123-12-1

hegemonic commented 5 years ago

From the semver 2.0.0 spec:

Major version zero (0.y.z) is for initial development. Anything may change at any time. The public API should not be considered stable.

JSDoc was around before semver was a thing, and it has not historically used semver for releases. That's why the README encourages you to pin to a minor version (e.g., "jsdoc": "~3.5.5"), not a major version (e.g., "jsdoc": "^3.5.5").