(window.webpackJsonp=window.webpackJsonp||[]).push([[2237],{2646:function(a,e,s){"use strict";s.r(e);var t=s(31),n=Object(t.a)({},(function(){var a=this,e=a.$createElement,s=a._self._c||e;return s("ContentSlotsDistributor",{attrs:{"slot-key":a.$parent.slotKey}},[s("h1",{attrs:{id:"npm"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#npm"}},[a._v("#")]),a._v(" npm")]),a._v(" "),s("p",[a._v("Node Package Manager (npm) provides following two main functionalities: Online repositories for node.js packages/modules which are searchable on search.nodejs.org. Command line utility to install Node.js packages, do version management and dependency management of Node.js packages.")]),a._v(" "),s("h2",{attrs:{id:"installing-packages"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#installing-packages"}},[a._v("#")]),a._v(" Installing packages")]),a._v(" "),s("h3",{attrs:{id:"introduction"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#introduction"}},[a._v("#")]),a._v(" Introduction")]),a._v(" "),s("p",[a._v("Package is a term used by npm to denote tools that developers can use for their projects. This includes everything from libraries and frameworks such as jQuery and AngularJS  to task runners such as Gulp.js. The packages will come in a folder typically called "),s("code",[a._v("node_modules")]),a._v(", which will also contain a "),s("code",[a._v("package.json")]),a._v(" file. This file contains information regarding all the packages including any dependencies, which are additional modules needed to use a particular package.")]),a._v(" "),s("p",[a._v("Npm uses the command line to both install and manage packages, so users attempting to use npm should be familiar with basic commands on their operating system i.e.: traversing directories as well as being able to see the contents of directories.")]),a._v(" "),s("h3",{attrs:{id:"installing-npm"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#installing-npm"}},[a._v("#")]),a._v(" Installing NPM")]),a._v(" "),s("p",[a._v("Note that in order to install packages, you must have NPM installed.")]),a._v(" "),s("p",[a._v("The recommended way to install NPM is to use one of the installers from the "),s("a",{attrs:{href:"https://nodejs.org/en/download/",target:"_blank",rel:"noopener noreferrer"}},[a._v("Node.js download page"),s("OutboundLink")],1),a._v(".  You can check to see if you already have node.js installed by running either the "),s("code",[a._v("npm -v")]),a._v(" or the "),s("code",[a._v("npm version")]),a._v(" command.")]),a._v(" "),s("p",[a._v("After installing NPM via the Node.js installer, be sure to check for updates.  This is because NPM gets updated more frequently than the Node.js installer.  To check for updates run the following command:")]),a._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[a._v("npm install npm@latest "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("-")]),a._v("g\n\n")])])]),s("h3",{attrs:{id:"how-to-install-packages"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#how-to-install-packages"}},[a._v("#")]),a._v(" How to install packages")]),a._v(" "),s("p",[a._v("To install one or more packages use the following:")]),a._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[a._v("npm install "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("package")]),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("-")]),a._v("name"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v("\n# or\nnpm i "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("package")]),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("-")]),a._v("name"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("...")]),a._v("\n\n# e"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(".")]),a._v("g"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(".")]),a._v(" to install lodash and express\nnpm install lodash express\n\n")])])]),s("blockquote"),a._v(" "),s("p",[s("strong",[a._v("Note")]),a._v(": This will install the package in the directory that the command line is currently in, thus it is important to check whether the appropriate directory has been chosen")]),a._v(" "),s("p",[a._v("If you already have a "),s("code",[a._v("package.json")]),a._v(" file in your current working directory and dependencies are defined in it, then "),s("code",[a._v("npm install")]),a._v(" will automatically resolve and install all dependencies listed in the file. You can also use the shorthand version of the "),s("code",[a._v("npm install")]),a._v(" command which is: "),s("code",[a._v("npm i")])]),a._v(" "),s("p",[a._v("If you want to install a specific version of a package use:")]),a._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[a._v("npm install "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("name"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v("@"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("version"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v("\n\n# e"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(".")]),a._v("g"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(".")]),a._v(" to install version "),s("span",{pre:!0,attrs:{class:"token number"}},[a._v("4.11")]),s("span",{pre:!0,attrs:{class:"token number"}},[a._v(".1")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("of")]),a._v(" the "),s("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("package")]),a._v(" lodash\nnpm install lodash@"),s("span",{pre:!0,attrs:{class:"token number"}},[a._v("4.11")]),s("span",{pre:!0,attrs:{class:"token number"}},[a._v(".1")]),a._v("\n\n")])])]),s("p",[a._v("If you want to install a version which matches a specific version range use:")]),a._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[a._v("npm install "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("name"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v("@"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("version range"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v("\n\n# e"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(".")]),a._v("g"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(".")]),a._v(" to install a version which matches "),s("span",{pre:!0,attrs:{class:"token string"}},[a._v('"version >= 4.10.1"')]),a._v(" and "),s("span",{pre:!0,attrs:{class:"token string"}},[a._v('"version < 4.11.1"')]),a._v("\n# "),s("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("of")]),a._v(" the "),s("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("package")]),a._v(" lodash\nnpm install lodash@"),s("span",{pre:!0,attrs:{class:"token string"}},[a._v('">=4.10.1 <4.11.1"')]),a._v("\n\n")])])]),s("p",[a._v("If you want to install the latest version use:")]),a._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[a._v("npm install "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("name"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v("@latest\n\n")])])]),s("p",[a._v("The above commands will search for packages in the central "),s("code",[a._v("npm")]),a._v(" repository at "),s("a",{attrs:{href:"https://www.npmjs.com/",target:"_blank",rel:"noopener noreferrer"}},[a._v("npmjs.com"),s("OutboundLink")],1),a._v(". If you are not looking to install from the "),s("code",[a._v("npm")]),a._v(" registry, other options are supported, such as:")]),a._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[a._v("# packages distributed "),s("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("as")]),a._v(" a tarball\nnpm install "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("tarball file"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v("\nnpm install "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("tarball url"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v("\n\n# packages available locally\nnpm install "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("local path"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v("\n\n# packages available "),s("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("as")]),a._v(" a git repository\nnpm install "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("git remote url"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v("\n\n# packages available on GitHub\nnpm install "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("username"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("/")]),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("repository"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v("\n\n# packages available "),s("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("as")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[a._v("gist")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("(")]),a._v("need a "),s("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("package")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(".")]),a._v("json"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(")")]),a._v("\nnpm install gist"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("gist"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("-")]),a._v("id"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v("\n\n# packages from a specific repository\nnpm install "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("--")]),a._v("registry"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),a._v("http"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("/")]),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("/")]),a._v("myreg"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(".")]),a._v("mycompany"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(".")]),a._v("com "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("package")]),a._v(" name"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v("\n\n# packages from a related group "),s("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("of")]),a._v(" packages \n# See npm scope\nnpm install @"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("scope"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("/")]),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("name"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("(")]),a._v("@"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("version"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(")")]),a._v("\n\n# Scoping is useful "),s("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("for")]),a._v(" separating "),s("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("private")]),a._v(" packages hosted on "),s("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("private")]),a._v(" registry from\n# "),s("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("public")]),a._v(" ones by setting registry "),s("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("for")]),a._v(" specific scope\nnpm config set @mycompany"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),a._v("registry http"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("/")]),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("/")]),a._v("myreg"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(".")]),a._v("mycompany"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(".")]),a._v("com\nnpm install @mycompany"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("/")]),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("package")]),a._v(" name"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v("\n\n")])])]),s("p",[a._v("Usually, modules will be installed locally in a folder named "),s("code",[a._v("node_modules")]),a._v(", which can be found in your current working directory. This is the directory "),s("code",[a._v("require()")]),a._v(" will use to load modules in order to make them available to you.")]),a._v(" "),s("p",[a._v("If you already created a "),s("code",[a._v("package.json")]),a._v(" file, you can use the "),s("code",[a._v("--save")]),a._v(" (shorthand "),s("code",[a._v("-S")]),a._v(") option or one of its variants to automatically add the installed package to your "),s("code",[a._v("package.json")]),a._v(" as a dependency. If someone else installs your package, "),s("code",[a._v("npm")]),a._v(" will automatically read dependencies from the "),s("code",[a._v("package.json")]),a._v(" file and install the listed versions. Note that you can still add and manage your dependencies by editing the file later, so it's usually a good idea to keep track of dependencies, for example using:")]),a._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[a._v("npm install "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("--")]),a._v("save "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("name"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" # Install dependencies \n# or\nnpm install "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("-")]),s("span",{pre:!0,attrs:{class:"token constant"}},[a._v("S")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("name"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" # shortcut version "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("--")]),a._v("save \n# or\nnpm i "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("-")]),s("span",{pre:!0,attrs:{class:"token constant"}},[a._v("S")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("name"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v("\n\n")])])]),s("p",[a._v("In order to install packages and save them only if they are needed for development, not for running them, not if they are needed for the application to run, follow the following command:")]),a._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[a._v("npm install "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("--")]),a._v("save"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("-")]),a._v("dev "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("name"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" # Install dependencies "),s("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("for")]),a._v(" development purposes\n# or\nnpm install "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("-")]),s("span",{pre:!0,attrs:{class:"token constant"}},[a._v("D")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("name"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" # shortcut version "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("--")]),a._v("save"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("-")]),a._v("dev\n# or\nnpm i "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("-")]),s("span",{pre:!0,attrs:{class:"token constant"}},[a._v("D")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("name"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v("\n\n")])])]),s("h3",{attrs:{id:"installing-dependencies"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#installing-dependencies"}},[a._v("#")]),a._v(" Installing dependencies")]),a._v(" "),s("p",[a._v("Some modules do not only provide a library for you to use, but they also provide one or more binaries which are intended to be used via the command line. Although you can still install those packages locally, it is often preferred to install them globally so the command-line tools can be enabled. In that case, "),s("code",[a._v("npm")]),a._v(" will automatically link the binaries to appropriate paths (e.g. "),s("code",[a._v("/usr/local/bin/<name>")]),a._v(") so they can be used from the command line. To install a package globally, use:")]),a._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[a._v("npm install "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("--")]),a._v("global "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("name"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v("\n# or\nnpm install "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("-")]),a._v("g "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("name"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v("\n# or\nnpm i "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("-")]),a._v("g "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("name"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v("\n\n# e"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(".")]),a._v("g"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(".")]),a._v(" to install the grunt command line tool\nnpm install "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("-")]),a._v("g grunt"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("-")]),a._v("cli\n\n")])])]),s("p",[a._v("If you want to see a list of all the installed packages and their associated versions in the current workspace, use:")]),a._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[a._v("npm list\nnpm list "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("name"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v("\n\n")])])]),s("p",[a._v("Adding an optional name argument can check the version of a specific package.")]),a._v(" "),s("p",[s("strong",[a._v("Note:")]),a._v(" If you run into permission issues while trying to install an npm module globally, resist the temptation to issue a "),s("code",[a._v("sudo npm install -g ...")]),a._v(" to overcome the issue. Granting third-party scripts to run on your system with elevated privileges is dangerous. The permission issue might mean that you have an issue with the way "),s("code",[a._v("npm")]),a._v(" itself was installed. If you're interested in installing Node in sandboxed user environments, you might want to try using "),s("a",{attrs:{href:"https://github.com/creationix/nvm",target:"_blank",rel:"noopener noreferrer"}},[a._v("nvm"),s("OutboundLink")],1),a._v(".")]),a._v(" "),s("p",[a._v("If you have build tools, or other development-only dependencies (e.g. Grunt), you might not want to have them bundled with the application you deploy. If that's the case, you'll want to have it as a development dependency, which is listed in the "),s("code",[a._v("package.json")]),a._v(" under "),s("code",[a._v("devDependencies")]),a._v(". To install a package as a development-only dependency, use "),s("code",[a._v("--save-dev")]),a._v(" (or "),s("code",[a._v("-D")]),a._v(").")]),a._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[a._v("npm install "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("--")]),a._v("save"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("-")]),a._v("dev "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("name"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token comment"}},[a._v("// Install development dependencies which is not included in production ")]),a._v("\n# or\nnpm install "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("-")]),s("span",{pre:!0,attrs:{class:"token constant"}},[a._v("D")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("name"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v("\n\n")])])]),s("p",[a._v("You will see that the package is then added to the "),s("code",[a._v("devDependencies")]),a._v(" of your "),s("code",[a._v("package.json")]),a._v(".")]),a._v(" "),s("p",[a._v("To install dependencies of a downloaded/cloned node.js project, you can simply use")]),a._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[a._v("npm install\n# or\nnpm i\n\n")])])]),s("p",[a._v("npm will automatically read the dependencies from "),s("code",[a._v("package.json")]),a._v(" and install them.")]),a._v(" "),s("h3",{attrs:{id:"npm-behind-a-proxy-server"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#npm-behind-a-proxy-server"}},[a._v("#")]),a._v(" NPM Behind A Proxy Server")]),a._v(" "),s("p",[a._v("If your internet access is through a proxy server, you might need to modify npm install commands that access remote repositories. npm uses a configuration file which can be updated via command line:")]),a._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[a._v("npm config "),s("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("set")]),a._v("\n\n")])])]),s("p",[a._v("You can locate your proxy settings from your browser's settings panel. Once you have obtained the proxy settings (server URL, port, username and password); you need to configure your npm configurations as follows.")]),a._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[a._v("$ npm config "),s("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("set")]),a._v(" proxy http"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("/")]),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("/")]),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("username"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("password"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v("@"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("proxy"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("-")]),a._v("server"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("-")]),a._v("url"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("port"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v("\n$ npm config "),s("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("set")]),a._v(" https"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("-")]),a._v("proxy http"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("/")]),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("/")]),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("username"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("password"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v("@"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("proxy"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("-")]),a._v("server"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("-")]),a._v("url"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("port"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v("\n\n")])])]),s("p",[s("code",[a._v("username")]),a._v(", "),s("code",[a._v("password")]),a._v(", "),s("code",[a._v("port")]),a._v(" fields are optional. Once you have set these, your "),s("code",[a._v("npm install")]),a._v(", "),s("code",[a._v("npm i -g")]),a._v(" etc. would work properly.")]),a._v(" "),s("h2",{attrs:{id:"uninstalling-packages"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#uninstalling-packages"}},[a._v("#")]),a._v(" Uninstalling packages")]),a._v(" "),s("p",[a._v("To uninstall one or more locally installed packages, use:")]),a._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[a._v("npm uninstall "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("package")]),a._v(" name"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v("\n\n")])])]),s("p",[a._v("The uninstall command for npm has five aliases that can also be used:")]),a._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[a._v("npm remove "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("package")]),a._v(" name"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v("\nnpm rm "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("package")]),a._v(" name"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v("\nnpm r "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("package")]),a._v(" name"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v("\n\nnpm unlink "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("package")]),a._v(" name"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v("\nnpm un "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("package")]),a._v(" name"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v("\n\n")])])]),s("p",[a._v("If you would like to remove the package from the "),s("code",[a._v("package.json")]),a._v(" file as part of the uninstallation, use the "),s("code",[a._v("--save")]),a._v(" flag (shorthand: "),s("code",[a._v("-S")]),a._v("):")]),a._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[a._v("npm uninstall "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("--")]),a._v("save "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("package")]),a._v(" name"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v("\nnpm uninstall "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("-")]),s("span",{pre:!0,attrs:{class:"token constant"}},[a._v("S")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("package")]),a._v(" name"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v("\n\n")])])]),s("p",[a._v("For a development dependency, use the "),s("code",[a._v("--save-dev")]),a._v(" flag (shorthand: "),s("code",[a._v("-D")]),a._v("):")]),a._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[a._v("npm uninstall "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("--")]),a._v("save"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("-")]),a._v("dev "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("package")]),a._v(" name"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v("\nnpm uninstall "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("-")]),s("span",{pre:!0,attrs:{class:"token constant"}},[a._v("D")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("package")]),a._v(" name"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v("\n\n")])])]),s("p",[a._v("For an optional dependency, use the "),s("code",[a._v("--save-optional")]),a._v(" flag (shorthand: "),s("code",[a._v("-O")]),a._v("):")]),a._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[a._v("npm uninstall "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("--")]),a._v("save"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("-")]),a._v("optional "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("package")]),a._v(" name"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v("\nnpm uninstall "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("-")]),s("span",{pre:!0,attrs:{class:"token constant"}},[a._v("O")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("package")]),a._v(" name"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v("\n\n")])])]),s("p",[a._v("For packages that are installed globally use the "),s("code",[a._v("--global")]),a._v(" flag (shorthand: "),s("code",[a._v("-g")]),a._v("):")]),a._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[a._v("npm uninstall "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("-")]),a._v("g "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("package")]),a._v(" name"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v("\n\n")])])]),s("h2",{attrs:{id:"setting-up-a-package-configuration"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#setting-up-a-package-configuration"}},[a._v("#")]),a._v(" Setting up a package configuration")]),a._v(" "),s("p",[a._v("Node.js package configurations are contained in a file called "),s("code",[a._v("package.json")]),a._v(" that you can find at the root of each project. You can setup a brand new configuration file by calling:")]),a._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[a._v("npm init\n\n")])])]),s("p",[a._v("That will try to read the current working directory for Git repository information (if it exists) and environment variables to try and autocomplete some of the placeholder values for you. Otherwise, it will provide an input dialog for the basic options.")]),a._v(" "),s("p",[a._v("If you'd like to create a "),s("code",[a._v("package.json")]),a._v(" with default values use:")]),a._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[a._v("npm init "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("--")]),a._v("yes\n# or\nnpm init "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("-")]),a._v("y \n\n")])])]),s("p",[a._v("If you're creating a "),s("code",[a._v("package.json")]),a._v(" for a project that you are not going to be publishing as an npm package (i.e. solely for the purpose of rounding up your dependencies), you can convey this intent in your "),s("code",[a._v("package.json")]),a._v(" file:")]),a._v(" "),s("ol",[s("li",[a._v("Optionally set the "),s("code",[a._v("private")]),a._v(" property to true to prevent accidental publishing.")]),a._v(" "),s("li",[a._v("Optionally set the "),s("code",[a._v("license")]),a._v(' property to "UNLICENSED" to deny others the right to use your package.')])]),a._v(" "),s("p",[a._v("To install a package and automatically save it to your "),s("code",[a._v("package.json")]),a._v(", use:")]),a._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[a._v("npm install "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("--")]),a._v("save "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("package")]),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v("\n\n")])])]),s("p",[a._v("The package and associated metadata (such as the package version) will appear in your dependencies. If you save if as a development dependency (using "),s("code",[a._v("--save-dev")]),a._v("), the package will instead appear in your "),s("code",[a._v("devDependencies")]),a._v(".")]),a._v(" "),s("p",[a._v("With this bare-bones "),s("code",[a._v("package.json")]),a._v(", you will encounter warning messages when installing or upgrading packages, telling you that you are missing a description and the repository field. While it is safe to ignore these messages, you can get rid of them by opening the package.json in any text editor and adding the following lines to the JSON object:")]),a._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("[")]),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("...")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("]")]),a._v("\n"),s("span",{pre:!0,attrs:{class:"token string"}},[a._v('"description"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[a._v('"No description"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(",")]),a._v("\n"),s("span",{pre:!0,attrs:{class:"token string"}},[a._v('"repository"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n  "),s("span",{pre:!0,attrs:{class:"token string"}},[a._v('"private"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token boolean"}},[a._v("true")]),a._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(",")]),a._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("[")]),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("...")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("]")]),a._v("\n\n")])])]),s("h2",{attrs:{id:"running-scripts"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#running-scripts"}},[a._v("#")]),a._v(" Running scripts")]),a._v(" "),s("p",[a._v("You may define scripts in your "),s("code",[a._v("package.json")]),a._v(", for example:")]),a._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n  "),s("span",{pre:!0,attrs:{class:"token string"}},[a._v('"name"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[a._v('"your-package"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(",")]),a._v("\n  "),s("span",{pre:!0,attrs:{class:"token string"}},[a._v('"version"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[a._v('"1.0.0"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(",")]),a._v("\n  "),s("span",{pre:!0,attrs:{class:"token string"}},[a._v('"description"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[a._v('""')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(",")]),a._v("\n  "),s("span",{pre:!0,attrs:{class:"token string"}},[a._v('"main"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[a._v('"index.js"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(",")]),a._v("\n  "),s("span",{pre:!0,attrs:{class:"token string"}},[a._v('"author"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[a._v('""')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(",")]),a._v("\n  "),s("span",{pre:!0,attrs:{class:"token string"}},[a._v('"license"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[a._v('"ISC"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(",")]),a._v("\n  "),s("span",{pre:!0,attrs:{class:"token string"}},[a._v('"dependencies"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(",")]),a._v("\n  "),s("span",{pre:!0,attrs:{class:"token string"}},[a._v('"devDependencies"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(",")]),a._v("\n  "),s("span",{pre:!0,attrs:{class:"token string"}},[a._v('"scripts"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n    "),s("span",{pre:!0,attrs:{class:"token string"}},[a._v('"echo"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[a._v('"echo hello!"')]),a._v("\n  "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n\n\n")])])]),s("p",[a._v("To run the "),s("code",[a._v("echo")]),a._v(" script, run "),s("code",[a._v("npm run echo")]),a._v(" from the command line. Arbitrary scripts, such as "),s("code",[a._v("echo")]),a._v(" above, have to be be run with "),s("code",[a._v("npm run <script name>")]),a._v(". npm also  has a number of official scripts that it runs at certain stages of the package's life (like "),s("code",[a._v("preinstall")]),a._v("). See "),s("a",{attrs:{href:"https://docs.npmjs.com/misc/scripts",target:"_blank",rel:"noopener noreferrer"}},[a._v("here"),s("OutboundLink")],1),a._v(" for the entire overview of how npm handles script fields.")]),a._v(" "),s("p",[a._v("npm scripts are used most often for things like starting a server, building the project, and running tests. Here's a more realistic example:")]),a._v(" "),s("div",{staticClass:"language- extra-class"},[s("pre",{pre:!0,attrs:{class:"language-text"}},[s("code",[a._v('\n "scripts": {\n    "test": "mocha tests",\n    "start": "pm2 start index.js"\n  }\n\n')])])]),s("p",[a._v("In the "),s("code",[a._v("scripts")]),a._v(" entries, command-line programs like "),s("code",[a._v("mocha")]),a._v(" will work when installed either globally or locally. If the command-line entry does not exist in the system PATH, npm will also check your locally installed packages.")]),a._v(" "),s("p",[a._v("If your scripts become very long, they can be split into parts, like this:")]),a._v(" "),s("div",{staticClass:"language- extra-class"},[s("pre",{pre:!0,attrs:{class:"language-text"}},[s("code",[a._v('\n "scripts": {\n    "very-complex-command": "npm run chain-1 && npm run chain-2",\n    "chain-1": "webpack",\n    "chain-2": "node app.js"\n  }\n\n')])])]),s("h2",{attrs:{id:"basic-semantic-versioning"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#basic-semantic-versioning"}},[a._v("#")]),a._v(" Basic semantic versioning")]),a._v(" "),s("p",[a._v("Before publishing a package you have to version it. npm supports "),s("a",{attrs:{href:"http://semver.org/",target:"_blank",rel:"noopener noreferrer"}},[a._v("semantic versioning"),s("OutboundLink")],1),a._v(", this means there are "),s("strong",[a._v("patch, minor and major")]),a._v(" releases.")]),a._v(" "),s("p",[a._v("For example, if your package is at version 1.2.3 to change version you have to:")]),a._v(" "),s("ol",[s("li",[a._v("patch release: "),s("code",[a._v("npm version patch")]),a._v(" => 1.2.4")]),a._v(" "),s("li",[a._v("minor release: "),s("code",[a._v("npm version minor")]),a._v(" => 1.3.0")]),a._v(" "),s("li",[a._v("major release: "),s("code",[a._v("npm version major")]),a._v(" => 2.0.0")])]),a._v(" "),s("p",[a._v("You can also specify a version directly with:")]),a._v(" "),s("p",[s("code",[a._v("npm version 3.1.4")]),a._v(" => 3.1.4")]),a._v(" "),s("p",[a._v('When you set a package version using one of the npm commands above, npm will modify the version field of the package.json file, commit it, and also create a new Git tag with the version prefixed with a "v", as if you\'ve issued the command:')]),a._v(" "),s("p",[s("code",[a._v("git tag v3.1.4")])]),a._v(" "),s("p",[a._v("Unlike other package managers like Bower, the npm registry doesn't rely on Git tags being created for every version. But, if you like using tags, you should remember to push the newly created tag after bumping the package version:")]),a._v(" "),s("p",[s("code",[a._v("git push origin master")]),a._v(" (to push the change to package.json)")]),a._v(" "),s("p",[s("code",[a._v("git push origin v3.1.4")]),a._v(" (to push the new tag)")]),a._v(" "),s("p",[a._v("Or you can do this in one swoop with:")]),a._v(" "),s("p",[s("code",[a._v("git push origin master --tags")])]),a._v(" "),s("h2",{attrs:{id:"publishing-a-package"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#publishing-a-package"}},[a._v("#")]),a._v(" Publishing a package")]),a._v(" "),s("p",[a._v("First, make sure that you have configured your package (as said in "),s("a",{attrs:{href:"http://stackoverflow.com/documentation/node.js/482/npm/2257/setting-up-a-package-configuration",target:"_blank",rel:"noopener noreferrer"}},[a._v("Setting up a package configuration"),s("OutboundLink")],1),a._v("​). Then, you have to be logged in to npmjs.")]),a._v(" "),s("p",[a._v("If you already have a npm user")]),a._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[a._v("npm login\n\n")])])]),s("p",[a._v("If you don't have a user")]),a._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[a._v("npm adduser\n\n")])])]),s("p",[a._v("To check that your user is registered in the current client")]),a._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[a._v("npm config ls\n\n")])])]),s("p",[a._v("After that, when your package is ready to be published use")]),a._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[a._v("npm publish\n\n")])])]),s("p",[a._v("And you are done.")]),a._v(" "),s("p",[a._v("If you need to publish a new version, ensure that you update your package version, as stated in "),s("a",{attrs:{href:"http://stackoverflow.com/documentation/node.js/482/npm/2178/basic-semantic-versionini",target:"_blank",rel:"noopener noreferrer"}},[a._v("Basic semantic versioning"),s("OutboundLink")],1),a._v(". Otherwise, "),s("code",[a._v("npm")]),a._v(" will not let you publish the package.")]),a._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("{")]),a._v("\n    name"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[a._v('"package-name"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(",")]),a._v("\n    version"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[a._v('"1.0.4"')]),a._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("}")]),a._v("\n\n")])])]),s("h2",{attrs:{id:"removing-extraneous-packages"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#removing-extraneous-packages"}},[a._v("#")]),a._v(" Removing extraneous packages")]),a._v(" "),s("p",[a._v("To remove extraneous packages (packages that are installed but not in dependency list) run the following command:")]),a._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[a._v("npm prune\n\n")])])]),s("p",[a._v("To remove all "),s("code",[a._v("dev")]),a._v(" packages add "),s("code",[a._v("--production")]),a._v(" flag:")]),a._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[a._v("npm prune "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("--")]),a._v("production\n\n")])])]),s("p",[s("a",{attrs:{href:"https://docs.npmjs.com/cli/prune",target:"_blank",rel:"noopener noreferrer"}},[a._v("More on it"),s("OutboundLink")],1)]),a._v(" "),s("h2",{attrs:{id:"scopes-and-repositories"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#scopes-and-repositories"}},[a._v("#")]),a._v(" Scopes and repositories")]),a._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[a._v("# Set the repository "),s("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("for")]),a._v(" the scope "),s("span",{pre:!0,attrs:{class:"token string"}},[a._v('"myscope"')]),a._v("\nnpm config set @myscope"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),a._v("registry http"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("/")]),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("/")]),a._v("registry"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(".")]),a._v("corporation"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(".")]),a._v("com\n\n# Login at a repository and associate it "),s("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("with")]),a._v(" the scope "),s("span",{pre:!0,attrs:{class:"token string"}},[a._v('"myscope"')]),a._v("\nnpm adduser "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("--")]),a._v("registry"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),a._v("http"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("/")]),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("/")]),a._v("registry"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(".")]),a._v("corporation"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(".")]),a._v("com "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("--")]),a._v("scope"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),a._v("@myscope\n\n# Install a "),s("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("package")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[a._v('"mylib"')]),a._v(" from the scope "),s("span",{pre:!0,attrs:{class:"token string"}},[a._v('"myscope"')]),a._v("\nnpm install @myscope"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("/")]),a._v("mylib\n\n")])])]),s("p",[a._v("If the name of your own package starts with "),s("code",[a._v("@myscope")]),a._v(' and the scope "myscope" is associated with a different repository, '),s("code",[a._v("npm publish")]),a._v(" will upload your package to that repository instead.")]),a._v(" "),s("p",[a._v("You can also persist these settings in a "),s("code",[a._v(".npmrc")]),a._v(" file:")]),a._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[a._v("@myscope"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),a._v("registry"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),a._v("http"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("/")]),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("/")]),a._v("registry"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(".")]),a._v("corporation"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(".")]),a._v("com\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[a._v("//registry.corporation.com/:_authToken=xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxx")]),a._v("\n\n")])])]),s("p",[a._v("This is useful when automating the build on a CI server f.e.")]),a._v(" "),s("h2",{attrs:{id:"listing-currently-installed-packages"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#listing-currently-installed-packages"}},[a._v("#")]),a._v(" Listing currently installed packages")]),a._v(" "),s("p",[a._v("To generate a list (tree view) of currently installed packages, use")]),a._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[a._v("npm list\n\n")])])]),s("p",[s("strong",[a._v("ls")]),a._v(", "),s("strong",[a._v("la")]),a._v(" and "),s("strong",[a._v("ll")]),a._v(" are aliases of "),s("strong",[a._v("list")]),a._v(" command.\nla and ll commands shows extended information like description and repository.")]),a._v(" "),s("p",[s("strong",[a._v("Options")])]),a._v(" "),s("p",[a._v("The response format can be changed by passing options.")]),a._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[a._v("npm list "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("--")]),a._v("json\n\n")])])]),s("ul",[s("li",[s("strong",[a._v("json")]),a._v(" - Shows information in json format")]),a._v(" "),s("li",[s("strong",[a._v("long")]),a._v(" - Shows extended information")]),a._v(" "),s("li",[s("strong",[a._v("parseable")]),a._v(" - Shows parseable list instead of tree")]),a._v(" "),s("li",[s("strong",[a._v("global")]),a._v(" - Shows globally installed packages")]),a._v(" "),s("li",[s("strong",[a._v("depth")]),a._v(" - Maximum display depth of dependency tree")]),a._v(" "),s("li",[s("strong",[a._v("dev")]),a._v("/"),s("strong",[a._v("development")]),a._v(" - Shows devDependencies")]),a._v(" "),s("li",[s("strong",[a._v("prod")]),a._v("/"),s("strong",[a._v("production")]),a._v(" - Shows dependencies")])]),a._v(" "),s("p",[a._v("If you want, you can also go to the package's home page.")]),a._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[a._v("npm home "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("package")]),a._v(" name"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v("\n\n")])])]),s("h2",{attrs:{id:"updating-npm-and-packages"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#updating-npm-and-packages"}},[a._v("#")]),a._v(" Updating npm and packages")]),a._v(" "),s("p",[a._v("Since npm itself is a Node.js module, it can be updated using itself.")]),a._v(" "),s("p",[s("strong",[a._v("If OS is Windows must be running command prompt as Admin")])]),a._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[a._v("npm install "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("-")]),a._v("g npm@latest\n\n")])])]),s("p",[a._v("If you want to check for updated versions you can do:")]),a._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[a._v("npm outdated\n\n")])])]),s("p",[a._v("In order to update a specific package:")]),a._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[a._v("npm update "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("package")]),a._v(" name"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v("\n\n")])])]),s("blockquote"),a._v(" "),s("p",[a._v("This will update the package to the latest version according to the restrictions in package.json")]),a._v(" "),s("p",[a._v("In case you also want to lock the updated version in package.json:")]),a._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[a._v("npm update "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("package")]),a._v(" name"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("--")]),a._v("save\n\n")])])]),s("h2",{attrs:{id:"locking-modules-to-specific-versions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#locking-modules-to-specific-versions"}},[a._v("#")]),a._v(" Locking modules to specific versions")]),a._v(" "),s("p",[a._v("By default, npm installs the latest available version of modules according to each dependencies' "),s("a",{attrs:{href:"http://stackoverflow.com/documentation/node.js/482/npm/2178/basic-semantic-versioning",target:"_blank",rel:"noopener noreferrer"}},[a._v("semantic version"),s("OutboundLink")],1),a._v(". This can be problematic if a module author doesn't adhere to semver and introduces breaking changes in a module update, for example.")]),a._v(" "),s("p",[a._v("To lock down each dependencies' version (and the versions of their dependencies, etc) to the specific version installed locally in the "),s("code",[a._v("node_modules")]),a._v(" folder, use")]),a._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[a._v("npm shrinkwrap\n\n")])])]),s("p",[a._v("This will then create a "),s("code",[a._v("npm-shrinkwrap.json")]),a._v(" alongside your "),s("code",[a._v("package.json")]),a._v(" which lists the specific versions of dependancies.")]),a._v(" "),s("h2",{attrs:{id:"setting-up-for-globally-installed-packages"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#setting-up-for-globally-installed-packages"}},[a._v("#")]),a._v(" Setting up for globally installed packages")]),a._v(" "),s("p",[a._v("You can use "),s("code",[a._v("npm install -g")]),a._v(' to install a package "globally." This is typically done to install an executable that you can add to your path to run. For example:')]),a._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[a._v("npm install "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("-")]),a._v("g gulp"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("-")]),a._v("cli\n\n")])])]),s("p",[a._v("If you update your path, you can call "),s("code",[a._v("gulp")]),a._v(" directly.")]),a._v(" "),s("p",[a._v("On many OSes, "),s("code",[a._v("npm install -g")]),a._v(" will attempt to write to a directory that your user may not be able to write to such as "),s("code",[a._v("/usr/bin")]),a._v(". You should "),s("strong",[a._v("not")]),a._v(" use "),s("code",[a._v("sudo npm install")]),a._v(" in this case since there is a possible security risk of running arbitrary scripts with "),s("code",[a._v("sudo")]),a._v(" and the root user may create directories in your home that you cannot write to which makes future installations more difficult.")]),a._v(" "),s("p",[a._v("You can tell "),s("code",[a._v("npm")]),a._v(" where to install global modules to via your configuration file, "),s("code",[a._v("~/.npmrc")]),a._v(". This is called the "),s("code",[a._v("prefix")]),a._v(" which you can view with "),s("code",[a._v("npm prefix")]),a._v(".")]),a._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[a._v("prefix"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("~")]),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("/")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(".")]),a._v("npm"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("-")]),a._v("global"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("-")]),a._v("modules\n\n")])])]),s("p",[a._v("This will use the prefix whenever you run "),s("code",[a._v("npm install -g")]),a._v(". You can also use "),s("code",[a._v("npm install --prefix ~/.npm-global-modules")]),a._v(" to set the prefix when you install. If the prefix is the same as your configuration, you don't need to use "),s("code",[a._v("-g")]),a._v(".")]),a._v(" "),s("p",[a._v("In order to use the globally installed module, it needs to be on your path:")]),a._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("export")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token constant"}},[a._v("PATH")]),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),a._v("$"),s("span",{pre:!0,attrs:{class:"token constant"}},[a._v("PATH")]),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("~")]),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("/")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(".")]),a._v("npm"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("-")]),a._v("global"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("-")]),a._v("modules"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("/")]),a._v("bin\n\n")])])]),s("p",[a._v("Now when you run "),s("code",[a._v("npm install -g gulp-cli")]),a._v(" you will be able to use "),s("code",[a._v("gulp")]),a._v(".")]),a._v(" "),s("p",[s("strong",[a._v("Note:")]),a._v(" When you "),s("code",[a._v("npm install")]),a._v(" (without "),s("code",[a._v("-g")]),a._v(") the prefix will be the directory with "),s("code",[a._v("package.json")]),a._v(" or the current directory if none is found in the hierarchy. This also creates a directory "),s("code",[a._v("node_modules/.bin")]),a._v(" that has the executables. If you want to use an executable that is specific to a project, it's not necessary to use "),s("code",[a._v("npm install -g")]),a._v(". You can use the one in "),s("code",[a._v("node_modules/.bin")]),a._v(".")]),a._v(" "),s("h2",{attrs:{id:"linking-projects-for-faster-debugging-and-development"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#linking-projects-for-faster-debugging-and-development"}},[a._v("#")]),a._v(" Linking projects for faster debugging and development")]),a._v(" "),s("p",[a._v("Building project dependencies can sometimes be a tedious task. Instead of publishing a package version to NPM and installing the dependency to test the changes, use "),s("code",[a._v("npm link")]),a._v(". "),s("code",[a._v("npm link")]),a._v(" creates a symlink so the latest code can be tested in a local environment. This makes testing global tools and project dependencies easier by allowing the latest code run before making a published version.")]),a._v(" "),s("h3",{attrs:{id:"help-text"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#help-text"}},[a._v("#")]),a._v(" Help text")]),a._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token constant"}},[a._v("NAME")]),a._v("\n       npm"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("-")]),a._v("link "),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("-")]),a._v(" Symlink a "),s("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("package")]),a._v(" folder\n\n"),s("span",{pre:!0,attrs:{class:"token constant"}},[a._v("SYNOPSIS")]),a._v("\n         npm "),s("span",{pre:!0,attrs:{class:"token function"}},[a._v("link")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("(")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("in")]),a._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[a._v("package")]),a._v(" dir"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v(")")]),a._v("\n         npm link "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("[")]),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("@scope"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("/")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("]")]),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("pkg"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("[")]),a._v("@"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("version"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("]")]),a._v("\n\n         alias"),s("span",{pre:!0,attrs:{class:"token operator"}},[a._v(":")]),a._v(" npm ln\n\n")])])]),s("h3",{attrs:{id:"steps-for-linking-project-dependencies"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#steps-for-linking-project-dependencies"}},[a._v("#")]),a._v(" Steps for linking project dependencies")]),a._v(" "),s("p",[a._v("When creating the dependency link, note that the package name is what is going to be referenced in the parent project.")]),a._v(" "),s("ol",[s("li",[a._v("CD into a dependency directory (ex: "),s("code",[a._v("cd ../my-dep")]),a._v(")")]),a._v(" "),s("li",[s("code",[a._v("npm link")])]),a._v(" "),s("li",[a._v("CD into the project that is going to use the dependency")]),a._v(" "),s("li",[s("code",[a._v("npm link my-dep")]),a._v(" or if namespaced "),s("code",[a._v("npm link @namespace/my-dep")])])]),a._v(" "),s("h3",{attrs:{id:"steps-for-linking-a-global-tool"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#steps-for-linking-a-global-tool"}},[a._v("#")]),a._v(" Steps for linking a global tool")]),a._v(" "),s("ol",[s("li",[a._v("CD into the project directory (ex: "),s("code",[a._v("cd eslint-watch")]),a._v(")")]),a._v(" "),s("li",[s("code",[a._v("npm link")])]),a._v(" "),s("li",[a._v("Use the tool")]),a._v(" "),s("li",[s("code",[a._v("esw --quiet")])])]),a._v(" "),s("h3",{attrs:{id:"problems-that-may-arise"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#problems-that-may-arise"}},[a._v("#")]),a._v(" Problems that may arise")]),a._v(" "),s("p",[a._v("Linking projects can sometimes cause issues if the dependency or global tool is already installed. "),s("code",[a._v("npm uninstall (-g) <pkg>")]),a._v(" and then running "),s("code",[a._v("npm link")]),a._v(" normally resolves any issues that may arise.")]),a._v(" "),s("h4",{attrs:{id:"syntax"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#syntax"}},[a._v("#")]),a._v(" Syntax")]),a._v(" "),s("li",[a._v("npm "),s("command",[a._v(" where "),s("command",[a._v(" is one of:\n"),s("ul",[a._v("\n- [add-user](https://docs.npmjs.com/cli/adduser)\n- [adduser](https://docs.npmjs.com/cli/adduser)\n- apihelp\n- author\n- bin\n- bugs\n- c\n- [cache](https://docs.npmjs.com/cli/cache)\n- completion\n- [config](https://docs.npmjs.com/cli/config)\n- [ddp](https://docs.npmjs.com/cli/dedupe)\n- [dedupe](https://docs.npmjs.com/cli/dedupe)\n- deprecate\n- docs\n- edit\n- explore\n- faq\n- find\n- find-dupes\n- [get](https://docs.npmjs.com/cli/config)\n- [help](https://docs.npmjs.com/cli/help)\n- [help-search](https://docs.npmjs.com/cli/help-search)\n- home\n- [i](http://stackoverflow.com/documentation/node.js/482/npm/1588/installing-packages#t=201608130932049548019)\n- [install](http://stackoverflow.com/documentation/node.js/482/npm/1588/installing-packages#t=201608130932049548019)\n- info\n- [init](http://stackoverflow.com/documentation/node.js/482/npm/2257/setting-up-a-package-configuration#t=201608130932049548019)\n- isntall\n- issues\n- la\n- [link](https://docs.npmjs.com/cli/link)\n- [list](http://stackoverflow.com/documentation/node.js/482/npm/8732/listing-currently-installed-packages#t=201608130932049548019)\n- ll\n- ln\n- login\n- ls\n- outdated\n- [owner](https://docs.npmjs.com/cli/owner)\n- pack\n- prefix\n- [prune](http://stackoverflow.com/documentation/node.js/482/npm/8731/removing-extraneous-packages#t=201608130932049548019)\n- [publish](http://stackoverflow.com/documentation/node.js/482/npm/1588/installing-packages#t=201608130932049548019)\n- r\n- [rb](https://docs.npmjs.com/cli/rebuild)\n- [rebuild](https://docs.npmjs.com/cli/rebuild)\n- remove\n- [repo](https://docs.npmjs.com/cli/repo)\n- [restart](https://docs.npmjs.com/cli/restart)\n- [rm](https://docs.npmjs.com/cli/rm)\n- root\n- [run-script](http://stackoverflow.com/documentation/node.js/482/npm/4592/running-scripts#t=201608130932049548019)\n- [s](https://docs.npmjs.com/cli/search)\n- [se](https://docs.npmjs.com/cli/search)\n- [search](https://docs.npmjs.com/cli/search)\n- [set](https://docs.npmjs.com/cli/config)\n- show\n- shrinkwrap\n- [star](https://docs.npmjs.com/cli/star)\n- [stars](https://docs.npmjs.com/cli/stars)\n- [start](https://docs.npmjs.com/cli/start)\n- [stop](https://docs.npmjs.com/cli/stop)\n- [submodule](https://docs.npmjs.com/cli/submodule)\n- [tag](https://docs.npmjs.com/cli/tag)\n- [test](https://docs.npmjs.com/cli/test)\n- [tst](https://docs.npmjs.com/cli/test)\n- [un](http://stackoverflow.com/documentation/node.js/482/npm/2153/uninstalling-packages#t=201608130932049548019)\n- [uninstall](http://stackoverflow.com/documentation/node.js/482/npm/2153/uninstalling-packages#t=201608130932049548019)\n- [unlink](https://docs.npmjs.com/cli/link)\n- [unpublish](https://docs.npmjs.com/cli/unpublish)\n- [unstar](https://docs.npmjs.com/cli/star)\n- [up](https://docs.npmjs.com/cli/update)\n- [update](https://docs.npmjs.com/cli/update)\n- [v](https://docs.npmjs.com/cli/version)\n- [version](https://docs.npmjs.com/cli/version)\n- [view](https://docs.npmjs.com/cli/view)\n- [whoami](https://docs.npmjs.com/cli/whoami)\n"),s("h4",{attrs:{id:"parameters"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#parameters"}},[a._v("#")]),a._v(" Parameters")]),a._v(" "),s("table",[s("thead",[s("tr",[s("th",[a._v("Parameter")]),a._v(" "),s("th",[a._v("Example")])])]),a._v(" "),s("tbody",[s("tr",[s("td",[s("a",{attrs:{href:"https://docs.npmjs.com/cli/access",target:"_blank",rel:"noopener noreferrer"}},[a._v("access"),s("OutboundLink")],1)]),a._v(" "),s("td",[s("code",[a._v("npm publish --access=public")])])]),a._v(" "),s("tr",[s("td",[s("a",{attrs:{href:"https://docs.npmjs.com/cli/bin",target:"_blank",rel:"noopener noreferrer"}},[a._v("bin"),s("OutboundLink")],1)]),a._v(" "),s("td",[s("code",[a._v("npm bin -g")])])]),a._v(" "),s("tr",[s("td",[s("a",{attrs:{href:"https://docs.npmjs.com/cli/edit",target:"_blank",rel:"noopener noreferrer"}},[a._v("edit"),s("OutboundLink")],1)]),a._v(" "),s("td",[s("code",[a._v("npm edit connect")])])]),a._v(" "),s("tr",[s("td",[s("a",{attrs:{href:"https://docs.npmjs.com/cli/help",target:"_blank",rel:"noopener noreferrer"}},[a._v("help"),s("OutboundLink")],1)]),a._v(" "),s("td",[s("code",[a._v("npm help init")])])]),a._v(" "),s("tr",[s("td",[s("a",{attrs:{href:"https://docs.npmjs.com/cli/init",target:"_blank",rel:"noopener noreferrer"}},[a._v("init"),s("OutboundLink")],1)]),a._v(" "),s("td",[s("code",[a._v("npm init")])])]),a._v(" "),s("tr",[s("td",[s("a",{attrs:{href:"https://docs.npmjs.com/cli/install",target:"_blank",rel:"noopener noreferrer"}},[a._v("install"),s("OutboundLink")],1)]),a._v(" "),s("td",[s("code",[a._v("npm install")])])]),a._v(" "),s("tr",[s("td",[s("a",{attrs:{href:"https://docs.npmjs.com/cli/link",target:"_blank",rel:"noopener noreferrer"}},[a._v("link"),s("OutboundLink")],1)]),a._v(" "),s("td",[s("code",[a._v("npm link")])])]),a._v(" "),s("tr",[s("td",[s("a",{attrs:{href:"https://docs.npmjs.com/cli/prune",target:"_blank",rel:"noopener noreferrer"}},[a._v("prune"),s("OutboundLink")],1)]),a._v(" "),s("td",[s("code",[a._v("npm prune")])])]),a._v(" "),s("tr",[s("td",[s("a",{attrs:{href:"https://docs.npmjs.com/cli/publish",target:"_blank",rel:"noopener noreferrer"}},[a._v("publish"),s("OutboundLink")],1)]),a._v(" "),s("td",[s("code",[a._v("npm publish ./")])])]),a._v(" "),s("tr",[s("td",[s("a",{attrs:{href:"https://docs.npmjs.com/cli/restart",target:"_blank",rel:"noopener noreferrer"}},[a._v("restart"),s("OutboundLink")],1)]),a._v(" "),s("td",[s("code",[a._v("npm restart")])])]),a._v(" "),s("tr",[s("td",[s("a",{attrs:{href:"https://docs.npmjs.com/cli/start",target:"_blank",rel:"noopener noreferrer"}},[a._v("start"),s("OutboundLink")],1)]),a._v(" "),s("td",[s("code",[a._v("npm start")])])]),a._v(" "),s("tr",[s("td",[s("a",{attrs:{href:"https://docs.npmjs.com/cli/stop",target:"_blank",rel:"noopener noreferrer"}},[a._v("stop"),s("OutboundLink")],1)]),a._v(" "),s("td",[s("code",[a._v("npm start")])])]),a._v(" "),s("tr",[s("td",[s("a",{attrs:{href:"https://docs.npmjs.com/cli/update",target:"_blank",rel:"noopener noreferrer"}},[a._v("update"),s("OutboundLink")],1)]),a._v(" "),s("td",[s("code",[a._v("npm update")])])]),a._v(" "),s("tr",[s("td",[s("a",{attrs:{href:"https://docs.npmjs.com/cli/version",target:"_blank",rel:"noopener noreferrer"}},[a._v("version"),s("OutboundLink")],1)]),a._v(" "),s("td",[s("code",[a._v("npm version")])])])])])])])],1)],1)])}),[],!1,null,null,null);e.default=n.exports}}]);