Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: updated the Class:fs filesystem documentation as it was missing … #55279

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion deps/npm/docs/content/commands/npm-init.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: Create a package.json file
### Synopsis

```bash
npm init <package-spec> (same as `npx <package-spec>`)
npm init <package-spec> (same as `npx create-<package-spec>`)
npm init <@scope> (same as `npx <@scope>/create`)

aliases: create, innit
Expand Down
4 changes: 0 additions & 4 deletions deps/npm/docs/content/commands/npm-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -178,10 +178,6 @@ into a tarball (b).
npm install ansi-regex --save-bundle
```

**Note**: If there is a file or folder named `<name>` in the current
working directory, then it will try to install that, and only try to
fetch the package by name if it is not valid.

* `npm install <alias>@npm:<name>`:

Install a package under a custom alias. Allows multiple versions of
Expand Down
2 changes: 1 addition & 1 deletion deps/npm/docs/content/commands/npm-ls.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ packages will *also* show the paths to the specified packages. For
example, running `npm ls promzard` in npm's source tree will show:

```bash
npm@10.8.3 /path/to/npm
npm@10.9.0 /path/to/npm
└─┬ [email protected]
└── [email protected]
```
Expand Down
2 changes: 1 addition & 1 deletion deps/npm/docs/content/commands/npm.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Note: This command is unaware of workspaces.

### Version

10.8.3
10.9.0

### Description

Expand Down
30 changes: 30 additions & 0 deletions deps/npm/docs/content/configuring-npm/package-json.md
Original file line number Diff line number Diff line change
Expand Up @@ -337,6 +337,10 @@ the `files` globs. Exceptions to this are:

These can not be included.

### exports

