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

Fix scoped packages publish behavior #630

Merged
merged 1 commit into from Mar 26, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
23 changes: 16 additions & 7 deletions docs/npm.md
Expand Up @@ -41,21 +41,30 @@ For a pre-release, the default tag is "next". The tag will be derived from the p

## Public scoped packages

A [scoped package](https://docs.npmjs.com/misc/plugin) (e.g. `@user/package`) is either public or private. To
[publish scoped packages](https://docs.npmjs.com/misc/plugin#publishing-scoped-packages), make sure this is in
`package.json`:
A [scoped package](https://docs.npmjs.com/about-scopes) (e.g. `@user/package`) is either public or private. By default,
`npm publish` will publish a scoped package as private. Note that scoped packages requires a paid account.

In order to publish a public scoped package, you can add the following to your release-it config:

```json
{
"npm": {
"access": "public" // or "restricted"
}
}
```

However, this should most likely be specified in your `package.json`:

```json
{
"publishConfig": {
"access": "public"
"access": "public" // or "restricted"
}
}
```

By default, `npm publish` will
[publish a scoped package as private](https://docs.npmjs.com/creating-and-publishing-private-packages) (requires paid
account).
By specifying this in your `package.json`, publishing via `npm` will respect this setting as well.

## Two-factor authentication

Expand Down
4 changes: 2 additions & 2 deletions lib/plugin/npm/npm.js
Expand Up @@ -175,9 +175,9 @@ class npm extends Plugin {

async publish({ otp = this.options.otp, otpCallback } = {}) {
const { publishPath = '.', access } = this.options;
const { name, private: isPrivate, tag = DEFAULT_TAG, isNewPackage } = this.getContext();
const { name, private: isPrivate, tag = DEFAULT_TAG } = this.getContext();
const isScopedPkg = name.startsWith('@');
const accessArg = isScopedPkg && (access || (isNewPackage && !isPrivate)) ? `--access ${access || 'public'}` : '';
const accessArg = isScopedPkg && access ? `--access ${access}` : '';
const otpArg = otp ? `--otp ${otp}` : '';
const dryRunArg = this.global.isDryRun ? '--dry-run' : '';
if (isPrivate) {
Expand Down
32 changes: 31 additions & 1 deletion test/npm.js
Expand Up @@ -166,7 +166,7 @@ test('should throw if user is not authenticated', async t => {
exec.restore();
});

test('should publish scoped package', async t => {
test('should publish public scoped package as public', async t => {
const options = { npm: { access: 'public', tag: 'beta' } };
const npmClient = factory(npm, { options });
npmClient.setContext({ name: '@scoped/pkg' });
Expand All @@ -176,6 +176,36 @@ test('should publish scoped package', async t => {
exec.restore();
});

test('should publish a private scoped package as private', async t => {
const options = { npm: { access: 'restricted', tag: 'beta' } };
const npmClient = factory(npm, { options });
npmClient.setContext({ name: '@scoped/pkg' });
const exec = sinon.spy(npmClient.shell, 'exec');
await npmClient.publish();
t.is(exec.lastCall.args[0].trim(), 'npm publish . --tag beta --access restricted');
exec.restore();
});

test('should publish a new private scoped package as NPM would', async t => {
const options = { npm: { tag: 'beta' } };
const npmClient = factory(npm, { options });
npmClient.setContext({ name: '@scoped/pkg', isNewPackage: true });
const exec = sinon.spy(npmClient.shell, 'exec');
await npmClient.publish();
t.is(exec.lastCall.args[0].trim(), 'npm publish . --tag beta');
exec.restore();
});

test('should publish a new public scoped package as public', async t => {
const options = { npm: { access: 'public', tag: 'beta' } };
const npmClient = factory(npm, { options });
npmClient.setContext({ name: '@scoped/pkg', isNewPackage: true });
const exec = sinon.spy(npmClient.shell, 'exec');
await npmClient.publish();
t.is(exec.lastCall.args[0].trim(), 'npm publish . --tag beta --access public');
exec.restore();
});

test('should not publish private package', async t => {
const npmClient = factory(npm);
npmClient.setContext({ name: 'pkg', private: true });
Expand Down
4 changes: 2 additions & 2 deletions test/tasks.js
Expand Up @@ -331,7 +331,7 @@ test.serial('should handle private package correctly, bump lockfile', async t =>
exec.restore();
});

test.serial('should initially publish non-private scoped npm package publicly', async t => {
test.serial('should initially publish non-private scoped npm package privately', async t => {
const { target } = t.context;
const pkgName = path.basename(target);
gitAdd(`{"name":"@scope/${pkgName}","version":"1.0.0"}`, 'package.json', 'Add package.json');
Expand All @@ -344,7 +344,7 @@ test.serial('should initially publish non-private scoped npm package publicly',
await runTasks({}, container);

const npmArgs = getNpmArgs(container.shell.exec.args);
t.is(npmArgs[4], 'npm publish . --tag latest --access public');
t.is(npmArgs[4], 'npm publish . --tag latest');
exec.restore();
});

Expand Down