The Ins-and-Outs of Publishing a Module to npm

Transcript

2. I'm Steve. @stevekinney
3. I'm Steve. @stevekinney
4. http://turing.io
5. http://bit.ly/electronjs
6. Once upon a time…
10. “How did you get permission to publish a module on npm?”
11. >250,000
 registered users
12. ~4.5 million
 estimated users
13. ~84,000
 have ever published a module
14. 1.8%
16. Let's make a little module for working with rectangles.
20. Option A: Scoped modules.
21. @stevekinney/rectangle
22. Option B: Get creative.
29. All you have to do is make yourself a package.json.
30. “Steve, JSON is tedious. I'm afraid.”
31. Fair enough.
53. Do I seriously have to type my name in every single time?
54. Nope.
66. But, I really don't want to have to go get the URL for my Git repository.
67. Good news! You don't have to, necessarily.
83. “I'm going to be honest with you, Steve. I just keep hitting enter—can I just skip all of this?”
84. --yes
93. Remember: This code is going to be used by other people. Write tests, please.
94. Remember: This code is going to be used by other people. Write tests, please.
118. What if we wanted to get fancy?
122. Cool story, but the boss comes in and reminds you that Node 0.10 is a thing.
125. It's totally cool to write a module in your favorite language. But, you should publish it for the widest possible audience.
132. You’re never going to remember to do this.
136. npm run build
137. You’ll probably forget to do this too.
138. publish test start install
139. publish test start install prepublish postinstall preinstall poststart prestart posttest prestest
143. npm run sandwich
144. npm run sandwich presandwich
145. npm run sandwich presandwich postsandwich
146. Problem: We want to commit our fancy ES6 code to git, but we don't need to ship it with our module.
149. Don't forget to include a README.
158. npm version
159. 1.0.0
160. 1.0.1 npm version patch
161. 1.1.0 npm version minor
162. 2.0.0 npm version major
167. npm publish
169. http://turing.io http://bit.ly/electronjs