org.simantics.maps.server/node/node-v4.8.0-win-x64/node_modules/npm/html/doc/misc/npm-scope.html

   1 <!doctype html>
   2 <html>
   3   <title>npm-scope</title>
   4   <meta charset="utf-8">
   5   <link rel="stylesheet" type="text/css" href="../../static/style.css">
   6   <link rel="canonical" href="https://www.npmjs.org/doc/misc/npm-scope.html">
   7   <script async=true src="../../static/toc.js"></script>
   8
   9   <body>
  10     <div id="wrapper">
  11
  12 <h1><a href="../misc/npm-scope.html">npm-scope</a></h1> <p>Scoped packages</p>
  13 <h2 id="description">DESCRIPTION</h2>
  14 <p>All npm packages have a name. Some package names also have a scope. A scope
  15 follows the usual rules for package names (url-safe characters, no leading dots
  16 or underscores). When used in package names, preceded by an @-symbol and
  17 followed by a slash, e.g.</p>
  18 <pre><code>@somescope/somepackagename
  19 </code></pre><p>Scopes are a way of grouping related packages together, and also affect a few
  20 things about the way npm treats the package.</p>
  21 <p>Scoped packages can be published and installed as of <code>npm@2</code> and are supported
  22 by the primary npm registry. The npm client is backwards-compatible with
  23 un-scoped registries, so it can be used to work with scoped and un-scoped
  24 registries at the same time.</p>
  25 <h2 id="installing-scoped-packages">Installing scoped packages</h2>
  26 <p>Scoped packages are installed to a sub-folder of the regular installation
  27 folder, e.g. if your other packages are installed in <code>node_modules/packagename</code>,
  28 scoped modules will be in <code>node_modules/@myorg/packagename</code>. The scope folder
  29 (<code>@myorg</code>) is simply the name of the scope preceded by an @-symbol, and can
  30 contain any number of scoped packages.</p>
  31 <p>A scoped package is installed by referencing it by name, preceded by an
  32 @-symbol, in <code>npm install</code>:</p>
  33 <pre><code>npm install @myorg/mypackage
  34 </code></pre><p>Or in <code>package.json</code>:</p>
  35 <pre><code>&quot;dependencies&quot;: {
  36   &quot;@myorg/mypackage&quot;: &quot;^1.3.0&quot;
  37 }
  38 </code></pre><p>Note that if the @-symbol is omitted in either case npm will instead attempt to
  39 install from GitHub; see <code><a href="../cli/npm-install.html">npm-install(1)</a></code>.</p>
  40 <h2 id="requiring-scoped-packages">Requiring scoped packages</h2>
  41 <p>Because scoped packages are installed into a scope folder, you have to
  42 include the name of the scope when requiring them in your code, e.g.</p>
  43 <pre><code>require(&#39;@myorg/mypackage&#39;)
  44 </code></pre><p>There is nothing special about the way Node treats scope folders, this is
  45 just specifying to require the module <code>mypackage</code> in the folder called <code>@myorg</code>.</p>
  46 <h2 id="publishing-scoped-packages">Publishing scoped packages</h2>
  47 <p>Scoped packages can be published from the CLI as of <code>npm@2</code> and can be
  48 published to any registry that supports them, including the primary npm
  49 registry.</p>
  50 <p>(As of 2015-04-19, and with npm 2.0 or newer, the primary npm registry <strong>does</strong>
  51 support scoped packages)</p>
  52 <p>If you wish, you may associate a scope with a registry; see below.</p>
  53 <h3 id="publishing-public-scoped-packages-to-the-primary-npm-registry">Publishing public scoped packages to the primary npm registry</h3>
  54 <p>To publish a public scoped package, you must specify <code>--access public</code> with
  55 the initial publication.  This will publish the package and set access
  56 to <code>public</code> as if you had run <code>npm access public</code> after publishing.</p>
  57 <h3 id="publishing-private-scoped-packages-to-the-npm-registry">Publishing private scoped packages to the npm registry</h3>
  58 <p>To publish a private scoped package to the npm registry, you must have
  59 an <a href="https://www.npmjs.com/private-modules">npm Private Modules</a>
  60 account.</p>
  61 <p>You can then publish the module with <code>npm publish</code> or <code>npm publish
  62 --access restricted</code>, and it will be present in the npm registry, with
  63 restricted access.  You can then change the access permissions, if
  64 desired, with <code>npm access</code> or on the npmjs.com website.</p>
  65 <h2 id="associating-a-scope-with-a-registry">Associating a scope with a registry</h2>
  66 <p>Scopes can be associated with a separate registry. This allows you to
  67 seamlessly use a mix of packages from the primary npm registry and one or more
  68 private registries, such as npm Enterprise.</p>
  69 <p>You can associate a scope with a registry at login, e.g.</p>
  70 <pre><code>npm login --registry=http://reg.example.com --scope=@myco
  71 </code></pre><p>Scopes have a many-to-one relationship with registries: one registry can
  72 host multiple scopes, but a scope only ever points to one registry.</p>
  73 <p>You can also associate a scope with a registry using <code>npm config</code>:</p>
  74 <pre><code>npm config set @myco:registry http://reg.example.com
  75 </code></pre><p>Once a scope is associated with a registry, any <code>npm install</code> for a package
  76 with that scope will request packages from that registry instead. Any
  77 <code>npm publish</code> for a package name that contains the scope will be published to
  78 that registry instead.</p>
  79 <h2 id="see-also">SEE ALSO</h2>
  80 <ul>
  81 <li><a href="../cli/npm-install.html">npm-install(1)</a></li>
  82 <li><a href="../cli/npm-publish.html">npm-publish(1)</a></li>
  83 <li><a href="../cli/npm-access.html">npm-access(1)</a></li>
  84 </ul>
  85
  86 </div>
  87
  88 <table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
  89 <tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18>&nbsp;</td></tr>
  90 <tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)">&nbsp;</td><td style="width:40px;height:10px;background:#fff" colspan=4>&nbsp;</td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4>&nbsp;</td><td style="width:40px;height:10px;background:#fff" colspan=4>&nbsp;</td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)">&nbsp;</td><td colspan=6 style="width:60px;height:10px;background:#fff">&nbsp;</td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4>&nbsp;</td></tr>
  91 <tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3>&nbsp;</td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3>&nbsp;</td><td style="width:10px;height:10px;background:#fff" rowspan=3>&nbsp;</td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2>&nbsp;</td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2>&nbsp;</td><td style="width:10px;height:10px;background:#fff" rowspan=3>&nbsp;</td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2>&nbsp;</td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3>&nbsp;</td><td style="width:10px;height:10px;background:#fff" rowspan=3>&nbsp;</td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3>&nbsp;</td></tr>
  92 <tr><td style="width:10px;height:10px;background:#fff" rowspan=2>&nbsp;</td></tr>
  93 <tr><td style="width:10px;height:10px;background:#fff">&nbsp;</td></tr>
  94 <tr><td style="width:60px;height:10px;background:rgb(237,127,127)" colspan=6>&nbsp;</td><td colspan=10 style="width:10px;height:10px;background:rgb(237,127,127)">&nbsp;</td></tr>
  95 <tr><td colspan=5 style="width:50px;height:10px;background:#fff">&nbsp;</td><td style="width:40px;height:10px;background:rgb(237,127,127)" colspan=4>&nbsp;</td><td style="width:90px;height:10px;background:#fff" colspan=9>&nbsp;</td></tr>
  96 </table>
  97 <p id="footer">npm-scope &mdash; npm@2.15.11</p>
  98