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
Introduction to Testing
stevekinney
0
22
Web Security, Frontend Masters
stevekinney
0
1.1k
Making Music with the Web Audio API, JSConf Colombia 2023
stevekinney
0
55
React and TypeScript, Turing School
stevekinney
0
200
Redux Workshop, 2021-05-05
stevekinney
2
2k
TypeScript and React Utility Types
stevekinney
1
170
A Gentle Introduction to GraphQL Resolvers
stevekinney
1
150
React State
stevekinney
11
10k
React State: useEffect and Custom Hooks
stevekinney
0
220
Featured
See All Featured
Optimising Largest Contentful Paint
csswizardry
33
2.9k
Building Flexible Design Systems
yeseniaperezcruz
327
38k
The Psychology of Web Performance [Beyond Tellerrand 2023]
tammyeverts
41
2.1k
10 Git Anti Patterns You Should be Aware of
lemiorhan
654
59k
A better future with KSS
kneath
238
17k
The Cost Of JavaScript in 2023
addyosmani
45
6.6k
Agile that works and the tools we love
rasmusluckow
327
21k
What’s in a name? Adding method to the madness
productmarketing
PRO
22
3.1k
Measuring & Analyzing Core Web Vitals
bluesmoon
1
40
Building a Scalable Design System with Sketch
lauravandoore
459
33k
A Modern Web Designer's Workflow
chriscoyier
692
190k
Keith and Marios Guide to Fast Websites
keithpitt
408
22k
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