[feat]: prepublish script npm hook

[alan-agius4]

At the moment, in order to run a prepublish step when publishing you need to create a script under each modules like scripts/prepublish.js.

This is quite limiting considering the fact one, you are liberality forcing using to have that folder structure and also in most cases one would want to use the same script and not copy and paste it in all modules.

Expected Behaviour

• Check if a "prepublish" npm script is present in the root "package.json" if so execute it
• Check if a "prepublish" npm script is present in the package to be published "package.json" if so execute it.
• Execute the scripts/prepublish.js file script as per current workflow.

Current Behaviour

There is no prepublish npm hook

[evocateur]

No, the prepublish (if it exists) in every package to be published is always run (by npm/yarn), because we are just calling npm publish/yarn publish in those directories (which is done in topological dependency order, so dependents always have their local sibling devDependencies built).

Of course, npm5 has deprecated prepublish and it should probably be replaced with prepare or prepublishOnly. I personally don't see much use in the scripts/<lifecycle>.js pattern, but I don't have any plans to remove it.

The problem with a prepublish in the root is that it (currently) will run any time anyone runs npm install with no arguments in the root, complete with scary looking log and possibly executing something you don't really want to have happen then.

[alan-agius4]

To avoid such problems, I avoid calling any custom tasks ‘publish’ and go for ‘release’ in order to avoid collisions and interferance with ‘yarn/npm publish’ pre and post hooks. And I can safely use ‘prerelease’ and ‘prepublish’ hooks for two seperate things during the publish cycle.

…

On Sun, 21 Jan 2018 at 00:24, Daniel Stockman ***@***.***> wrote: No, the prepublish (if it exists) in every package to be published is always run (by npm/yarn), because we are just calling npm publish/yarn publish in those directories (which is done in topological dependency order, so dependents always have their local sibling devDependencies built). Of course, npm5 has deprecated prepublish and it should probably be replaced with prepare or prepublishOnly. I personally don't see much use in the scripts/<lifecycle>.js pattern, but I don't have any plans to remove it. The problem with a prepublish in the root is that it (currently) will run any time anyone runs npm install with no arguments in the root, complete with scary looking log and possibly executing something you don't really want to have happen then. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#1169 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AQv-Whrg0ibYiLl2emENY2MId7YwF1hCks5tMnWQgaJpZM4RFbts> .

[gluons]

Excuse me!

Where is the documentation about scripts/<lifecycle>.js?
I can't find it.

[kyrisu]

@evocateur small correction to what you have said:

the prepublish (if it exists) in every package to be published is always run (by npm/yarn), because we are just calling npm publish/yarn publish in those directories

It seems that you are calling publish with --ignore-scripts so it won't run prepublish.

Any reason why that's there and how to overwrite it?

[evocateur]

It's already run by a previously executed npm pack

[kyrisu]

@evocateur you are right. I was thinking about prepublishOnly - it only runs on npm publish (duh!). So as you mentioned in the previous message it should be probably replaced with prepare script.

[evocateur]

Ah, yes, that particular lifecycle does not appear to be run when publishing a tarball (as far as I recall when I traced through the npm source). It also doesn't run during npm pack (although "prepack" is run, and would be an acceptable replacement).

[wereHamster]

npm pack doesn't run prepublishOnly.

I have a monorepo with multiple packages that are written in typescript, and in prepublishOnly I need to run the compiler (tsc). Currently my canary releases on npm only contain a package.json because the files are not compiled. Do I need to manually run the prepublish scripts before calling into lerna?

[evocateur]

You should be running compilers to generate build output once, from the root. Or move to the prepack lifecycle, if typescript can't handle building multiple packages at once.

[wereHamster]

Where can I read more about prepack lifecycle?

[gluons]

@wereHamster https://docs.npmjs.com/misc/scripts

[lock]

This thread has been automatically locked because there has not been any recent activity after it was closed. Please open a new issue for related bugs.