search

mathjax / MathJax-node

MathJax for Node
Apache License 2.0
615 stars 97 forks source link

Two different packages on npm #214

Closed jhiesey closed 8 years ago

jhiesey commented 8 years ago

I first found https://www.npmjs.com/package/MathJax-node on npm, which appears to be an old version. The current version looks to be https://www.npmjs.com/package/mathjax-node, which differs only by case.

I can't imagine I'm the only one who's downloaded the wrong version. Could you at least publish an update the README on the old one to point people to the new one?

pkra commented 8 years ago

If you install MathJax-node NPM should trigger a deprecation warning that reads:

"npm WARN deprecated MathJax-node@0.3.0: WARNING: This project has been renamed to mathjax-node. Install using mathjax-node instead."

We thought that would be sufficient.

Personally, I don't mind one way or another if we add more information somewhere; @dpvc, @zorkow thoughts?

dpvc commented 8 years ago

I suppose changing the README so that the page at https://www.npmjs.com/package/MathJax-node indicates the change would be a reasonable thing to do. Can that be done without screwing up the new package?

pkra commented 8 years ago

I suppose changing the README so that the page at https://www.npmjs.com/package/MathJax-node indicates the change would be a reasonable thing to do.

No objection here.

Can that be done without screwing up the new package?

Yes. We only publish tags (and as long as we don't change the version number in package.json, publishing to npm would fail without damaging the current version on npm).

pkra commented 8 years ago

On second read, I misunderstood you @dpvc. To change the readme on npm we would have to make a new NPM release with the old package name and a new version number in the package.json. That would have to be done manually, I think.

pkra commented 8 years ago

This would be my preferred solution: https://github.com/npm/newww/issues/413

dpvc commented 8 years ago

That would have to be done manually, I think.

If we made a branch off the current 0.3.0 tag and changed the README.md and package.json in that branch and then tagged it 0.3.1, would we be able to publish that on npm for MathJax-node without screwing up mathjax-node? If so, I'm OK with doing that.

Waiting for npm to make their changes is also fine with me.

pkra commented 8 years ago

If we made a branch off the current 0.3.0 tag and changed the README.md and package.json in that branch and then tagged it 0.3.1, would we be able to publish that on npm for MathJax-node without screwing up mathjax-node? If so, I'm OK with doing that.

I don't know but I'm guessing it shouldn't cause any issues. Will do some research.

pkra commented 8 years ago

Fixed.