codekingpro/portable-devtools
114k
1<!DOCTYPE html><html><head>
2<meta charset="utf-8">
3<title>npm-version</title>
4<style>
5body {
6 background-color: #ffffff;
7 color: #24292e;
8
9 margin: 0;
10
11 line-height: 1.5;
12
13 font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji";
14}
15#rainbar {
16 height: 10px;
17 background-image: linear-gradient(139deg, #fb8817, #ff4b01, #c12127, #e02aff);
18}
19
20a {
21 text-decoration: none;
22 color: #0366d6;
23}
24a:hover {
25 text-decoration: underline;
26}
27
28pre {
29 margin: 1em 0px;
30 padding: 1em;
31 border: solid 1px #e1e4e8;
32 border-radius: 6px;
33
34 display: block;
35 overflow: auto;
36
37 white-space: pre;
38
39 background-color: #f6f8fa;
40 color: #393a34;
41}
42code {
43 font-family: SFMono-Regular, Consolas, "Liberation Mono", Menlo, Courier, monospace;
44 font-size: 85%;
45 padding: 0.2em 0.4em;
46 background-color: #f6f8fa;
47 color: #393a34;
48}
49pre > code {
50 padding: 0;
51 background-color: inherit;
52 color: inherit;
53}
54h1, h2, h3 {
55 font-weight: 600;
56}
57
58#logobar {
59 background-color: #333333;
60 margin: 0 auto;
61 padding: 1em 4em;
62}
63#logobar .logo {
64 float: left;
65}
66#logobar .title {
67 font-weight: 600;
68 color: #dddddd;
69 float: left;
70 margin: 5px 0 0 1em;
71}
72#logobar:after {
73 content: "";
74 display: block;
75 clear: both;
76}
77
78#content {
79 margin: 0 auto;
80 padding: 0 4em;
81}
82
83#table_of_contents > h2 {
84 font-size: 1.17em;
85}
86#table_of_contents ul:first-child {
87 border: solid 1px #e1e4e8;
88 border-radius: 6px;
89 padding: 1em;
90 background-color: #f6f8fa;
91 color: #393a34;
92}
93#table_of_contents ul {
94 list-style-type: none;
95 padding-left: 1.5em;
96}
97#table_of_contents li {
98 font-size: 0.9em;
99}
100#table_of_contents li a {
101 color: #000000;
102}
103
104header.title {
105 border-bottom: solid 1px #e1e4e8;
106}
107header.title > h1 {
108 margin-bottom: 0.25em;
109}
110header.title > .description {
111 display: block;
112 margin-bottom: 0.5em;
113 line-height: 1;
114}
115
116header.title .version {
117 font-size: 0.8em;
118 color: #666666;
119}
120
121footer#edit {
122 border-top: solid 1px #e1e4e8;
123 margin: 3em 0 4em 0;
124 padding-top: 2em;
125}
126
127table {
128 width: 100%;
129 margin: 1em 0;
130 border-radius: 6px;
131 border: 1px solid #e1e4e8;
132 overflow: hidden;
133 border-collapse: separate;
134 border-spacing: 0;
135}
136
137table thead {
138 background-color: #f6f8fa;
139}
140
141table tbody {
142 background-color: #ffffff;
143}
144
145table th,
146table td {
147 padding: 0.75em;
148 text-align: left;
149 border-right: 1px solid #e1e4e8;
150 border-bottom: 1px solid #e1e4e8;
151}
152
153table th:last-child,
154table td:last-child {
155 border-right: none;
156}
157
158table tbody tr:last-child td {
159 border-bottom: none;
160}
161
162table th {
163 font-weight: 600;
164 background-color: #f6f8fa;
165}
166
167table code {
168 white-space: nowrap;
169}
170
171</style>
172</head>
173<body>
174<div id="banner">
175<div id="rainbar"></div>
176<div id="logobar">
177<svg class="logo" role="img" height="32" width="32" viewBox="0 0 700 700">
178<polygon fill="#cb0000" points="0,700 700,700 700,0 0,0"></polygon>
179<polygon fill="#ffffff" points="150,550 350,550 350,250 450,250 450,550 550,550 550,150 150,150"></polygon>
180</svg>
181<div class="title">
182npm command-line interface
183</div>
184</div>
185</div>
186
187<section id="content">
188<header class="title">
189<h1 id="----npm-version----11121">
190 <span>npm-version</span>
191 <span class="version">@11.12.1</span>
192</h1>
193<span class="description">Bump a package version</span>
194</header>
195
196<section id="table_of_contents">
197<h2 id="table-of-contents">Table of contents</h2>
198<div id="_table_of_contents"><ul><li><a href="#synopsis">Synopsis</a></li><li><a href="#configuration">Configuration</a></li><ul><li><a href="#allow-same-version"><code>allow-same-version</code></a></li><li><a href="#commit-hooks"><code>commit-hooks</code></a></li><li><a href="#git-tag-version"><code>git-tag-version</code></a></li><li><a href="#json"><code>json</code></a></li><li><a href="#preid"><code>preid</code></a></li><li><a href="#sign-git-tag"><code>sign-git-tag</code></a></li><li><a href="#save"><code>save</code></a></li><li><a href="#workspace"><code>workspace</code></a></li><li><a href="#workspaces"><code>workspaces</code></a></li><li><a href="#workspaces-update"><code>workspaces-update</code></a></li><li><a href="#include-workspace-root"><code>include-workspace-root</code></a></li><li><a href="#ignore-scripts"><code>ignore-scripts</code></a></li></ul><li><a href="#description">Description</a></li><li><a href="#see-also">See Also</a></li></ul></div>
199</section>
200
201<div id="_content"><h3 id="synopsis">Synopsis</h3>
202<pre><code class="language-bash">npm version [<newversion> | major | minor | patch | premajor | preminor | prepatch | prerelease | from-git]
203
204alias: verison
205</code></pre>
206<h3 id="configuration">Configuration</h3>
207<h4 id="allow-same-version"><code>allow-same-version</code></h4>
208<ul>
209<li>Default: false</li>
210<li>Type: Boolean</li>
211</ul>
212<p>Prevents throwing an error when <code>npm version</code> is used to set the new version
213to the same value as the current version.</p>
214<h4 id="commit-hooks"><code>commit-hooks</code></h4>
215<ul>
216<li>Default: true</li>
217<li>Type: Boolean</li>
218</ul>
219<p>Run git commit hooks when using the <code>npm version</code> command.</p>
220<h4 id="git-tag-version"><code>git-tag-version</code></h4>
221<ul>
222<li>Default: true</li>
223<li>Type: Boolean</li>
224</ul>
225<p>Tag the commit when using the <code>npm version</code> command. Setting this to false
226results in no commit being made at all.</p>
227<h4 id="json"><code>json</code></h4>
228<ul>
229<li>Default: false</li>
230<li>Type: Boolean</li>
231</ul>
232<p>Whether or not to output JSON data, rather than the normal output.</p>
233<ul>
234<li>In <code>npm pkg set</code> it enables parsing set values with JSON.parse() before
235saving them to your <code>package.json</code>.</li>
236</ul>
237<p>Not supported by all npm commands.</p>
238<h4 id="preid"><code>preid</code></h4>
239<ul>
240<li>Default: ""</li>
241<li>Type: String</li>
242</ul>
243<p>The "prerelease identifier" to use as a prefix for the "prerelease" part of
244a semver. Like the <code>rc</code> in <code>1.2.0-rc.8</code>.</p>
245<h4 id="sign-git-tag"><code>sign-git-tag</code></h4>
246<ul>
247<li>Default: false</li>
248<li>Type: Boolean</li>
249</ul>
250<p>If set to true, then the <code>npm version</code> command will tag the version using
251<code>-s</code> to add a signature.</p>
252<p>Note that git requires you to have set up GPG keys in your git configs for
253this to work properly.</p>
254<h4 id="save"><code>save</code></h4>
255<ul>
256<li>Default: <code>true</code> unless when using <code>npm update</code> where it defaults to <code>false</code></li>
257<li>Type: Boolean</li>
258</ul>
259<p>Save installed packages to a <code>package.json</code> file as dependencies.</p>
260<p>When used with the <code>npm rm</code> command, removes the dependency from
261<code>package.json</code>.</p>
262<p>Will also prevent writing to <code>package-lock.json</code> if set to <code>false</code>.</p>
263<h4 id="workspace"><code>workspace</code></h4>
264<ul>
265<li>Default:</li>
266<li>Type: String (can be set multiple times)</li>
267</ul>
268<p>Enable running a command in the context of the configured workspaces of the
269current project while filtering by running only the workspaces defined by
270this configuration option.</p>
271<p>Valid values for the <code>workspace</code> config are either:</p>
272<ul>
273<li>Workspace names</li>
274<li>Path to a workspace directory</li>
275<li>Path to a parent workspace directory (will result in selecting all
276workspaces within that folder)</li>
277</ul>
278<p>When set for the <code>npm init</code> command, this may be set to the folder of a
279workspace which does not yet exist, to create the folder and set it up as a
280brand new workspace within the project.</p>
281<p>This value is not exported to the environment for child processes.</p>
282<h4 id="workspaces"><code>workspaces</code></h4>
283<ul>
284<li>Default: null</li>
285<li>Type: null or Boolean</li>
286</ul>
287<p>Set to true to run the command in the context of <strong>all</strong> configured
288workspaces.</p>
289<p>Explicitly setting this to false will cause commands like <code>install</code> to
290ignore workspaces altogether. When not set explicitly:</p>
291<ul>
292<li>Commands that operate on the <code>node_modules</code> tree (install, update, etc.)
293will link workspaces into the <code>node_modules</code> folder. - Commands that do
294other things (test, exec, publish, etc.) will operate on the root project,
295<em>unless</em> one or more workspaces are specified in the <code>workspace</code> config.</li>
296</ul>
297<p>This value is not exported to the environment for child processes.</p>
298<h4 id="workspaces-update"><code>workspaces-update</code></h4>
299<ul>
300<li>Default: true</li>
301<li>Type: Boolean</li>
302</ul>
303<p>If set to true, the npm cli will run an update after operations that may
304possibly change the workspaces installed to the <code>node_modules</code> folder.</p>
305<h4 id="include-workspace-root"><code>include-workspace-root</code></h4>
306<ul>
307<li>Default: false</li>
308<li>Type: Boolean</li>
309</ul>
310<p>Include the workspace root when workspaces are enabled for a command.</p>
311<p>When false, specifying individual workspaces via the <code>workspace</code> config, or
312all workspaces via the <code>workspaces</code> flag, will cause npm to operate only on
313the specified workspaces, and not on the root project.</p>
314<p>This value is not exported to the environment for child processes.</p>
315<h4 id="ignore-scripts"><code>ignore-scripts</code></h4>
316<ul>
317<li>Default: false</li>
318<li>Type: Boolean</li>
319</ul>
320<p>If true, npm does not run scripts specified in package.json files.</p>
321<p>Note that commands explicitly intended to run a particular script, such as
322<code>npm start</code>, <code>npm stop</code>, <code>npm restart</code>, <code>npm test</code>, and <code>npm run</code> will still
323run their intended script if <code>ignore-scripts</code> is set, but they will <em>not</em>
324run any pre- or post-scripts.</p>
325<h3 id="description">Description</h3>
326<p>Run this in a package directory to bump the version and write the new data back to <code>package.json</code>, <code>package-lock.json</code>, and, if present,
327<code>npm-shrinkwrap.json</code>.</p>
328<p>The <code>newversion</code> argument should be a valid semver string, a valid second argument to <a href="https://github.com/npm/node-semver#functions">semver.inc</a> (one of <code>patch</code>, <code>minor</code>, <code>major</code>, <code>prepatch</code>, <code>preminor</code>, <code>premajor</code>, <code>prerelease</code>), or <code>from-git</code>.
329In the second case, the existing version will be incremented by 1 in the specified field.
330<code>from-git</code> will try to read the latest git tag, and use that as the new npm version.</p>
331<p><strong>Note:</strong> If the current version is a prerelease version, <code>patch</code> will simply remove the prerelease suffix without incrementing the patch version number. For example, <code>1.2.0-5</code> becomes <code>1.2.0</code> with <code>npm version patch</code>, not <code>1.2.1</code>.</p>
332<p>If run in a git repo, it will also create a version commit and tag.
333This behavior is controlled by <code>git-tag-version</code> (see below), and can be disabled on the command line by running <code>npm --no-git-tag-version version</code>.
334It will fail if the working directory is not clean, unless the <code>-f</code> or <code>--force</code> flag is set.</p>
335<p><strong>Note:</strong> Git integration requires a reasonably recent version of git (2.0.0 or later is recommended). If you encounter issues with git commands, ensure your git installation is up to date.</p>
336<p>If supplied with <code>-m</code> or <a href="../using-npm/config#message.html"><code>--message</code> config</a> option, npm will use it as a commit message when creating a version commit.
337If the <code>message</code> config contains <code>%s</code> then that will be replaced with the resulting version number.
338For example:</p>
339<pre><code class="language-bash">npm version patch -m "Upgrade to %s for reasons"
340</code></pre>
341<p>If the <a href="../using-npm/config#sign-git-tag.html"><code>sign-git-tag</code> config</a> is set, then the tag will be signed using the <code>-s</code> flag to git.
342Note that you must have a default GPG key set up in your git config for this to work properly.
343For example:</p>
344<pre><code class="language-bash">$ npm config set sign-git-tag true
345$ npm version patch
346
347You need a passphrase to unlock the secret key for user: "isaacs (http://blog.izs.me/) <i@izs.me>"
3482048-bit RSA key, ID 6C481CF6, created 2010-08-31
349
350Enter passphrase:
351</code></pre>
352<p>If <code>preversion</code>, <code>version</code>, or <code>postversion</code> are in the <code>scripts</code> property of the package.json, they will be executed as part of running <code>npm version</code>.</p>
353<p>The exact order of execution is as follows:</p>
354<ol>
355<li>Check to make sure the git working directory is clean before we get started.
356Your scripts may add files to the commit in future steps.
357This step is skipped if the <code>--force</code> flag is set.</li>
358<li>Run the <code>preversion</code> script.
359These scripts have access to the old <code>version</code> in package.json.
360A typical use would be running your full test suite before deploying.
361Any files you want added to the commit should be explicitly added using <code>git add</code>.</li>
362<li>Bump <code>version</code> in <code>package.json</code> as requested (<code>patch</code>, <code>minor</code>, <code>major</code>, etc).</li>
363<li>Run the <code>version</code> script.
364These scripts have access to the new <code>version</code> in package.json (so they can incorporate it into file headers in generated files for example).
365Again, scripts should explicitly add generated files to the commit using <code>git add</code>.</li>
366<li>Commit and tag.</li>
367<li>Run the <code>postversion</code> script.
368Use it to clean up the file system or automatically push the commit and/or tag.</li>
369</ol>
370<p>Take the following example:</p>
371<pre><code class="language-json">{
372 "scripts": {
373 "preversion": "npm test",
374 "version": "npm run build && git add -A dist",
375 "postversion": "git push && git push --tags && rm -rf build/temp"
376 }
377}
378</code></pre>
379<p>This runs all your tests and proceeds only if they pass.
380Then runs your <code>build</code> script, and adds everything in the <code>dist</code> directory to the commit.
381After the commit, it pushes the new commit and tag up to the server, and deletes the <code>build/temp</code> directory.</p>
382<h3 id="see-also">See Also</h3>
383<ul>
384<li><a href="../commands/npm-init.html">npm init</a></li>
385<li><a href="../commands/npm-run.html">npm run</a></li>
386<li><a href="../using-npm/scripts.html">npm scripts</a></li>
387<li><a href="../configuring-npm/package-json.html">package.json</a></li>
388<li><a href="../using-npm/config.html">config</a></li>
389</ul></div>
390
391<footer id="edit">
392<a href="https://github.com/npm/cli/edit/latest/docs/lib/content/commands/npm-version.md">
393<svg role="img" viewBox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;">
394<path fill-rule="evenodd" d="M11.013 1.427a1.75 1.75 0 012.474 0l1.086 1.086a1.75 1.75 0 010 2.474l-8.61 8.61c-.21.21-.47.364-.756.445l-3.251.93a.75.75 0 01-.927-.928l.929-3.25a1.75 1.75 0 01.445-.758l8.61-8.61zm1.414 1.06a.25.25 0 00-.354 0L10.811 3.75l1.439 1.44 1.263-1.263a.25.25 0 000-.354l-1.086-1.086zM11.189 6.25L9.75 4.81l-6.286 6.287a.25.25 0 00-.064.108l-.558 1.953 1.953-.558a.249.249 0 00.108-.064l6.286-6.286z"></path>
395</svg>
396Edit this page on GitHub
397</a>
398</footer>
399</section>
400
401
402
403</body></html>