Don't attempt to npm publish if package flagged as private in package.json #64

unkillbob · Jul 19, 2016

Fixes #65

We have a bunch of packages that are installed out of private git repos and attempting to use np fails at the second last step as npm publish exits with an error when the package.json specifies private: true.

This pull request makes the change to simply skip the publish step if the package is flagged as private. I wasn't sure whether you'd want this mentioned in the readme or not - let me know if I should update it.

np is really awesome and exactly what we needed, I hope we can get this small change in to adapt it for our use case!

SamVerschueren · Jul 19, 2016

np is all about publishing a module. Shouldn't this just be a prerequisite check and exit early? Just wondering.

Use the load-json-file package here

unkillbob · Jul 19, 2016

np is all about publishing a module. Shouldn't this just be a prerequisite check and exit early?

We still "publish" these modules (we install them from the tag produced by npm version) so need all the other aspects of np (clean, npm install, version bump, push tags, etc).

jamestalmage · Jul 19, 2016

I think this makes sense.

However, you should use read-pkg-up instead.

Also, it should very clearly state that the publish step was skipped, and why.

private package: publishing skipped

Is it possible to publish private packages on npm if they are namespaced and you have a paid account? If so we may need to add extra logic for that.

unkillbob · Jul 19, 2016

Is it possible to publish private packages on npm if they are namespaced and you have a paid account?

Reading the docs (https://docs.npmjs.com/files/package.json#private) it doesn't look like it. The purpose of private:true is to prevent accidental publishing. If you simply want to change where your package is published to you configure the publishConfig instead.

jamestalmage · Jul 19, 2016

Yeah, this makes sense then. If private:true, then npm publish will always fail. Relying on git tagging just makes sense then.

As stated - use read-pkg-up, and provide a good message when private mode is encountered. Otherwise 👍

unkillbob · Jul 19, 2016

provide a good message when private mode is encountered

Not really sure how to accomplish this with Listr - are you able to point me in the right direction?

I tried resolving the 'publish' task's promise to the message, I tried exec'ing an echo with the message and I tried a console.log - all happen so fast you don't even see it.

jamestalmage · Jul 19, 2016

See SamVerschueren/listr#15 and SamVerschueren/listr#16

unkillbob · Jul 19, 2016

@jamestalmage yes that's exactly what I need, thanks for raising those issues! In the meantime I've addressed all your other feedback - hopefully this can go ahead without the official skip warning?

I would use readPkgUp.sync() here. No real benefit of using async fs here as these tasks are done serially.

sindresorhus · Jul 20, 2016

hopefully this can go ahead without the official skip warning?

Sure, just open an issue with the remaining work so we don't forget.

sindresorhus · Jul 20, 2016

Looks great. Could you add a note to the readme about the behavior? This might be useful for other people to, but I don't think they would realize it's possible without some kind of indication.

unkillbob · Jul 20, 2016

Skipping tasks is hopefully not too far away (SamVerschueren/listr#17), happy to hold out for that - this isn't super urgent for us.

jamestalmage · Jul 22, 2016

Skipping tasks is hopefully not too far away (SamVerschueren/listr#17), happy to hold out for that

We can follow up once that lands.

Great work. Thanks!

sindresorhus · Jul 22, 2016

Excellent work on this @unkillbob :) Cheers.

unkillbob Don't attempt to npm publish if package flagged as private

c0f0863

unkillbob added some commits Jul 19, 2016

unkillbob Missing semicolon

5543193

unkillbob Change to using load-json-file

6427eb2

jamestalmage referenced this pull request in SamVerschueren/listr Jul 19, 2016
Closed
Skippable Tasks #15

unkillbob Use read-pkg-up to read package.json

fc195f2

unkillbob Fix lint error

4603b63

SamVerschueren referenced this pull request Jul 20, 2016
Closed
Skip the `npm publish` step #65

unkillbob Document private packages in readme

754e844

unkillbob Use readPkgUp.sync

e5638f5

jamestalmage merged commit 4a5a090 into sindresorhus:master Jul 22, 2016
1 check passed

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details

jamestalmage referenced this pull request Jul 22, 2016
Closed
Use skip API when it lands in `Listr` #69

@@ -116,7 +121,12 @@ module.exports = (input, opts) => {
      		},
      		{
      			title: 'Publishing package',
-    -			task: () => exec('npm', ['publish'].concat(opts.tag ? ['--tag', opts.tag] : []))
+    +			task: () => getPackageJson()

@@ -116,7 +114,14 @@ module.exports = (input, opts) => {
      		},
      		{
      			title: 'Publishing package',
-    -			task: () => exec('npm', ['publish'].concat(opts.tag ? ['--tag', opts.tag] : []))
+    +			task: () => readPkgUp()

sindresorhus/np

Don't attempt to npm publish if package flagged as private in package.json #64

Reviewers

Assignees

Labels

Projects

Milestone

4 participants

Skippable Tasks #15

Skip the `npm publish` step #65

1 check passed

Use skip API when it lands in `Listr` #69