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

add deprecation note in README.md - was: NPM out of date? #15

Open
mrmurphy opened this issue Mar 1, 2016 · 6 comments
Open

add deprecation note in README.md - was: NPM out of date? #15

mrmurphy opened this issue Mar 1, 2016 · 6 comments

Comments

@mrmurphy
Copy link

mrmurphy commented Mar 1, 2016

Hi there, thanks for this great library!

I just ran npm install -g wr, which reported having installed v1.3.1, but I got the following error while trying to perform a watch:

net.js:617
    throw new TypeError('invalid data');
    ^

TypeError: invalid data
    at WriteStream.Socket.write (net.js:617:11)
    at ExecutorSpawn.stderr (/Users/murphy/.nvm/versions/node/v5.3.0/lib/node_modules/wr/lib/Executor.js:123:27)
    at Socket.<anonymous> (/Users/murphy/.nvm/versions/node/v5.3.0/lib/node_modules/wr/lib/Executor.js:111:20)
    at emitOne (events.js:77:13)
    at Socket.emit (events.js:169:7)
    at readableAddChunk (_stream_readable.js:146:16)
    at Socket.Readable.push (_stream_readable.js:110:10)
    at Pipe.onread (net.js:523:20)

I took a look at wr/lib/Executor.js:123 and noticed that the code didn't match the code that's up on Github in the master branch.

I uninstalled from NPM, and then re-installed straight from GitHub:

npm install -g pmuellr/wr

and all worked as expected.

Could it be that NPM's copy has somehow gotten out of date? Would you mind pushing up a patch version or something, to make sure the right source is in there?

Just in case it matters, I'm running on Node v5.3.0

@pmuellr
Copy link
Owner

pmuellr commented Mar 1, 2016

Thanks for the bug report! Sorry for the probs.

I haven't used wr in a long time; I believe I've had some issues moving across node releases, and getting the watches to work correctly. Generally I've moved onto to other "watching" stories either as functions in my build environment, or using nodemon. I'd suggest using nodemon, perhaps writing a bash/bat file to invoke it with args like wr.

Also willing to take a PR.

I suppose I should deprecate the package, if no one wants to pick it up ...

@mrmurphy
Copy link
Author

mrmurphy commented Mar 1, 2016

No problem!

In this case, I don't think you actually need a PR, just a re-publishing to npm. If you want to give me commit permissions, I can give it a try myself.

Or if you'd rather mark it as deprecated I'll give nodemon a try :) 👍

Thanks!

@pmuellr
Copy link
Owner

pmuellr commented Mar 2, 2016

if you want to take over wr, happy to make you an npm owner, commit rights on the GH repo (or you can clone), etc.

But I really suggest looking into an alternative, like nodemon. I enjoy the whole "no maintenance for me to do" aspect :-)

@mrmurphy
Copy link
Author

mrmurphy commented Mar 2, 2016

@pmuellr Cool! I just tried nodemon with my Elm project, and it's working quite nicely.

@mrmurphy mrmurphy closed this as completed Mar 2, 2016
@mrmurphy
Copy link
Author

mrmurphy commented Mar 2, 2016

Might be worth adding your suggestion, and a note of deprecation to the readme?

Thanks again!

@pmuellr
Copy link
Owner

pmuellr commented Mar 2, 2016

Ya, I deprecated the top-level package version, so you now see this when you npm install

$ npm install wr
npm WARN package.json nsolid-mock@0.0.1 No repository field.
npm WARN deprecated wr@1.3.1: no longer being maintained; check out nodemon instead
...

But nothing shows at https://www.npmjs.com/package/wr - previous experience deprecating packages is that you need to be very noisy (eg, in the README) about the deprecation ...

@pmuellr pmuellr changed the title NPM out of date? add deprecation note in README.md - was: NPM out of date? Mar 2, 2016
@pmuellr pmuellr reopened this Mar 2, 2016
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