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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
|
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
.TH "NPM\-DEVELOPERS" "1" "August 2010" "" ""
.
.SH "NAME"
\fBnpm-developers\fR \-\- Developer Guide
.
.SH "DESCRIPTION"
So, you\'ve decided to use npm to publish your project\.
.
.P
Fantastic!
.
.P
There are a few things that you need to do above the simple steps
that your users will do to install your program\.
.
.SH "About These Documents"
These are man pages\. If you install npm, you should be able to
then do \fBman npm\-thing\fR to get the documentation on a particular
topic\.
.
.P
Any time you see "see npm\-whatever(1)", you can do \fBman npm\-whatever\fR
to get at the docs\.
.
.SH "The package\.json File"
You need to have a \fBpackage\.json\fR file in the root of your project\.
.
.P
See npm\-json(1) for details about what goes in that file\. At the very
least, you need:
.
.IP "\(bu" 4
name:
This should be a string that identifies your project\. Please do not
use the name to specify that it runs on node, or is in JavaScript\.
You can use the "engines" field to explicitly state the versions of
node (or whatever else) that your program requires, and it\'s pretty
well assumed that it\'s javascript\.
.
.IP
It does not necessarily need to match your github repository name\.
.
.IP
So, \fBnode\-foo\fR and \fBbar\-js\fR are bad names\. \fBfoo\fR or \fBbar\fR are better\.
.
.IP "\(bu" 4
version:
A semver\-compatible version\.
.
.IP "\(bu" 4
engines:
Specify the versions of node (or whatever else) that your program
runs on\. The node API changes a lot, and there may be bugs or new
functionality that you depend on\. Be explicit\.
.
.IP "\(bu" 4
author:
Take some credit\.
.
.IP "\(bu" 4
scripts:
If you have a special compilation or installation script, then you
should put it in the \fBscripts\fR hash\. See npm\-scripts(1)\.
.
.IP "\(bu" 4
main:
If you have a single module that serves as the entry point to your
program (like what the "foo" package gives you at require("foo")),
then you need to specify that in the "main" field\.
.
.IP "" 0
.
.SH "Make Sure Your Package Installs and Works"
\fBThis is important\.\fR
.
.P
If you can not install it locally, you\'ll have
problems trying to publish it\. Or, worse yet, you\'ll be able to
publish it, but you\'ll be publishing a broken or pointless package\.
So don\'t do that\.
.
.P
In the root of your package, do this:
.
.IP "" 4
.
.nf
npm install \.
.
.fi
.
.IP "" 0
.
.P
That\'ll show you that it\'s working\. If you\'d rather just create a symlink
package that points to your working directory, then do this:
.
.IP "" 4
.
.nf
npm link \.
.
.fi
.
.IP "" 0
.
.P
Use \fBnpm ls installed\fR to see if it\'s there\.
.
.P
Then go into the node\-repl, and try using require() to bring in your module\'s
main and libs things\. Assuming that you have a package like this:
.
.IP "" 4
.
.nf
node_foo/
lib/
foo\.js
bar\.js
.
.fi
.
.IP "" 0
.
.P
and you define your package\.json with this in it:
.
.IP "" 4
.
.nf
{ "name" : "foo"
, "directories" : { "lib" : "\./lib" }
, "main" : "\./lib/foo"
}
.
.fi
.
.IP "" 0
.
.P
then you\'d want to make sure that require("foo") and require("foo/bar") both
work and bring in the appropriate modules\.
.
.SH "Compile Node with OpenSSL"
npm will stubbornly refuse to expose your password in the clear\. That
means that you\'ll have to install whatever package provides openssl\.h
on your system\. When you \fB\|\./configure\fR node, make sure that it says:
.
.IP "" 4
.
.nf
Checking for openssl : yes
.
.fi
.
.IP "" 0
.
.SH "Create a User Account"
Create a user with the adduser command\. It works like this:
.
.IP "" 4
.
.nf
npm adduser bob password bob@email\.com
.
.fi
.
.IP "" 0
.
.P
This is documented better in npm\-adduser(1)\. So do this to get the
details:
.
.IP "" 4
.
.nf
man npm\-adduser
.
.fi
.
.IP "" 0
.
.SH "Publish your package"
This part\'s easy\.
.
.IP "" 4
.
.nf
npm publish /path/to/my\-package
.
.fi
.
.IP "" 0
.
.P
You can give publish a url to a tarball, or a filename of a tarball,
or a path to a folder\. (Paths have to either be "\." or contain a "/"\.)
.
.SH "Tag your package as "stable""
This makes it easier to install without your users having to know the
version ahead of time\.
.
.IP "" 4
.
.nf
npm tag my\-package@1\.2\.3 stable
.
.fi
.
.IP "" 0
.
.P
You can also use other tags, but "stable" and "latest" have reserved
meanings\.
.
.SH "Brag about it"
Send emails, write blogs, blab in IRC\.
.
.P
Tell the world how easy it is to install your program!
|
