Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Please publish a new version of cson-safe with a message directing users to switch #65

Open
adamvoss opened this issue Jul 10, 2017 · 6 comments

Comments

@adamvoss
Copy link

You cannot tell from the cson-safe package that it was superseded by cson-parser. It would be very helpful if you updated the README on npm to inform users to migrate.

I only learned about the change by following the repository link from npm which happens to be redirected to here via GitHub, I only realized the redirect a happened after I typed up a complete bug report.

@jkrems
Copy link
Contributor

jkrems commented Jul 10, 2017

We actually did but had to revert (see #48). I guess we could try to npm deprecate at this point but so far there didn't seem to be enough need for that to risk another break in downstream packages.

@adamvoss
Copy link
Author

Maybe it is a mobile limitation, but I cannot see any commit details on that issue. The process I meant to propose by this issue was to checkout the commit from 1.0.5, edit the readme inform about the change, then release that new commit as 1.0.6.

I'm not an npm expert, but code-wise nothing would have changed so I'm not sure how it would break anything.

@jkrems
Copy link
Contributor

jkrems commented Jul 12, 2017

Unfortunately 1.0.6 is already taken - https://github.com/groupon/cson-parser/releases/tag/v1.0.6.

The issue with pre-release versions was atom specific, it wasn't npm itself afaik.

@adamvoss
Copy link
Author

adamvoss commented Jul 12, 2017 via email

@jkrems
Copy link
Contributor

jkrems commented Jul 12, 2017

It doesn't - but git does. And I'm generally not comfortable publishing something to npm that doesn't map cleanly to a git tag. :)

@adamvoss
Copy link
Author

Gotcha. The best I've got is v1.0.6-cson-safe, cson-safe-v1.0.6, or cson-safe-end-of-life (doesn't have the version number but describes what it is).

I've never used npm deprecate but reading the doc page it sounds like a decent solution. It can be undone, but not having used it I cannot say with certainty that it doesn't do something problematic despite such behavior being unexpected.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants