@cryptotaxi247 / documentation / commits / dcbc6e5

CLI documentation update from CI

npm CLI robot committed Aug 19, 2022 at 03:04 UTC dcbc6e5395947af5ddd1698c86c72589c9e39c84
3 files changed +5 -141
cli/v6
+1 -1
@@ -1 +1 @@
1 -Subproject commit 0a1a3200193862663b58b101662615ff6f8ac5a4
1 +Subproject commit 28a4a063c9fb3175d9c0e1bb282f9d81cbd7c7a2
content/cli/v6/commands/npm-link.md
+4 -4
@@ -44,10 +44,10 @@ test it iteratively without having to continually rebuild.
44 For example:
45
46 ```bash
47 - cd ~/projects/node-redis # go into the package directory
48 - npm link # creates global link
49 - cd ~/projects/node-bloggy # go into some other package directory.
50 - npm link redis # link-install the package
47 +cd ~/projects/node-redis # go into the package directory
48 +npm link # creates global link
49 +cd ~/projects/node-bloggy # go into some other package directory.
50 +npm link redis # link-install the package
51 ```
52
53 Now, any changes to ~/projects/node-redis will be reflected in
content/cli/v6/using-npm/disputes.md deleted
-136
@@ -1,136 +0,0 @@
1 ----
2 -title: disputes
3 -section: 7
4 -description: Handling Module Name Disputes
5 -github_repo: npm/cli
6 -github_branch: v6-docs
7 -github_path: docs/content/using-npm/disputes.md
8 ----
9 -
10 -This document describes the steps that you should take to resolve module name
11 -disputes with other npm publishers. It also describes special steps you should
12 -take about names you think infringe your trademarks.
13 -
14 -This document is a clarification of the acceptable behavior outlined in the
15 -[npm Code of Conduct](https://www.npmjs.com/policies/conduct), and nothing in
16 -this document should be interpreted to contradict any aspect of the npm Code of
17 -Conduct.
18 -
19 -### TL;DR
20 -
21 -1. Get the author email with `npm owner ls <pkgname>`
22 -2. Email the author, CC <support@npmjs.com>
23 -3. After a few weeks, if there's no resolution, we'll sort it out.
24 -
25 -Don't squat on package names. Publish code or move out of the way.
26 -
27 -### Description
28 -
29 -There sometimes arise cases where a user publishes a module, and then later,
30 -some other user wants to use that name. Here are some common ways that happens
31 -(each of these is based on actual events.)
32 -
33 -1. Alice writes a JavaScript module `foo`, which is not node-specific. Alice
34 - doesn't use node at all. Yusuf wants to use `foo` in node, so he wraps it in
35 - an npm module. Some time later, Alice starts using node, and wants to take
36 - over management of her program.
37 -2. Yusuf writes an npm module `foo`, and publishes it. Perhaps much later, Alice
38 - finds a bug in `foo`, and fixes it. She sends a pull request to Yusuf, but
39 - Yusuf doesn't have the time to deal with it, because he has a new job and a
40 - new baby and is focused on his new Erlang project, and kind of not involved
41 - with node any more. Alice would like to publish a new `foo`, but can't,
42 - because the name is taken.
43 -3. Yusuf writes a 10-line flow-control library, and calls it `foo`, and
44 - publishes it to the npm registry. Being a simple little thing, it never
45 - really has to be updated. Alice works for Foo Inc, the makers of the
46 - critically acclaimed and widely-marketed `foo` JavaScript toolkit framework.
47 - They publish it to npm as `foojs`, but people are routinely confused when
48 - `npm install foo` is some different thing.
49 -4. Yusuf writes a parser for the widely-known `foo` file format, because he
50 - needs it for work. Then, he gets a new job, and never updates the prototype.
51 - Later on, Alice writes a much more complete `foo` parser, but can't publish,
52 - because Yusuf's `foo` is in the way.
53 -
54 -1. `npm owner ls foo`. This will tell Alice the email address of the owner
55 - (Yusuf).
56 -2. Alice emails Yusuf, explaining the situation **as respectfully as possible**,
57 - and what she would like to do with the module name. She adds the npm support
58 - staff <support@npmjs.com> to the CC list of the email. Mention in the email
59 - that Yusuf can run npm owner `add alice foo` to add Alice as an owner of the
60 - foo package.
61 -3. After a reasonable amount of time, if Yusuf has not responded, or if Yusuf
62 - and Alice can't come to any sort of resolution, email support
63 - <support@npmjs.com> and we'll sort it out. ("Reasonable" is usually at least
64 - 4 weeks.)
65 -
66 -### Reasoning
67 -
68 -In almost every case so far, the parties involved have been able to reach an
69 -amicable resolution without any major intervention. Most people really do want
70 -to be reasonable, and are probably not even aware that they're in your way.
71 -
72 -Module ecosystems are most vibrant and powerful when they are as self-directed
73 -as possible. If an admin one day deletes something you had worked on, then that
74 -is going to make most people quite upset, regardless of the justification. When
75 -humans solve their problems by talking to other humans with respect, everyone
76 -has the chance to end up feeling good about the interaction.
77 -
78 -### Exceptions
79 -
80 -Some things are not allowed, and will be removed without discussion if they are
81 -brought to the attention of the npm registry admins, including but not limited
82 -to:
83 -
84 -1. Malware (that is, a package designed to exploit or harm the machine on which
85 - it is installed).
86 -2. Violations of copyright or licenses (for example, cloning an MIT-licensed
87 - program, and then removing or changing the copyright and license statement).
88 -3. Illegal content.
89 -4. "Squatting" on a package name that you plan to use, but aren't actually
90 - using. Sorry, I don't care how great the name is, or how perfect a fit it is
91 - for the thing that someday might happen. If someone wants to use it today,
92 - and you're just taking up space with an empty tarball, you're going to be
93 - evicted.
94 -5. Putting empty packages in the registry. Packages must have SOME
95 - functionality. It can be silly, but it can't be nothing. (See also:
96 - squatting.)
97 -6. Doing weird things with the registry, like using it as your own personal
98 - application database or otherwise putting non-packagey things into it.
99 -7. Other things forbidden by the npm
100 - [Code of Conduct](https://www.npmjs.com/policies/conduct) such as hateful
101 - language, pornographic content, or harassment.
102 -
103 -If you see bad behavior like this, please report it to <abuse@npmjs.com> right
104 -away. **You are never expected to resolve abusive behavior on your own. We are
105 -here to help.**
106 -
107 -### Trademarks
108 -
109 -If you think another npm publisher is infringing your trademark, such as by
110 -using a confusingly similar package name, email <abuse@npmjs.com> with a link to
111 -the package or user account on [https://www.npmjs.com/](https://www.npmjs.com/).
112 -Attach a copy of your trademark registration certificate.
113 -
114 -If we see that the package's publisher is intentionally misleading others by
115 -misusing your registered mark without permission, we will transfer the package
116 -name to you. Otherwise, we will contact the package publisher and ask them to
117 -clear up any confusion with changes to their package's `README` file or
118 -metadata.
119 -
120 -### Changes
121 -
122 -This is a living document and may be updated from time to time. Please refer to
123 -the [git history for this document](https://github.com/npm/cli/commits/latest/doc/misc/npm-disputes.md)
124 -to view the changes.
125 -
126 -### License
127 -
128 -Copyright (C) npm, Inc., All rights reserved
129 -
130 -This document may be reused under a Creative Commons Attribution-ShareAlike
131 -License.
132 -
133 -### See also
134 -
135 -* [npm registry](/cli/v6/using-npm/registry)
136 -* [npm owner](/cli/v6/commands/npm-owner)