Skip to content

Commit 55639ef

Browse files
authored
docs: use git+https in package.com url examples (#7615)
- closes #7614 ## Issue Examples in the [repository](https://docs.npmjs.com/cli/v10/configuring-npm/package-json#repository) section of the [npm CI > Configuring npm > package.json](https://docs.npmjs.com/cli/v10/configuring-npm/package-json) reference page use the protocol `https`. The examples are: ```json "url": "https://github.com/npm/cli.git" ``` ```json "url": "https://github.com/facebook/react.git" ``` Executing `npm pkg fix` in a repo with a `url` definition and `protocol` using `https` normalizes the protocol to `git+https`. Examples should be aligned with what `npm pkg fix` considers correct and should also be aligned to the list of valid protocols in the [Git URLs as Dependencies](https://docs.npmjs.com/cli/v10/configuring-npm/package-json#git-urls-as-dependencies) section, which states: > `<protocol>` is one of `git`, `git+ssh`, `git+http`, `git+https`, or `git+file`. ## Change 1. `npm/cli.git` Change to ```json "url": "git+https://github.com/npm/cli.git" ``` 2. `facebook/react.git` Since the source example of https://github.com/facebook/react/blob/main/packages/react-dom/package.json does not use the correct `git+https` protocol, use instead ```json "url": "git+https://github.com/npm/cli.git", "directory": "workspaces/libnpmpublish" ```
1 parent 2273183 commit 55639ef

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

docs/lib/content/configuring-npm/package-json.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -367,11 +367,11 @@ feature to install the "npm" executable.)
367367
To use this, supply a `bin` field in your package.json which is a map of
368368
command name to local file name. When this package is installed globally,
369369
that file will be either linked inside the global bins directory or
370-
a cmd (Windows Command File) will be created which executes the specified
370+
a cmd (Windows Command File) will be created which executes the specified
371371
file in the `bin` field, so it is available to run by `name` or `name.cmd` (on
372-
Windows PowerShell). When this package is installed as a dependency in another
372+
Windows PowerShell). When this package is installed as a dependency in another
373373
package, the file will be linked where it will be available to that package
374-
either directly by `npm exec` or by name in other scripts when invoking them
374+
either directly by `npm exec` or by name in other scripts when invoking them
375375
via `npm run-script`.
376376

377377

@@ -385,10 +385,10 @@ For example, myapp could have this:
385385
}
386386
```
387387

388-
So, when you install myapp, in case of unix-like OS it'll create a symlink
389-
from the `cli.js` script to `/usr/local/bin/myapp` and in case of windows it
388+
So, when you install myapp, in case of unix-like OS it'll create a symlink
389+
from the `cli.js` script to `/usr/local/bin/myapp` and in case of windows it
390390
will create a cmd file usually at `C:\Users\{Username}\AppData\Roaming\npm\myapp.cmd`
391-
which runs the `cli.js` script.
391+
which runs the `cli.js` script.
392392

393393
If you have a single executable, and its name should be the name of the
394394
package, then you can just supply it as a string. For example:
@@ -518,7 +518,7 @@ Do it like this:
518518
{
519519
"repository": {
520520
"type": "git",
521-
"url": "https://github.com/npm/cli.git"
521+
"url": "git+https://github.com/npm/cli.git"
522522
}
523523
}
524524
```
@@ -553,8 +553,8 @@ which it lives:
553553
{
554554
"repository": {
555555
"type": "git",
556-
"url": "https://github.com/facebook/react.git",
557-
"directory": "packages/react-dom"
556+
"url": "git+https://github.com/npm/cli.git",
557+
"directory": "workspaces/libnpmpublish"
558558
}
559559
}
560560
```

0 commit comments

Comments
 (0)