@@ -175,7 +175,7 @@ <h3 id="name">name</h3>
175
175
< li > Don't use the same name as a core Node module.</ li >
176
176
< li > Don't put "js" or "node" in the name. It's assumed that it's js, since
177
177
you're writing a package.json file, and you can specify the engine using
178
- the "engines" field. (See below.)</ li >
178
+ the "< a href =" # engines" > engines </ a > " field. (See below.)</ li >
179
179
< li > The name will probably be passed as an argument to require(), so it
180
180
should be something short, but also reasonably descriptive.</ li >
181
181
< li > You may want to check the npm registry to see if there's something by
@@ -201,12 +201,12 @@ <h3 id="keywords">keywords</h3>
201
201
< p > Put keywords in it. It's an array of strings. This helps people discover
202
202
your package as it's listed in < code > npm search</ code > .</ p >
203
203
< h3 id ="homepage "> homepage</ h3 >
204
- < p > The url to the project homepage.</ p >
204
+ < p > The URL to the project homepage.</ p >
205
205
< p > Example:</ p >
206
206
< pre > < code class ="language-json "> "homepage": "https://github.com/owner/project#readme"
207
207
</ code > </ pre >
208
208
< h3 id ="bugs "> bugs</ h3 >
209
- < p > The url to your project's issue tracker and / or the email address to which
209
+ < p > The URL to your project's issue tracker and / or the email address to which
210
210
issues should be reported. These are helpful for people who encounter
211
211
issues with your package.</ p >
212
212
< p > It should look like this:</ p >
@@ -218,9 +218,9 @@ <h3 id="bugs">bugs</h3>
218
218
}
219
219
</ code > </ pre >
220
220
< p > You can specify either one or both values. If you want to provide only a
221
- url , you can specify the value for "bugs" as a simple string instead of an
221
+ URL , you can specify the value for "bugs" as a simple string instead of an
222
222
object.</ p >
223
- < p > If a url is provided, it will be used by the < code > npm bugs</ code > command.</ p >
223
+ < p > If a URL is provided, it will be used by the < code > npm bugs</ code > command.</ p >
224
224
< h3 id ="license "> license</ h3 >
225
225
< p > You should specify a license for your package so that people know how they
226
226
are permitted to use it, and any restrictions you're placing on it.</ p >
@@ -531,9 +531,9 @@ <h3 id="repository">repository</h3>
531
531
}
532
532
}
533
533
</ code > </ pre >
534
- < p > The URL should be a publicly available (perhaps read-only) url that can be
534
+ < p > The URL should be a publicly available (perhaps read-only) URL that can be
535
535
handed directly to a VCS program without any modification. It should not
536
- be a url to an html project page that you put in your browser. It's for
536
+ be a URL to an html project page that you put in your browser. It's for
537
537
computers.</ p >
538
538
< p > For GitHub, GitHub gist, Bitbucket, or GitLab repositories you can use the
539
539
same shortcut syntax you use for < code > npm install</ code > :</ p >
@@ -630,7 +630,7 @@ <h4 id="urls-as-dependencies">URLs as Dependencies</h4>
630
630
< p > This tarball will be downloaded and installed locally to your package at
631
631
install time.</ p >
632
632
< h4 id ="git-urls-as-dependencies "> Git URLs as Dependencies</ h4 >
633
- < p > Git urls are of the form:</ p >
633
+ < p > Git URLs are of the form:</ p >
634
634
< pre > < code class ="language-bash "> <protocol>://[<user>[:<password>]@]<hostname>[:<port>][:][/]<path>[#<commit-ish> | #semver:<semver>]
635
635
</ code > </ pre >
636
636
< p > < code > <protocol></ code > is one of < code > git</ code > , < code > git+ssh</ code > , < code > git+http</ code > , < code > git+https</ code > , or
@@ -666,7 +666,7 @@ <h4 id="git-urls-as-dependencies">Git URLs as Dependencies</h4>
666
666
make sure that none of the above scripts are defined, or your dependency
667
667
will be rebuilt for every installation.</ p >
668
668
< h4 id ="github-urls "> GitHub URLs</ h4 >
669
- < p > As of version 1.1.65, you can refer to GitHub urls as just "foo":
669
+ < p > As of version 1.1.65, you can refer to GitHub URLs as just "foo":
670
670
"user/foo-project". Just as with git URLs, a < code > commit-ish</ code > suffix can be
671
671
included. For example:</ p >
672
672
< pre > < code class ="language-json "> {
@@ -820,7 +820,7 @@ <h3 id="optionaldependencies">optionalDependencies</h3>
820
820
< p > If a dependency can be used, but you would like npm to proceed if it cannot
821
821
be found or fails to install, then you may put it in the
822
822
< code > optionalDependencies</ code > object. This is a map of package name to version or
823
- url , just like the < code > dependencies</ code > object. The difference is that build
823
+ URL , just like the < code > dependencies</ code > object. The difference is that build
824
824
failures do not cause installation to fail. Running < code > npm install --omit=optional</ code > will prevent these dependencies from being installed.</ p >
825
825
< p > It is still your program's responsibility to handle the lack of the
826
826
dependency. For example, something like this:</ p >
0 commit comments