The "exports" provides a modern alternative to "main" allowing multiple entry points to be defined, conditional entry resolution support between environments, and preventing any other entry points besides those defined in "exports". This encapsulation allows module authors to clearly define the public interface for their package. For more details see the [node.js documentation on package entry points](https://nodejs.org/api/packages.html#package-entry-points)

### main

The main field is a module ID that is the primary entry point to your
Expand Down Expand Up @@ -1125,6 +1129,32 @@ Like the `os` option, you can also block architectures:
The host architecture is determined by `process.arch`
### devEngines
The `devEngines` field aids engineers working on a codebase to all be using the same tooling.
You can specify a `devEngines` property in your `package.json` which will run before `install`, `ci`, and `run` commands.
> Note: `engines` and `devEngines` differ in object shape. They also function very differently. `engines` is designed to alert the user when a dependency uses a differening npm or node version that the project it's being used in, whereas `devEngines` is used to alert people interacting with the source code of a project.

The supported keys under the `devEngines` property are `cpu`, `os`, `libc`, `runtime`, and `packageManager`. Each property can be an object or an array of objects. Objects must contain `name`, and optionally can specify `version`, and `onFail`. `onFail` can be `warn`, `error`, or `ignore`, and if left undefined is of the same value as `error`. `npm` will assume that you're running with `node`.
Here's an example of a project that will fail if the environment is not `node` and `npm`. If you set `runtime.name` or `packageManager.name` to any other string, it will fail within the npm CLI.

```json
{
"devEngines": {
"runtime": {
"name": "node",
"onFail": "error"
},
"packageManager": {
"name": "npm",
"onFail": "error"
}
}
}
```

### private

If you set `"private": true` in your package.json, then npm will refuse to
Expand Down
4 changes: 2 additions & 2 deletions deps/npm/docs/output/commands/npm-access.html
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,9 @@

<section id="content">
<header class="title">
<h1 id="----npm-access----1083">
<h1 id="----npm-access----1090">
<span>npm-access</span>
<span class="version">@10.8.3</span>
<span class="version">@10.9.0</span>
</h1>
<span class="description">Set access level on published packages</span>
</header>
Expand Down
4 changes: 2 additions & 2 deletions deps/npm/docs/output/commands/npm-adduser.html
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,9 @@

<section id="content">
<header class="title">
<h1 id="----npm-adduser----1083">
<h1 id="----npm-adduser----1090">
<span>npm-adduser</span>
<span class="version">@10.8.3</span>
<span class="version">@10.9.0</span>
</h1>
<span class="description">Add a registry user account</span>
</header>
Expand Down
4 changes: 2 additions & 2 deletions deps/npm/docs/output/commands/npm-audit.html
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,9 @@

<section id="content">
<header class="title">
<h1 id="----npm-audit----1083">
<h1 id="----npm-audit----1090">
<span>npm-audit</span>
<span class="version">@10.8.3</span>
<span class="version">@10.9.0</span>
</h1>
<span class="description">Run a security audit</span>
</header>
Expand Down
4 changes: 2 additions & 2 deletions deps/npm/docs/output/commands/npm-bugs.html
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,9 @@

<section id="content">
<header class="title">
<h1 id="----npm-bugs----1083">
<h1 id="----npm-bugs----1090">
<span>npm-bugs</span>
<span class="version">@10.8.3</span>
<span class="version">@10.9.0</span>
</h1>
<span class="description">Report bugs for a package in a web browser</span>
</header>
Expand Down
4 changes: 2 additions & 2 deletions deps/npm/docs/output/commands/npm-cache.html
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,9 @@

<section id="content">
<header class="title">
<h1 id="----npm-cache----1083">
<h1 id="----npm-cache----1090">
<span>npm-cache</span>
<span class="version">@10.8.3</span>
<span class="version">@10.9.0</span>
</h1>
<span class="description">Manipulates packages cache</span>
</header>
Expand Down
4 changes: 2 additions & 2 deletions deps/npm/docs/output/commands/npm-ci.html
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,9 @@

<section id="content">
<header class="title">
<h1 id="----npm-ci----1083">
<h1 id="----npm-ci----1090">
<span>npm-ci</span>
<span class="version">@10.8.3</span>
<span class="version">@10.9.0</span>
</h1>
<span class="description">Clean install a project</span>
</header>
Expand Down
4 changes: 2 additions & 2 deletions deps/npm/docs/output/commands/npm-completion.html
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,9 @@

<section id="content">
<header class="title">
<h1 id="----npm-completion----1083">
<h1 id="----npm-completion----1090">
<span>npm-completion</span>
<span class="version">@10.8.3</span>
<span class="version">@10.9.0</span>
</h1>
<span class="description">Tab Completion for npm</span>
</header>
Expand Down
4 changes: 2 additions & 2 deletions deps/npm/docs/output/commands/npm-config.html
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,9 @@

<section id="content">
<header class="title">
<h1 id="----npm-config----1083">
<h1 id="----npm-config----1090">
<span>npm-config</span>
<span class="version">@10.8.3</span>
<span class="version">@10.9.0</span>
</h1>
<span class="description">Manage the npm configuration files</span>
</header>
Expand Down
4 changes: 2 additions & 2 deletions deps/npm/docs/output/commands/npm-dedupe.html
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,9 @@

<section id="content">
<header class="title">
<h1 id="----npm-dedupe----1083">
<h1 id="----npm-dedupe----1090">
<span>npm-dedupe</span>
<span class="version">@10.8.3</span>
<span class="version">@10.9.0</span>
</h1>
<span class="description">Reduce duplication in the package tree</span>
</header>
Expand Down
4 changes: 2 additions & 2 deletions deps/npm/docs/output/commands/npm-deprecate.html
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,9 @@

<section id="content">
<header class="title">
<h1 id="----npm-deprecate----1083">
<h1 id="----npm-deprecate----1090">
<span>npm-deprecate</span>
<span class="version">@10.8.3</span>
<span class="version">@10.9.0</span>
</h1>
<span class="description">Deprecate a version of a package</span>
</header>
Expand Down
4 changes: 2 additions & 2 deletions deps/npm/docs/output/commands/npm-diff.html
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,9 @@

<section id="content">
<header class="title">
<h1 id="----npm-diff----1083">
<h1 id="----npm-diff----1090">
<span>npm-diff</span>
<span class="version">@10.8.3</span>
<span class="version">@10.9.0</span>
</h1>
<span class="description">The registry diff command</span>
</header>
Expand Down
4 changes: 2 additions & 2 deletions deps/npm/docs/output/commands/npm-dist-tag.html
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,9 @@

<section id="content">
<header class="title">
<h1 id="----npm-dist-tag----1083">
<h1 id="----npm-dist-tag----1090">
<span>npm-dist-tag</span>
<span class="version">@10.8.3</span>
<span class="version">@10.9.0</span>
</h1>
<span class="description">Modify package distribution tags</span>
</header>
Expand Down
4 changes: 2 additions & 2 deletions deps/npm/docs/output/commands/npm-docs.html
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,9 @@

<section id="content">
<header class="title">
<h1 id="----npm-docs----1083">
<h1 id="----npm-docs----1090">
<span>npm-docs</span>
<span class="version">@10.8.3</span>
<span class="version">@10.9.0</span>
</h1>
<span class="description">Open documentation for a package in a web browser</span>
</header>
Expand Down
4 changes: 2 additions & 2 deletions deps/npm/docs/output/commands/npm-doctor.html
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,9 @@

<section id="content">
<header class="title">
<h1 id="----npm-doctor----1083">
<h1 id="----npm-doctor----1090">
<span>npm-doctor</span>
<span class="version">@10.8.3</span>
<span class="version">@10.9.0</span>
</h1>
<span class="description">Check the health of your npm environment</span>
</header>
Expand Down
4 changes: 2 additions & 2 deletions deps/npm/docs/output/commands/npm-edit.html
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,9 @@

<section id="content">
<header class="title">
<h1 id="----npm-edit----1083">
<h1 id="----npm-edit----1090">
<span>npm-edit</span>
<span class="version">@10.8.3</span>
<span class="version">@10.9.0</span>
</h1>
<span class="description">Edit an installed package</span>
</header>
Expand Down
4 changes: 2 additions & 2 deletions deps/npm/docs/output/commands/npm-exec.html
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,9 @@

<section id="content">
<header class="title">
<h1 id="----npm-exec----1083">
<h1 id="----npm-exec----1090">
<span>npm-exec</span>
<span class="version">@10.8.3</span>
<span class="version">@10.9.0</span>
</h1>
<span class="description">Run a command from a local or remote npm package</span>
</header>
Expand Down
4 changes: 2 additions & 2 deletions deps/npm/docs/output/commands/npm-explain.html
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,9 @@

<section id="content">
<header class="title">
<h1 id="----npm-explain----1083">
<h1 id="----npm-explain----1090">
<span>npm-explain</span>
<span class="version">@10.8.3</span>
<span class="version">@10.9.0</span>
</h1>
<span class="description">Explain installed packages</span>
</header>
Expand Down
4 changes: 2 additions & 2 deletions deps/npm/docs/output/commands/npm-explore.html
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,9 @@

<section id="content">
<header class="title">
<h1 id="----npm-explore----1083">
<h1 id="----npm-explore----1090">
<span>npm-explore</span>
<span class="version">@10.8.3</span>
<span class="version">@10.9.0</span>
</h1>
<span class="description">Browse an installed package</span>
</header>
Expand Down
4 changes: 2 additions & 2 deletions deps/npm/docs/output/commands/npm-find-dupes.html
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,9 @@

<section id="content">
<header class="title">
<h1 id="----npm-find-dupes----1083">
<h1 id="----npm-find-dupes----1090">
<span>npm-find-dupes</span>
<span class="version">@10.8.3</span>
<span class="version">@10.9.0</span>
</h1>
<span class="description">Find duplication in the package tree</span>
</header>
Expand Down
4 changes: 2 additions & 2 deletions deps/npm/docs/output/commands/npm-fund.html
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,9 @@

<section id="content">
<header class="title">
<h1 id="----npm-fund----1083">
<h1 id="----npm-fund----1090">
<span>npm-fund</span>
<span class="version">@10.8.3</span>
<span class="version">@10.9.0</span>
</h1>
<span class="description">Retrieve funding information</span>
</header>
Expand Down
4 changes: 2 additions & 2 deletions deps/npm/docs/output/commands/npm-help-search.html
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,9 @@

<section id="content">
<header class="title">
<h1 id="----npm-help-search----1083">
<h1 id="----npm-help-search----1090">
<span>npm-help-search</span>
<span class="version">@10.8.3</span>
<span class="version">@10.9.0</span>
</h1>
<span class="description">Search npm help documentation</span>
</header>
Expand Down
4 changes: 2 additions & 2 deletions deps/npm/docs/output/commands/npm-help.html
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,9 @@

<section id="content">
<header class="title">
<h1 id="----npm-help----1083">
<h1 id="----npm-help----1090">
<span>npm-help</span>
<span class="version">@10.8.3</span>
<span class="version">@10.9.0</span>
</h1>
<span class="description">Get help on npm</span>
</header>
Expand Down
4 changes: 2 additions & 2 deletions deps/npm/docs/output/commands/npm-hook.html
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,9 @@

<section id="content">
<header class="title">
<h1 id="----npm-hook----1083">
<h1 id="----npm-hook----1090">
<span>npm-hook</span>
<span class="version">@10.8.3</span>
<span class="version">@10.9.0</span>
</h1>
<span class="description">Manage registry hooks</span>
</header>
Expand Down
6 changes: 3 additions & 3 deletions deps/npm/docs/output/commands/npm-init.html
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,9 @@

<section id="content">
<header class="title">
<h1 id="----npm-init----1083">
<h1 id="----npm-init----1090">
<span>npm-init</span>
<span class="version">@10.8.3</span>
<span class="version">@10.9.0</span>
</h1>
<span class="description">Create a package.json file</span>
</header>
Expand All @@ -154,7 +154,7 @@ <h2 id="table-of-contents">Table of contents</h2>
</section>

<div id="_content"><h3 id="synopsis">Synopsis</h3>
<pre><code class="language-bash">npm init &lt;package-spec&gt; (same as `npx &lt;package-spec&gt;`)
<pre><code class="language-bash">npm init &lt;package-spec&gt; (same as `npx create-&lt;package-spec&gt;`)
npm init &lt;@scope&gt; (same as `npx &lt;@scope&gt;/create`)

aliases: create, innit
Expand Down
4 changes: 2 additions & 2 deletions deps/npm/docs/output/commands/npm-install-ci-test.html
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,9 @@

<section id="content">
<header class="title">
<h1 id="----npm-install-ci-test----1083">
<h1 id="----npm-install-ci-test----1090">
<span>npm-install-ci-test</span>
<span class="version">@10.8.3</span>
<span class="version">@10.9.0</span>
</h1>
<span class="description">Install a project with a clean slate and run tests</span>
</header>
Expand Down
Loading