Skip to content

Commit 78dbb4b

Browse files
isaacsisaacs
committed
1 parent 760928b commit 78dbb4b

File tree

204 files changed

+835
-326
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

204 files changed

+835
-326
lines changed

‎deps/npm/Makefile

+14-3
Original file line numberDiff line numberDiff line change
@@ -108,18 +108,29 @@ version: link
108108
git add package.json &&\
109109
git ci -m v$(shell npm -v)
110110

111-
publish: link
111+
publish: link doc
112+
git tag -d v$(shell npm -v) || true
113+
git push origin :v$(shell npm -v) || true
114+
npm unpublish npm@$(shell npm -v) || true
112115
git tag -s -m v$(shell npm -v) v$(shell npm -v) &&\
113116
git push origin --tags &&\
114117
npm publish &&\
115-
make doc-publish
118+
npm tag npm@$(shell npm -v) $(shell npm -v | awk -F. '{print $$1 "." $$2}') &&\
119+
make doc-publish &&\
120+
make zip-publish
116121

117122
docpublish: doc-publish
118123
doc-publish: doc
119124
rsync -vazu --stats --no-implied-dirs --delete html/doc/ npmjs.org:/var/www/npmjs.org/public/doc
120125
rsync -vazu --stats --no-implied-dirs --delete html/api/ npmjs.org:/var/www/npmjs.org/public/api
121126

