What is npm?
Recently I wrote about Node.js’s two module systems,
the traditional CommonJS module system,
and the newer ECMAScript module system.
These module systems are related to, but distinct from, package systems.
A module is a thing loaded and executed at runtime.
A package is a thing downloaded at “install time”.
Packages can provide modules.
There is only one one package system for Node.js that’s worth mentioning: NPM.
Let’s take a look.
The NPM docs
have an excellent, succinct definition of a “package”:
- a) A folder containing a program described by a
package.json file.
- b) A gzipped tarball containing (a).
- c) A URL that resolves to (b).
- d) A
<name>@<version> that is published on the registry with (c).
- e) A
<name>@<tag> that points to (d).
- f) A
<name> that has a latest tag satisfying (e).
- g) A
git url that, when cloned, results in (a).
Note that this definition does not mention “Node.js modules”.
An NPM package can contain arbitrary stuff.
For example, you can distribute CSS via NPM.
Just throw it anywhere in the folder.
The contents are limited only by the vague NPM terms of use.
Yes, you can npm install foo/bar/baz/,
a directory that contains a package.json.
The package.json just has to have name and version fields.
This adds "packagename": "file:foo/bar/baz" to your dependencies,
and creates node_modules/packagename as a symlink to it.
Yes, you can npm install tarball.tar.gz,
a gzipped tarball containing a package.json.
This adds "packagename": "file:tarball.tar.gz" to your dependencies,
and unzips the gzipped tarball into node_modules/packagename.
Yes, you can npm install http://example.com/tarball.tar.gz.
This adds "packagename": "http://example.com/tarball.tar.gz" to your dependencies,
and unzips the gzipped tarball into node_modules/packagename.
Yes, you can npm install 'git://github.com/jameshfisher/lodash.git#jims-fork'.
This adds "lodash": "git://github.com/jameshfisher/lodash.git#jims-fork" to your dependencies,
checks out the specified commit, and copies it into node_modules/lodash.
This could come in handy for maintaining your own fork of a package.
Onto more familiar territory.
When we run npm install lodash@4.17.20,
the 4.17.20 is a “version”.
This identifier maps to the URL https://registry.npmjs.org/lodash/-/lodash-4.17.20.tgz,
a raw URLs to a tarball hosted on the NPM registry.
However, NPM adds "lodash": "^4.17.20" to your dependencies,
rather than adding the raw URL.
You can query the NPM API to get the URL with:
$ curl -s https://registry.npmjs.org/lodash | jq '.versions | .["4.17.20"].dist.tarball'
"https://registry.npmjs.org/lodash/-/lodash-4.17.20.tgz"
NPM has a separate thing called “tags”
which uses the same syntax as versions.
For example, npm install jquery@beta installs the beta tag.
Currently, the beta tag maps to version 3.5.1.
NPM puts "jquery": "^3.5.1" in your dependencies,
so the fact that you installed a tag is lost.
You can see the current tag-to-version mapping with:
$ curl -s https://registry.npmjs.org/jquery | jq '.["dist-tags"].beta'
"3.5.1"
When you run npm install jquery,
this is equivalent to npm install jquery@latest.
It puts "jquery": "^3.5.1" in your dependencies,
and forgets that you just installed latest.
Next time, I’ll look at making an example package, publishing it, and showing it in use.
Similar posts
More by Jim
What does the dot do in JavaScript?
foo.bar, foo.bar(), or foo.bar = baz - what do they mean? A deep dive into prototypical inheritance and getters/setters. 2020-11-01
Smear phishing: a new Android vulnerability
Trick Android to display an SMS as coming from any contact. Convincing phishing vuln, but still unpatched. 2020-08-06
A probabilistic pub quiz for nerds
A “true or false” quiz where you respond with your confidence level, and the optimal strategy is to report your true belief. 2020-04-26
Time is running out to catch COVID-19
Simulation shows it’s rational to deliberately infect yourself with COVID-19 early on to get treatment, but after healthcare capacity is exceeded, it’s better to avoid infection. Includes interactive parameters and visualizations. 2020-03-14
The inception bar: a new phishing method
A new phishing technique that displays a fake URL bar in Chrome for mobile. A key innovation is the “scroll jail” that traps the user in a fake browser. 2019-04-27
The hacker hype cycle
I got started with simple web development, but because enamored with increasingly esoteric programming concepts, leading to a “trough of hipster technologies” before returning to more productive work. 2019-03-23
Project C-43: the lost origins of asymmetric crypto
Bob invents asymmetric cryptography by playing loud white noise to obscure Alice’s message, which he can cancel out but an eavesdropper cannot. This idea, published in 1944 by Walter Koenig Jr., is the forgotten origin of asymmetric crypto. 2019-02-16
How Hacker News stays interesting
Hacker News buried my post on conspiracy theories in my family due to overheated discussion, not censorship. Moderation keeps the site focused on interesting technical content. 2019-01-26
My parents are Flat-Earthers
For decades, my parents have been working up to Flat-Earther beliefs. From Egyptology to Jehovah’s Witnesses to theories that human built the Moon billions of years in the future. Surprisingly, it doesn’t affect their successful lives very much. For me, it’s a fun family pastime. 2019-01-20
The dots do matter: how to scam a Gmail user
Gmail’s “dots don’t matter” feature lets scammers create an account on, say, Netflix, with your email address but different dots. Results in convincing phishing emails. 2018-04-07
The sorry state of OpenSSL usability
OpenSSL’s inadequate documentation, confusing key formats, and deprecated interfaces make it difficult to use, despite its importance. 2017-12-02
I hate telephones
I hate telephones. Some rational reasons: lack of authentication, no spam filtering, forced synchronous communication. But also just a visceral fear. 2017-11-08
The Three Ts of Time, Thought and Typing: measuring cost on the web
Businesses often tout “free” services, but the real costs come in terms of time, thought, and typing required from users. Reducing these “Three Ts” is key to improving sign-up flows and increasing conversions. 2017-10-26
Granddad died today
Granddad died. The unspoken practice of death-by-dehydration in the NHS. The Liverpool Care Pathway. Assisted dying in the UK. The importance of planning in end-of-life care. 2017-05-19
How do I call a program in C, setting up standard pipes?
A C function to create a new process, set up its standard input/output/error pipes, and return a struct containing the process ID and pipe file descriptors. 2017-02-17
Your syntax highlighter is wrong
Syntax highlighters make value judgments about code. Most highlighters judge that comments are cruft, and try to hide them. Most diff viewers judge that code deletions are bad. 2014-05-11
Want to build a fantastic product using LLMs? I work at
Granola where we're building the future IDE for knowledge work. Come and work with us!
Read more or
get in touch! This page copyright James Fisher 2020. Content is not associated with my employer. Found an error? Edit this page.
TigYog
Kickabout