\n\t\t
\n\t\t\t\n\t\t\t\tMy open source work is supported by the community\n\t\t\t\n\t\t
\n\t\tSpecial thanks to:\n\t\t\n\t\t
\n\t\t\n\t\t\t
![](\"https://sindresorhus.com/assets/thanks/forward-email-logo.png\"){kind=logo}
\n\t\t\n\t\n\n\t\t
\n\t\t\t\n\t\t\t\tMy open source work is supported by the community\n\t\t\t\n\t\t
\n\t\tSpecial thanks to:\n\t\t\n\t\t\n\t\n![](\"media/screenshot.gif\")
\n\n## Why\n\n- [Interactive UI](#interactive-ui)\n- Ensures you are publishing from your release branch (`main` and `master` by default)\n- Ensures the working directory is clean and that there are no unpulled changes\n- Reinstalls dependencies to ensure your project works with the latest dependency tree\n- Ensures your Node.js and npm versions are supported by the project and its dependencies\n- Runs the tests\n- Bumps the version in package.json and npm-shrinkwrap.json (if present) and creates a git tag\n- Prevents [accidental publishing](https://github.com/npm/npm/issues/13248) of pre-release versions under the `latest` [dist-tag](https://docs.npmjs.com/cli/dist-tag)\n- Publishes the new version to npm, optionally under a dist-tag\n- Rolls back the project to its previous state in case publishing fails\n- Pushes commits and tags (newly & previously created) to GitHub/GitLab\n- Supports [two-factor authentication](https://docs.npmjs.com/getting-started/using-two-factor-authentication)\n- Enables two-factor authentication on new repositories\n ![](\"media/screenshot-ui.png\")
\n\n## Config\n\n`np` can be configured both globally and locally. When using the global `np` binary, you can configure any of the CLI flags in either a `.np-config.js` (as CJS), `.np-config.cjs`, `.np-config.mjs`, or `.np-config.json` file in the home directory. When using the local `np` binary, for example, in a `npm run` script, you can configure `np` by setting the flags in either a top-level `np` field in `package.json` or in one of the aforementioned file types in the project directory. If it exists, the local installation will always take precedence. This ensures any local config matches the version of `np` it was designed for.\n\nCurrently, these are the flags you can configure:\n\n- `anyBranch` - Allow publishing from any branch (`false` by default).\n- `branch` - Name of the release branch (`master` by default).\n- `cleanup` - Cleanup `node_modules` (`true` by default).\n- `tests` - Run `npm test` (`true` by default).\n- `yolo` - Skip cleanup and testing (`false` by default).\n- `publish` - Publish (`true` by default).\n- `preview` - Show tasks without actually executing them (`false` by default).\n- `tag` - Publish under a given dist-tag (`latest` by default).\n- `yarn` - Use yarn if possible (`true` by default).\n- `contents` - Subdirectory to publish (`.` by default).\n- `releaseDraft` - Open a GitHub release draft after releasing (`true` by default).\n- `testScript` - Name of npm run script to run tests before publishing (`test` by default).\n- `2fa` - Enable 2FA on new packages (`true` by default) (setting this to `false` is not recommended).\n- `message` - The commit message used for the version bump. Any `%s` in the string will be replaced with the new version. By default, npm uses `%s` and Yarn uses `v%s`.\n\nFor example, this configures `np` to never use Yarn and to use `dist` as the subdirectory to publish:\n\n`package.json`\n```json\n{\n\t\"name\": \"superb-package\",\n\t\"np\": {\n\t\t\"yarn\": false,\n\t\t\"contents\": \"dist\"\n\t}\n}\n```\n\n`.np-config.json`\n```json\n{\n\t\"yarn\": false,\n\t\"contents\": \"dist\"\n}\n```\n\n`.np-config.js` or `.np-config.cjs`\n```js\nmodule.exports = {\n\tyarn: false,\n\tcontents: 'dist'\n};\n```\n\n`.np-config.mjs`\n```js\nexport default {\n\tyarn: false,\n\tcontents: 'dist'\n};\n```\n\n_**Note:** The global config only applies when using the global `np` binary, and is never inherited when using a local binary._\n\n## Tips\n\n### npm hooks\n\nYou can use any of the test/version/publish related [npm lifecycle hooks](https://docs.npmjs.com/misc/scripts) in your package.json to add extra behavior.\n\nFor example, here we build the documentation before tagging the release:\n\n```json\n{\n\t\"name\": \"my-awesome-package\",\n\t\"scripts\": {\n\t\t\"version\": \"./build-docs && git add docs\"\n\t}\n}\n```\n\n### Release script\n\nYou can also add `np` to a custom script in `package.json`. This can be useful if you want all maintainers of a package to release the same way (Not forgetting to push Git tags, for example). However, you can't use `publish` as name of your script because it's an [npm defined lifecycle hook](https://docs.npmjs.com/misc/scripts).\n\n```json\n{\n\t\"name\": \"my-awesome-package\",\n\t\"scripts\": {\n\t\t\"release\": \"np\"\n\t},\n\t\"devDependencies\": {\n\t\t\"np\": \"*\"\n\t}\n}\n```\n\n### User-defined tests\n\nIf you want to run a user-defined test script before publishing instead of the normal `npm test` or `yarn test`, you can use `--test-script` flag or the `testScript` config. This can be useful when your normal test script is running with a `--watch` flag or in case you want to run some specific tests (maybe on the packaged files) before publishing.\n\nFor example, `np --test-script=publish-test` would run the `publish-test` script instead of the default `test`.\n\n```json\n{\n\t\"name\": \"my-awesome-package\",\n\t\"scripts\": {\n\t\t\"test\": \"ava --watch\",\n\t\t\"publish-test\": \"ava\"\n\t},\n\t\"devDependencies\": {\n\t\t\"np\": \"*\"\n\t}\n}\n```\n\n### Signed Git tag\n\nSet the [`sign-git-tag`](https://docs.npmjs.com/misc/config#sign-git-tag) npm config to have the Git tag signed:\n\n```\n$ npm config set sign-git-tag true\n```\n\nOr set the [`version-sign-git-tag`](https://yarnpkg.com/lang/en/docs/cli/version/#toc-git-tags) Yarn config:\n\n```\n$ yarn config set version-sign-git-tag true\n```\n\n### Private packages\n\n![](\"media/private-packages.png\")
\n\nYou can use `np` for packages that aren't publicly published to npm (perhaps installed from a private git repo).\n\nSet `\"private\": true` in your `package.json` and the publishing step will be skipped. All other steps\nincluding versioning and pushing tags will still be completed.\n\n### Public scoped packages\n\nTo publish [scoped packages](https://docs.npmjs.com/misc/scope#publishing-public-scoped-packages-to-the-public-npm-registry) to the public registry, you need to set the access level to `public`. You can do that by adding the following to your `package.json`:\n\n```json\n\"publishConfig\": {\n\t\"access\": \"public\"\n}\n```\n\nIf publishing a scoped package for the first time, `np` will prompt you to ask if you want to publish it publicly.\n\n### Private Org-scoped packages\n\nTo publish a [private Org-scoped package](https://docs.npmjs.com/creating-and-publishing-an-org-scoped-package#publishing-a-private-org-scoped-package), you need to set the access level to `restricted`. You can do that by adding the following to your `package.json`:\n\n```json\n\"publishConfig\": {\n\t\"access\": \"restricted\"\n}\n```\n\n### Publish to a custom registry\n\nSet the [`registry` option](https://docs.npmjs.com/misc/config#registry) in package.json to the URL of your registry:\n\n```json\n\"publishConfig\": {\n\t\"registry\": \"https://my-internal-registry.local\"\n}\n```\n\n### Publish with a CI\n\nIf you use a Continuous Integration server to publish your tagged commits, use the `--no-publish` flag to skip the publishing step of `np`.\n\n### Publish to gh-pages\n\nTo publish to `gh-pages` (or any other branch that serves your static assets), install [`branchsite`](https://github.com/enriquecaballero/branchsite), an `np`-like CLI tool aimed to complement `np`, and create an [npm \"post\" hook](https://docs.npmjs.com/misc/scripts) that runs after `np`.\n\n```\n$ npm install --save-dev branchsite\n```\n\n```json\n\"scripts\": {\n\t\"deploy\": \"np\",\n\t\"postdeploy\": \"bs\"\n}\n```\n\n### Initial version\n\nFor new packages, start the `version` field in package.json at `0.0.0` and let `np` bump it to `1.0.0` or `0.1.0` when publishing.\n\n### Release an update to an old major version\n\nTo release a minor/patch version for an old major version, create a branch from the major version's git tag and run `np`:\n\n```console\n$ git checkout -b fix-old-bug v1.0.0 # Where 1.0.0 is the previous major version\n# Create some commits…\n$ git push --set-upstream origin HEAD\n$ np patch --any-branch --tag=v1\n```\n\n### The prerequisite step runs forever on macOS\n\nIf you're using macOS Sierra 10.12.2 or later, your SSH key passphrase is no longer stored into the keychain by default. This may cause the `prerequisite` step to run forever because it prompts for your passphrase in the background. To fix this, add the following lines to your `~/.ssh/config` and run a simple Git command like `git fetch`.\n\n```\nHost *\n AddKeysToAgent yes\n UseKeychain yes\n```\n\nIf you're running into other issues when using SSH, please consult [GitHub's support article](https://help.github.com/articles/connecting-to-github-with-ssh/).\n\n### Ignore strategy\n\nThe [ignore strategy](https://docs.npmjs.com/files/package.json#files), either maintained in the `files`-property in `package.json` or in `.npmignore`, is meant to help reduce the package size. To avoid broken packages caused by essential files being accidentally ignored, `np` prints out all the new and unpublished files added to Git. Test files and other [common files](https://docs.npmjs.com/files/package.json#files) that are never published are not considered. `np` assumes either a standard directory layout or a customized layout represented in the `directories` property in `package.json`.\n\n## FAQ\n\n### I get an error when publishing my package through Yarn\n\nIf you get an error like this…\n\n```shell\n❯ Prerequisite check\n✔ Ping npm registry\n✔ Check npm version\n✔ Check yarn version\n✖ Verify user is authenticated\n\nnpm ERR! code E403\nnpm ERR! 403 Forbidden - GET https://registry.yarnpkg.com/-/package/my-awesome-package/collaborators?format=cli - Forbidden\n```\n\n…please check whether the command `npm access ls-collaborators my-awesome-package` succeeds. If it doesn't, Yarn has overwritten your registry URL. To fix this, add the correct registry URL to `package.json`:\n\n```json\n\"publishConfig\": {\n\t\"registry\": \"https://registry.npmjs.org\"\n}\n```\n\n## Maintainers\n\n- [Sindre Sorhus](https://github.com/sindresorhus)\n- [Sam Verschueren](https://github.com/SamVerschueren)\n- [Itai Steinherz](https://github.com/itaisteinherz)\n","_attachments":{},"homepage":"https://github.com/sindresorhus/np#readme","bugs":{"url":"https://github.com/sindresorhus/np/issues"},"license":"MIT"}