forked from nodejs/node
-
Notifications
You must be signed in to change notification settings - Fork 1
/
scope.7
155 lines (153 loc) · 5.31 KB
/
scope.7
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
.TH "SCOPE" "7" "September 2022" "" ""
.SH "NAME"
\fBscope\fR \- Scoped packages
.SS Description
.P
All npm packages have a name\. Some package names also have a scope\. A scope
follows the usual rules for package names (URL\-safe characters, no leading dots
or underscores)\. When used in package names, scopes are preceded by an \fB@\fP symbol
and followed by a slash, e\.g\.
.P
.RS 2
.nf
@somescope/somepackagename
.fi
.RE
.P
Scopes are a way of grouping related packages together, and also affect a few
things about the way npm treats the package\.
.P
Each npm user/organization has their own scope, and only you can add packages
in your scope\. This means you don't have to worry about someone taking your
package name ahead of you\. Thus it is also a good way to signal official packages
for organizations\.
.P
Scoped packages can be published and installed as of \fBnpm@2\fP and are supported
by the primary npm registry\. Unscoped packages can depend on scoped packages and
vice versa\. The npm client is backwards\-compatible with unscoped registries,
so it can be used to work with scoped and unscoped registries at the same time\.
.SS Installing scoped packages
.P
Scoped packages are installed to a sub\-folder of the regular installation
folder, e\.g\. if your other packages are installed in \fBnode_modules/packagename\fP,
scoped modules will be installed in \fBnode_modules/@myorg/packagename\fP\|\. The scope
folder (\fB@myorg\fP) is simply the name of the scope preceded by an \fB@\fP symbol, and can
contain any number of scoped packages\.
.P
A scoped package is installed by referencing it by name, preceded by an
\fB@\fP symbol, in \fBnpm install\fP:
.P
.RS 2
.nf
npm install @myorg/mypackage
.fi
.RE
.P
Or in \fBpackage\.json\fP:
.P
.RS 2
.nf
"dependencies": {
"@myorg/mypackage": "^1\.3\.0"
}
.fi
.RE
.P
Note that if the \fB@\fP symbol is omitted, in either case, npm will instead attempt to
install from GitHub; see npm help \fBinstall\fP\|\.
.SS Requiring scoped packages
.P
Because scoped packages are installed into a scope folder, you have to
include the name of the scope when requiring them in your code, e\.g\.
.P
.RS 2
.nf
require('@myorg/mypackage')
.fi
.RE
.P
There is nothing special about the way Node treats scope folders\. This
simply requires the \fBmypackage\fP module in the folder named \fB@myorg\fP\|\.
.SS Publishing scoped packages
.P
Scoped packages can be published from the CLI as of \fBnpm@2\fP and can be
published to any registry that supports them, including the primary npm
registry\.
.P
(As of 2015\-04\-19, and with npm 2\.0 or better, the primary npm registry
\fBdoes\fR support scoped packages\.)
.P
If you wish, you may associate a scope with a registry; see below\.
.SS Publishing public scoped packages to the primary npm registry
.P
Publishing to a scope, you have two options:
.RS 0
.IP \(bu 2
Publishing to your user scope (example: \fB@username/module\fP)
.IP \(bu 2
Publishing to an organization scope (example: \fB@org/module\fP)
.RE
.P
If publishing a public module to an organization scope, you must
first either create an organization with the name of the scope
that you'd like to publish to or be added to an existing organization
with the appropriate permisssions\. For example, if you'd like to
publish to \fB@org\fP, you would need to create the \fBorg\fP organization
on npmjs\.com prior to trying to publish\.
.P
Scoped packages are not public by default\. You will need to specify
\fB\-\-access public\fP with the initial \fBnpm publish\fP command\. This will publish
the package and set access to \fBpublic\fP as if you had run \fBnpm access public\fP
after publishing\. You do not need to do this when publishing new versions of
an existing scoped package\.
.SS Publishing private scoped packages to the npm registry
.P
To publish a private scoped package to the npm registry, you must have
an npm Private Modules \fIhttps://docs\.npmjs\.com/private\-modules/intro\fR
account\.
.P
You can then publish the module with \fBnpm publish\fP or \fBnpm publish
\-\-access restricted\fP, and it will be present in the npm registry, with
restricted access\. You can then change the access permissions, if
desired, with \fBnpm access\fP or on the npmjs\.com website\.
.SS Associating a scope with a registry
.P
Scopes can be associated with a separate registry\. This allows you to
seamlessly use a mix of packages from the primary npm registry and one or more
private registries, such as GitHub Packages \fIhttps://github\.com/features/packages\fR or the open source Verdaccio \fIhttps://verdaccio\.org\fR
project\.
.P
You can associate a scope with a registry at login, e\.g\.
.P
.RS 2
.nf
npm login \-\-registry=http://reg\.example\.com \-\-scope=@myco
.fi
.RE
.P
Scopes have a many\-to\-one relationship with registries: one registry can
host multiple scopes, but a scope only ever points to one registry\.
.P
You can also associate a scope with a registry using \fBnpm config\fP:
.P
.RS 2
.nf
npm config set @myco:registry http://reg\.example\.com
.fi
.RE
.P
Once a scope is associated with a registry, any \fBnpm install\fP for a package
with that scope will request packages from that registry instead\. Any
\fBnpm publish\fP for a package name that contains the scope will be published to
that registry instead\.
.SS See also
.RS 0
.IP \(bu 2
npm help install
.IP \(bu 2
npm help publish
.IP \(bu 2
npm help access
.IP \(bu 2
npm help registry
.RE