127+
zip-publish: release
128+
scp release/*.zip npmjs.org:/var/www/npmjs.org/public/dist/
129+
130+
release:
131+
@bash scripts/release.sh
132+
122133
sandwich:
123134
@[ $$(whoami) = "root" ] && (echo "ok"; echo "ham" > sandwich) || echo "make it yourself"
124135

125-
.PHONY: all latest install dev link doc clean uninstall test man doc-publish doc-clean docclean docpublish
136+
.PHONY: all latest install dev link doc clean uninstall test man doc-publish doc-clean docclean docpublish release zip-publish

‎deps/npm/doc/cli/disputes.md

+84
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
npm-disputes(1) -- Handling Module Name Disputes
2+
================================================
3+
4+
## SYNOPSIS
5+
6+
1. Get the author email with `npm owner ls <pkgname>`
7+
1. Email the author, CC <[email protected]>.
8+
2. After a few weeks, if there's no resolution, we'll sort it out.
9+
10+
## DESCRIPTION
11+
12+
There sometimes arise cases where a user publishes a module, and then
13+
later, some other user wants to use that name. Here are some common
14+
ways that happens (each of these is based on actual events.)
15+
16+
1. Bob writes a JavaScript module `foo`, which is not node-specific.
17+
Bob doesn't use node at all. Joe wants to use `foo` in node, so he
18+
wraps it in an npm module. Some time later, Bob starts using node,
19+
and wants to take over management of his program.
20+
2. Bob writes an npm module `foo`, and publishes it. Perhaps much
21+
later, Joe finds a bug in `foo`, and fixes it. He sends a pull
22+
request to Bob, but Bob doesn't have the time to deal with it,
23+
because he has a new job and a new baby and is focused on his new
24+
erlang project, and kind of not involved with node any more. Joe
25+
would like to publish a new `foo`, but can't, because the name is
26+
taken.
27+
3. Bob writes a 10-line flow-control library, and calls it `foo`, and
28+
publishes it to the npm registry. Being a simple little thing, it
29+
never really has to be updated. Joe works for Foo Inc, the makers
30+
of the critically acclaimed and widely-marketed `foo` JavaScript
31+
toolkit framework. They publish it to npm as `foojs`, but people are
32+
routinely confused when `npm install foo` is some different thing.
33+
4. Bob writes a parser for the widely-known `foo` file format, because
34+
he needs it for work. Then, he gets a new job, and never updates the
35+
prototype. Later on, Joe writes a much more complete `foo` parser,
36+
but can't publish, because Bob's `foo` is in the way.
37+
38+
The validity of Joe's claim in each situation can be debated. However,
39+
Joe's appropriate course of action in each case is the same.
40+
41+
1. `npm owner ls foo`. This will tell Joe the email address of the
42+
owner (Bob).
43+
2. Joe emails Bob, explaining the situation **as respecfully as possible**,
44+
and what he would like to do with the module name. He adds
45+
isaacs <[email protected]> to the CC list of the email. Mention in the email
46+
that Bob can run `npm owner add joe foo` to add Joe as an owner of
47+
the `foo` package.
48+
3. After a reasonable amount of time, if Bob has not responded, or if
49+
Bob and Joe can't come to any sort of resolution, email isaacs
50+
<[email protected]> and we'll sort it out.
51+
52+
## REASONING
53+
54+
In almost every case so far, the parties involved have been able to reach
55+
an amicable resolution without any major intervention. Most people
56+
really do want to be reasonable, and are probably not even aware that
57+
they're in your way.
58+
59+
Module ecosystems are most vibrant and powerful when they are as
60+
self-directed as possible. If an admin one day deletes something you
61+
had worked on, then that is going to make most people quite upset,
62+
regardless of the justification. When humans solve their problems by
63+
talking to other humans with respect, everyone has the chance to end up
64+
feeling good about the interaction.
65+
66+
## EXCEPTIONS
67+
68+
Some things are not allowed, and will be removed without discussion if
69+
they are brought to the attention of the npm registry admins, including
70+
but not limited to:
71+
72+
1. Malware (that is, a module designed to exploit or harm the machine on
73+
which it is installed)
74+
2. Violations of copyright or licenses (for example, cloning an
75+
MIT-licensed program, and then removing or changing the copyright and
76+
license statement)
77+
3. Illegal content.
78+
79+
If you see bad behavior like this, please report it right away.
80+
81+
## SEE ALSO
82+
83+
* npm-registry(1)
84+
* npm-owner(1)

‎deps/npm/doc/cli/faq.md

+47-19
Original file line numberDiff line numberDiff line change
@@ -32,35 +32,65 @@ tl;dr:
3232
something with the `-g` flag, then its executables go in `npm bin -g`
3333
and its modules go in `npm root -g`.
3434

35-
## How do I install something everywhere?
35+
## How do I install something on my computer in a central location?
3636

37-
Install it globally by tacking `-g` or `--global` to the command.
37+
Install it globally by tacking `-g` or `--global` to the command. (This
38+
is especially important for command line utilities that need to add
39+
their bins to the global system `PATH`.)
3840

3941
## I installed something globally, but I can't `require()` it
4042

4143
Install it locally.
4244

43-
## I don't wanna.
45+
The global install location is a place for command-line utilities
46+
to put their bins in the system `PATH`. It's not for use with `require()`.
4447

45-
Check out `npm link`. You might like it.
48+
If you `require()` a module in your code, then that means it's a
49+
dependency, and a part of your program. You need to install it locally
50+
in your program.
4651

47-
## No, I really want 0.x style 'everything global' style.
52+
## Why can't npm just put everything in one place, like other package managers?
4853

49-
Ok, fine. Do this:
54+
Not every change is an improvement, but every improvement is a change.
55+
This would be like asking git to do network IO for every commit. It's
56+
not going to happen, because it's a terrible idea that causes more
57+
problems than it solves.
5058

51-
echo 'export NODE_PATH="'$(npm root -g)'"' >> ~/.bashrc
52-
. ~/.bashrc
53-
npm config set global true
59+
It is much harder to avoid dependency conflicts without nesting
60+
dependencies. This is fundamental to the way that npm works, and has
61+
proven to be an extremely successful approach. See `npm-folders(1)` for
62+
more details.
5463

55-
This is not recommended.
64+
If you want a package to be installed in one place, and have all your
65+
programs reference the same copy of it, then use the `npm link` command.
66+
That's what it's for. Install it globally, then link it into each
67+
program that uses it.
5668

57-
Many things **will not work** if you do this. Make sure you read and
58-
understand `npm-config(1)` and `npm-global(1)` before you complain
59-
about things being broken.
69+
## Whatever, I really want the old style 'everything global' style.
6070

61-
When you realize what a mistake it was, do this to switch back:
71+
Write your own package manager, then. It's not that hard.
6272

63-
npm config delete global --local
73+
npm will not help you do something that is known to be a bad idea.
74+
75+
## Should I check my `node_modules` folder into git?
76+
77+
Mikeal Rogers answered this question very well:
78+
79+
<http://www.mikealrogers.com/posts/nodemodules-in-git.html>
80+
81+
tl;dr
82+
83+
* Check `node_modules` into git for things you **deploy**, such as
84+
websites and apps.
85+
* Do not check `node_modules` into git for libraries and modules
86+
intended to be reused.
87+
* Use npm to manage dependencies in your dev environment, but not in
88+
your deployment scripts.
89+
90+
## Is it 'npm' or 'NPM' or 'Npm'?
91+
92+
npm should never be capitalized unless it is being displayed in a
93+
location that is customarily all-caps (such as the title of man pages.)
6494

6595
## If 'npm' is an acronym, why is it never capitalized?
6696

@@ -73,7 +103,7 @@ acronym, and thus incorrectly named.)
73103
National Association of Pastoral Musicians. You can learn more
74104
about them at <http://npm.org/>.
75105

76-
In software, "NPM" is a non-parametric mapping utility written by
106+
In software, "NPM" is a Non-Parametric Mapping utility written by
77107
Chris Rorden. You can analyze pictures of brains with it. Learn more
78108
about the (capitalized) NPM program at <http://www.cabiatl.com/mricro/npm/>.
79109

@@ -186,11 +216,9 @@ Go to <http://admin.npmjs.org/reset>.
186216
## I get ECONNREFUSED a lot. What's up?
187217

188218
Either the registry is down, or node's DNS isn't able to reach out.
189-
This happens a lot if you don't follow *all* the steps in the Cygwin
190-
setup doc.
191219

192220
To check if the registry is down, open up
193-
<http://registry.npmjs.org/-/short>
221+
<http://registry.npmjs.org/>
194222
in a web browser. This will also tell you if you are just unable to
195223
access the internet for some reason.
196224

‎deps/npm/doc/cli/index.md

+4
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,10 @@ npm-index(1) -- Index of all npm documentation
5454

5555
Developer Guide
5656

57+
## npm-disputes(1)
58+
59+
Handling Module Name Disputes
60+
5761
## npm-docs(1)
5862

5963
Docs for a package in a web browser maybe

‎deps/npm/doc/cli/owner.md

+1
Original file line numberDiff line numberDiff line change
@@ -30,3 +30,4 @@ that is not implemented at this time.
3030
* npm-publish(1)
3131
* npm-registry(1)
3232
* npm-adduser(1)
33+
* npm-disputes(1)

‎deps/npm/doc/cli/registry.md

+1
Original file line numberDiff line numberDiff line change
@@ -90,3 +90,4 @@ Stay tuned!
9090

9191
* npm-config(1)
9292
* npm-developers(1)
93+
* npm-disputes(1)

‎deps/npm/html/api/bin.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ <h2 id="DESCRIPTION">DESCRIPTION</h2>
1919
<p>This function should not be used programmatically. Instead, just refer
2020
to the <code>npm.bin</code> member.</p>
2121
</div>
22-
<p id="footer">bin &mdash; [email protected]7</p>
22+
<p id="footer">bin &mdash; [email protected]10</p>
2323
<script>
2424
;(function () {
2525
var wrapper = document.getElementById("wrapper")

‎deps/npm/html/api/bugs.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ <h2 id="DESCRIPTION">DESCRIPTION</h2>
2525
<p>This command will launch a browser, so this command may not be the most
2626
friendly for programmatic use.</p>
2727
</div>
28-
<p id="footer">bugs &mdash; [email protected]7</p>
28+
<p id="footer">bugs &mdash; [email protected]10</p>
2929
<script>
3030
;(function () {
3131
var wrapper = document.getElementById("wrapper")

‎deps/npm/html/api/commands.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ <h2 id="SEE-ALSO">SEE ALSO</h2>
2828

2929
<ul><li><a href="../doc/index.html">index(1)</a></li></ul>
3030
</div>
31-
<p id="footer">commands &mdash; [email protected]7</p>
31+
<p id="footer">commands &mdash; [email protected]10</p>
3232
<script>
3333
;(function () {
3434
var wrapper = document.getElementById("wrapper")

‎deps/npm/html/api/config.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ <h2 id="SEE-ALSO">SEE ALSO</h2>
3333

3434
<ul><li><a href="../api/npm.html">npm(3)</a></li></ul>
3535
</div>
36-
<p id="footer">config &mdash; [email protected]7</p>
36+
<p id="footer">config &mdash; [email protected]10</p>
3737
<script>
3838
;(function () {
3939
var wrapper = document.getElementById("wrapper")

‎deps/npm/html/api/deprecate.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ <h2 id="SEE-ALSO">SEE ALSO</h2>
3030

3131
<ul><li><a href="../api/publish.html">publish(3)</a></li><li><a href="../api/unpublish.html">unpublish(3)</a></li><li><a href="../doc/registry.html">registry(1)</a></li></ul>
3232
</div>
33-
<p id="footer">deprecate &mdash; [email protected]7</p>
33+
<p id="footer">deprecate &mdash; [email protected]10</p>
3434
<script>
3535
;(function () {
3636
var wrapper = document.getElementById("wrapper")

‎deps/npm/html/api/docs.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ <h2 id="DESCRIPTION">DESCRIPTION</h2>
2525
<p>This command will launch a browser, so this command may not be the most
2626
friendly for programmatic use.</p>
2727
</div>
28-
<p id="footer">docs &mdash; [email protected]7</p>
28+
<p id="footer">docs &mdash; [email protected]10</p>
2929
<script>
3030
;(function () {
3131
var wrapper = document.getElementById("wrapper")

‎deps/npm/html/api/edit.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ <h2 id="DESCRIPTION">DESCRIPTION</h2>
3030
<p>Since this command opens an editor in a new process, be careful about where
3131
and how this is used.</p>
3232
</div>
33-
<p id="footer">edit &mdash; [email protected]7</p>
33+
<p id="footer">edit &mdash; [email protected]10</p>
3434
<script>
3535
;(function () {
3636
var wrapper = document.getElementById("wrapper")

‎deps/npm/html/api/explore.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ <h2 id="DESCRIPTION">DESCRIPTION</h2>
2424

2525
<p>The first element in the 'args' parameter must be a package name. After that is the optional command, which can be any number of strings. All of the strings will be combined into one, space-delimited command.</p>
2626
</div>
27-
<p id="footer">explore &mdash; [email protected]7</p>
27+
<p id="footer">explore &mdash; [email protected]10</p>
2828
<script>
2929
;(function () {
3030
var wrapper = document.getElementById("wrapper")

‎deps/npm/html/api/help-search.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ <h2 id="DESCRIPTION">DESCRIPTION</h2>
3232

3333
<p>The silent parameter is not neccessary not used, but it may in the future.</p>
3434
</div>
35-
<p id="footer">help-search &mdash; [email protected]7</p>
35+
<p id="footer">help-search &mdash; [email protected]10</p>
3636
<script>
3737
;(function () {
3838
var wrapper = document.getElementById("wrapper")

‎deps/npm/html/api/init.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ <h2 id="SEE-ALSO">SEE ALSO</h2>
3535

3636
<p><a href="../doc/json.html">json(1)</a></p>
3737
</div>
38-
<p id="footer">init &mdash; [email protected]7</p>
38+
<p id="footer">init &mdash; [email protected]10</p>
3939
<script>
4040
;(function () {
4141
var wrapper = document.getElementById("wrapper")

‎deps/npm/html/api/install.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ <h2 id="DESCRIPTION">DESCRIPTION</h2>
2525
<p>Finally, 'callback' is a function that will be called when all packages have been
2626
installed or when an error has been encountered.</p>
2727
</div>
28-
<p id="footer">install &mdash; [email protected]7</p>
28+
<p id="footer">install &mdash; [email protected]10</p>
2929
<script>
3030
;(function () {
3131
var wrapper = document.getElementById("wrapper")

‎deps/npm/html/api/link.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ <h2 id="DESCRIPTION">DESCRIPTION</h2>
3939
<p>Now, any changes to the redis package will be reflected in
4040
the package in the current working directory</p>
4141
</div>
42-
<p id="footer">link &mdash; [email protected]7</p>
42+
<p id="footer">link &mdash; [email protected]10</p>
4343
<script>
4444
;(function () {
4545
var wrapper = document.getElementById("wrapper")

‎deps/npm/html/api/load.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ <h2 id="DESCRIPTION">DESCRIPTION</h2>
3232

3333
<p>For a list of all the available command-line configs, see <code>npm help config</code></p>
3434
</div>
35-
<p id="footer">load &mdash; [email protected]7</p>
35+
<p id="footer">load &mdash; [email protected]10</p>
3636
<script>
3737
;(function () {
3838
var wrapper = document.getElementById("wrapper")

‎deps/npm/html/api/ls.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ <h3 id="global">global</h3>
5353
This means that if a submodule a same dependency as a parent module, then the
5454
dependency will only be output once.</p>
5555
</div>
56-
<p id="footer">ls &mdash; [email protected]7</p>
56+
<p id="footer">ls &mdash; [email protected]10</p>
5757
<script>
5858
;(function () {
5959
var wrapper = document.getElementById("wrapper")

‎deps/npm/html/api/npm.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ <h2 id="SYNOPSIS">SYNOPSIS</h2>
2424

2525
<h2 id="VERSION">VERSION</h2>
2626

27-
<p>1.1.0-beta-7</p>
27+
<p>1.1.0-beta-10</p>
2828

2929
<h2 id="DESCRIPTION">DESCRIPTION</h2>
3030

@@ -91,7 +91,7 @@ <h2 id="ABBREVS">ABBREVS</h2>
9191

9292
<pre><code>var cmd = npm.deref("unp") // cmd === "unpublish"</code></pre>
9393
</div>
94-
<p id="footer">npm &mdash; [email protected]7</p>
94+
<p id="footer">npm &mdash; [email protected]10</p>
9595
<script>
9696
;(function () {
9797
var wrapper = document.getElementById("wrapper")

‎deps/npm/html/api/outdated.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ <h2 id="DESCRIPTION">DESCRIPTION</h2>
1919

2020
<p>If the 'packages' parameter is left out, npm will check all packages.</p>
2121
</div>
22-
<p id="footer">outdated &mdash; [email protected]7</p>
22+
<p id="footer">outdated &mdash; [email protected]10</p>
2323
<script>
2424
;(function () {
2525
var wrapper = document.getElementById("wrapper")

0 commit comments

Comments
 (0)