Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Features
Speaker Deck
PRO
Sign in
Sign up for free
Search
Search
The Ins-and-Outs of Publishing a Module to npm
Search
Steve Kinney
July 30, 2016
2
130
The Ins-and-Outs of Publishing a Module to npm
Steve Kinney
July 30, 2016
Tweet
Share
More Decks by Steve Kinney
See All by Steve Kinney
Web Security, Frontend Masters
stevekinney
0
190
Making Music with the Web Audio API, JSConf Colombia 2023
stevekinney
0
37
React and TypeScript, Turing School
stevekinney
0
180
Redux Workshop, 2021-05-05
stevekinney
2
1.9k
TypeScript and React Utility Types
stevekinney
1
170
A Gentle Introduction to GraphQL Resolvers
stevekinney
1
140
React State
stevekinney
11
10k
React State: useEffect and Custom Hooks
stevekinney
0
210
Building Modular Frontend Architectures
stevekinney
1
420
Featured
See All Featured
Reflections from 52 weeks, 52 projects
jeffersonlam
346
19k
The Straight Up "How To Draw Better" Workshop
denniskardys
229
130k
From Idea to $5000 a Month in 5 Months
shpigford
377
46k
YesSQL, Process and Tooling at Scale
rocio
166
14k
In The Pink: A Labor of Love
frogandcode
139
22k
Git: the NoSQL Database
bkeepers
PRO
423
64k
Adopting Sorbet at Scale
ufuk
71
8.8k
Designing for humans not robots
tammielis
247
25k
A better future with KSS
kneath
231
17k
Statistics for Hackers
jakevdp
792
220k
How to Create Impact in a Changing Tech Landscape [PerfNow 2023]
tammyeverts
34
1.9k
Build your cross-platform service in a week with App Engine
jlugia
227
17k
Transcript
None
I'm Steve. @stevekinney
I'm Steve. @stevekinney
http://turing.io
http://bit.ly/electronjs
Once upon a time…
None
None
None
“How did you get permission to publish a module on
npm?”
>250,000 registered users
~4.5 million estimated users
~84,000 have ever published a module
1.8%
None
Let's make a little module for working with rectangles.
None
None
None
Option A: Scoped modules.
@stevekinney/rectangle
Option B: Get creative.
None
None
None
None
None
None
All you have to do is make yourself a package.json.
“Steve, JSON is tedious. I'm afraid.”
Fair enough.
None
None
None
None
None
None
None
None
None
None
None
None
None
None
None
None
None
None
None
None
None
Do I seriously have to type my name in every
single time?
Nope.
None
None
None
None
None
None
None
None
None
None
None
But, I really don't want to have to go get
the URL for my Git repository.
Good news! You don't have to, necessarily.
None
None
None
None
None
None
None
None
None
None
None
None
None
None
None
“I'm going to be honest with you, Steve. I just
keep hitting enter—can I just skip all of this?”
--yes
None
None
None
None
None
None
None
None
Remember: This code is going to be used by other
people. Write tests, please.
Remember: This code is going to be used by other
people. Write tests, please.
None
None
None
None
None
None
None
None
None
None
None
None
None
None
None
None
None
None
None
None
None
None
None
What if we wanted to get fancy?
None
None
None
Cool story, but the boss comes in and reminds you
that Node 0.10 is a thing.
None
None
It's totally cool to write a module in your favorite
language. But, you should publish it for the widest possible audience.
None
None
None
None
None
None
You’re never going to remember to do this.
None
None
None
npm run build
You’ll probably forget to do this too.
publish test start install
publish test start install prepublish postinstall preinstall poststart prestart posttest
prestest
None
None
None
npm run sandwich
npm run sandwich presandwich
npm run sandwich presandwich postsandwich
Problem: We want to commit our fancy ES6 code to
git, but we don't need to ship it with our module.
None
None
Don't forget to include a README.
None
None
None
None
None
None
None
None
npm version
1.0.0
1.0.1 npm version patch
1.1.0 npm version minor
2.0.0 npm version major
None
None
None
None
npm publish
None
http://turing.io http://bit.ly/electronjs