npm-set-script.html 6.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239
  1. <html><head>
  2. <title>npm-set-script</title>
  3. <style>
  4. body {
  5. background-color: #ffffff;
  6. color: #24292e;
  7. margin: 0;
  8. line-height: 1.5;
  9. font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji";
  10. }
  11. #rainbar {
  12. height: 10px;
  13. background-image: linear-gradient(139deg, #fb8817, #ff4b01, #c12127, #e02aff);
  14. }
  15. a {
  16. text-decoration: none;
  17. color: #0366d6;
  18. }
  19. a:hover {
  20. text-decoration: underline;
  21. }
  22. pre {
  23. margin: 1em 0px;
  24. padding: 1em;
  25. border: solid 1px #e1e4e8;
  26. border-radius: 6px;
  27. display: block;
  28. overflow: auto;
  29. white-space: pre;
  30. background-color: #f6f8fa;
  31. color: #393a34;
  32. }
  33. code {
  34. font-family: SFMono-Regular, Consolas, "Liberation Mono", Menlo, Courier, monospace;
  35. font-size: 85%;
  36. padding: 0.2em 0.4em;
  37. background-color: #f6f8fa;
  38. color: #393a34;
  39. }
  40. pre > code {
  41. padding: 0;
  42. background-color: inherit;
  43. color: inherit;
  44. }
  45. h1, h2, h3 {
  46. font-weight: 600;
  47. }
  48. #logobar {
  49. background-color: #333333;
  50. margin: 0 auto;
  51. padding: 1em 4em;
  52. }
  53. #logobar .logo {
  54. float: left;
  55. }
  56. #logobar .title {
  57. font-weight: 600;
  58. color: #dddddd;
  59. float: left;
  60. margin: 5px 0 0 1em;
  61. }
  62. #logobar:after {
  63. content: "";
  64. display: block;
  65. clear: both;
  66. }
  67. #content {
  68. margin: 0 auto;
  69. padding: 0 4em;
  70. }
  71. #table_of_contents > h2 {
  72. font-size: 1.17em;
  73. }
  74. #table_of_contents ul:first-child {
  75. border: solid 1px #e1e4e8;
  76. border-radius: 6px;
  77. padding: 1em;
  78. background-color: #f6f8fa;
  79. color: #393a34;
  80. }
  81. #table_of_contents ul {
  82. list-style-type: none;
  83. padding-left: 1.5em;
  84. }
  85. #table_of_contents li {
  86. font-size: 0.9em;
  87. }
  88. #table_of_contents li a {
  89. color: #000000;
  90. }
  91. header.title {
  92. border-bottom: solid 1px #e1e4e8;
  93. }
  94. header.title > h1 {
  95. margin-bottom: 0.25em;
  96. }
  97. header.title > .description {
  98. display: block;
  99. margin-bottom: 0.5em;
  100. line-height: 1;
  101. }
  102. footer#edit {
  103. border-top: solid 1px #e1e4e8;
  104. margin: 3em 0 4em 0;
  105. padding-top: 2em;
  106. }
  107. </style>
  108. </head>
  109. <body>
  110. <div id="banner">
  111. <div id="rainbar"></div>
  112. <div id="logobar">
  113. <svg class="logo" role="img" height="32" width="32" viewBox="0 0 700 700">
  114. <polygon fill="#cb0000" points="0,700 700,700 700,0 0,0"></polygon>
  115. <polygon fill="#ffffff" points="150,550 350,550 350,250 450,250 450,550 550,550 550,150 150,150"></polygon>
  116. </svg>
  117. <div class="title">
  118. npm command-line interface
  119. </div>
  120. </div>
  121. </div>
  122. <section id="content">
  123. <header class="title">
  124. <h1 id="npm-set-script">npm-set-script</h1>
  125. <span class="description">Set tasks in the scripts section of package.json</span>
  126. </header>
  127. <section id="table_of_contents">
  128. <h2 id="table-of-contents">Table of contents</h2>
  129. <div id="_table_of_contents"><ul><li><a href="#synopsis">Synopsis</a></li><li><a href="#configuration">Configuration</a></li><ul><li><a href="#workspace"><code>workspace</code></a></li><li><a href="#workspaces"><code>workspaces</code></a></li><li><a href="#include-workspace-root"><code>include-workspace-root</code></a></li></ul><li><a href="#see-also">See Also</a></li></ul></div>
  130. </section>
  131. <div id="_content"><h3 id="synopsis">Synopsis</h3>
  132. <p>An npm command that lets you create a task in the <code>scripts</code> section of the <code>package.json</code>.</p>
  133. <pre lang="bash"><code>npm set-script [&lt;script&gt;] [&lt;command&gt;]
  134. </code></pre>
  135. <p><strong>Example:</strong></p>
  136. <ul>
  137. <li><code>npm set-script start "http-server ."</code></li>
  138. </ul>
  139. <pre lang="json"><code>{
  140. "name": "my-project",
  141. "scripts": {
  142. "start": "http-server .",
  143. "test": "some existing value"
  144. }
  145. }
  146. </code></pre>
  147. <h3 id="configuration">Configuration</h3>
  148. <!-- raw HTML omitted -->
  149. <!-- raw HTML omitted -->
  150. <!-- raw HTML omitted -->
  151. <h4 id="workspace"><code>workspace</code></h4>
  152. <ul>
  153. <li>Default:</li>
  154. <li>Type: String (can be set multiple times)</li>
  155. </ul>
  156. <p>Enable running a command in the context of the configured workspaces of the
  157. current project while filtering by running only the workspaces defined by
  158. this configuration option.</p>
  159. <p>Valid values for the <code>workspace</code> config are either:</p>
  160. <ul>
  161. <li>Workspace names</li>
  162. <li>Path to a workspace directory</li>
  163. <li>Path to a parent workspace directory (will result in selecting all
  164. workspaces within that folder)</li>
  165. </ul>
  166. <p>When set for the <code>npm init</code> command, this may be set to the folder of a
  167. workspace which does not yet exist, to create the folder and set it up as a
  168. brand new workspace within the project.</p>
  169. <p>This value is not exported to the environment for child processes.</p>
  170. <!-- raw HTML omitted -->
  171. <!-- raw HTML omitted -->
  172. <h4 id="workspaces"><code>workspaces</code></h4>
  173. <ul>
  174. <li>Default: null</li>
  175. <li>Type: null or Boolean</li>
  176. </ul>
  177. <p>Set to true to run the command in the context of <strong>all</strong> configured
  178. workspaces.</p>
  179. <p>Explicitly setting this to false will cause commands like <code>install</code> to
  180. ignore workspaces altogether. When not set explicitly:</p>
  181. <ul>
  182. <li>Commands that operate on the <code>node_modules</code> tree (install, update, etc.)
  183. will link workspaces into the <code>node_modules</code> folder. - Commands that do
  184. other things (test, exec, publish, etc.) will operate on the root project,
  185. <em>unless</em> one or more workspaces are specified in the <code>workspace</code> config.</li>
  186. </ul>
  187. <p>This value is not exported to the environment for child processes.</p>
  188. <!-- raw HTML omitted -->
  189. <!-- raw HTML omitted -->
  190. <h4 id="include-workspace-root"><code>include-workspace-root</code></h4>
  191. <ul>
  192. <li>Default: false</li>
  193. <li>Type: Boolean</li>
  194. </ul>
  195. <p>Include the workspace root when workspaces are enabled for a command.</p>
  196. <p>When false, specifying individual workspaces via the <code>workspace</code> config, or
  197. all workspaces via the <code>workspaces</code> flag, will cause npm to operate only on
  198. the specified workspaces, and not on the root project.</p>
  199. <!-- raw HTML omitted -->
  200. <!-- raw HTML omitted -->
  201. <!-- raw HTML omitted -->
  202. <h3 id="see-also">See Also</h3>
  203. <ul>
  204. <li><a href="../commands/npm-run-script.html">npm run-script</a></li>
  205. <li><a href="../commands/npm-install.html">npm install</a></li>
  206. <li><a href="../commands/npm-test.html">npm test</a></li>
  207. <li><a href="../commands/npm-start.html">npm start</a></li>
  208. </ul>
  209. </div>
  210. <footer id="edit">
  211. <a href="https://github.com/npm/cli/edit/latest/docs/content/commands/npm-set-script.md">
  212. <svg role="img" viewBox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;">
  213. <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>
  214. </svg>
  215. Edit this page on GitHub
  216. </a>
  217. </footer>
  218. </section>
  219. </body></html>