Installing package from github URL doesn't trigger prepublish script

Question

Installing package from github URL doesn't trigger prepublish script

OmgImAlexis opened this issue 8 years ago · 5 comments

Do you want to request a feature or report a bug?
Bug/feature

What is the current behavior?
Installing package from Github URL doesn't run the prepublish script

What is the expected behavior?
Yarn should run the prepublish script when installing from a Github URL just like it should when installing a local package.

Ref: npm/npm#3055
More specifically: npm/npm#3055 (comment)

Answer 1 · 2017-04-10T06:19:39.000Z

Is there any updates?

Answer 2 · 2017-04-30T16:27:28.000Z

Technically speaking this is feature, not a bug, because this is not implemented in npm either.

I would expect following: when dependency installed from git and there is prepublish hook, install dev dependencies for this repo and run hook. If there is no prepublish hook, no need to install dev dependencies, just git clone.

Answer 3 · 2017-05-27T10:20:04.000Z

There was a suggestion on npm from @gagern:

How about this: clone the repo to a temporary directory, run npm install && npm pack there (which means pulling all dev dependencies), then untar the package tarball we just generated to the node_modules directory in question, and fetch (or perhaps move) any non-dev dependencies it has.

The repository is treated as a source repository, which means you'll have to assume that all dev dependencies and all prepublish scripts might be needed. For every point and purpose, building from that temporary directory is just like what you'd do prior to publishing, which should work if the package is sufficiently portable.
The permanently installed part is like a published package, though, with everything those have, but without anything .npmignore got rid of, and without unneccessary dev dependencies. For every point and purpose, the installed package behaves just like what you'd get from the registry if it were installed there.

It was not implemented because the npm code was too complex at that time.

I think this behavior can be implemented in Yarn, either as the default behavior, or with an option somewhere.
Regarding all the discussions about this issue on both npm and yarn, I think it should be the default behavior.

I'll have a look to prepare a PR for that.

Answer 4 · 2017-05-29T22:43:09.000Z

Update:

@zkat commented 6 hours ago
This is now available in npm@5.0.0. instead of prepublish, you'll need to use prepare, but this is otherwise as you'd expect. 🎉

Answer 5 · 2017-05-30T00:03:18.000Z

Please let me know if y'all have any questions about how this works in npm now, and please note that it's fairly fresh and it's bound to have some kind of crap in there that I didn't realize would be a problem (and thus subject to change -- so if you find something, please let us know!)

The code in question npm-side is: https://github.com/npm/npm/blob/latest/lib/pack.js#L151-L221, which isn't exactly the simplest thing in the world. It essentially runs npm install in the project directory before packing it, preventing prepublish from executing, but only if a prepare script exists.

There's another backflip that happens where this function is actually passed to pacote, which invokes it when installing git dependencies. This was mainly so pacote didn't have to be aware of lifecycle scripts, and I assume will be simplified in the future (or have more of this be integrated into pacote proper).