mirror/pnpm
1
0
Fork 0
mirror of https://github.com/pnpm/pnpm.git synced 2026-05-12 18:49:41 -04:00
Code Issues Packages Projects Releases Wiki Activity

docs: fix package names in README files (#11409)

Browse Source 
* docs: fix package names in README files

* docs: update links to point to npmx.dev
This commit is contained in:
Zoltan Kochan
2026-04-30 18:59:49 +02:00
parent a99ffe0893
commit 184ce26f3f
126 changed files with 397 additions and 301 deletions
Download Patch File Download Diff File Expand all files Collapse all files

96
.changeset/fiery-parts-clap.md Normal file
View File

@@ -0,0 +1,96 @@
---
"@pnpm/resolving.registry.pkg-metadata-filter": patch
"@pnpm/installing.linking.direct-dep-linker": patch
"@pnpm/engine.runtime.system-node-version": patch
"@pnpm/installing.linking.modules-cleaner": patch
"@pnpm/installing.dedupe.issues-renderer": patch
"@pnpm/resolving.parse-wanted-dependency": patch
"@pnpm/workspace.project-manifest-reader": patch
"@pnpm/workspace.project-manifest-writer": patch
"@pnpm/config.pick-registry-for-package": patch
"@pnpm/installing.read-projects-context": patch
"@pnpm/lockfile.make-dedicated-lockfile": patch
"@pnpm/deps.compliance.license-scanner": patch
"@pnpm/config.package-is-installable": patch
"@pnpm/installing.linking.real-hoist": patch
"@pnpm/releasing.exportable-manifest": patch
"@pnpm/deps.inspection.tree-builder": patch
"@pnpm/installing.package-requester": patch
"@pnpm/building.pkg-requires-build": patch
"@pnpm/cli.common-cli-options-help": patch
"@pnpm/config.normalize-registries": patch
"@pnpm/fetching.directory-fetcher": patch
"@pnpm/resolving.default-resolver": patch
"@pnpm/resolving.tarball-resolver": patch
"@pnpm/installing.deps-installer": patch
"@pnpm/workspace.projects-filter": patch
"@pnpm/workspace.projects-reader": patch
"@pnpm/deps.inspection.outdated": patch
"@pnpm/fetching.tarball-fetcher": patch
"@pnpm/installing.deps-restorer": patch
"@pnpm/installing.linking.hoist": patch
"@pnpm/resolving.local-resolver": patch
"@pnpm/resolving.registry.types": patch
"@pnpm/store.connection-manager": patch
"@pnpm/workspace.range-resolver": patch
"@pnpm/building.during-install": patch
"@pnpm/fs.indexed-pkg-importer": patch
"@pnpm/installing.dedupe.check": patch
"@pnpm/installing.dedupe.types": patch
"@pnpm/installing.modules-yaml": patch
"@pnpm/resolving.resolver-base": patch
"@pnpm/store.create-cafs-store": patch
"@pnpm/config.parse-overrides": patch
"@pnpm/modules-mounter.daemon": patch
"@pnpm/resolving.git-resolver": patch
"@pnpm/resolving.npm-resolver": patch
"@pnpm/store.controller-types": patch
"@pnpm/deps.compliance.audit": patch
"@pnpm/fetching.fetcher-base": patch
"@pnpm/fetching.pick-fetcher": patch
"@pnpm/fs.symlink-dependency": patch
"@pnpm/workspace.root-finder": patch
"@pnpm/cli.default-reporter": patch
"@pnpm/deps.inspection.list": patch
"@pnpm/exec.prepare-package": patch
"@pnpm/fetching.git-fetcher": patch
"@pnpm/fs.read-modules-dir": patch
"@pnpm/installing.commands": patch
"@pnpm/pkg-manifest.reader": patch
"@pnpm/cli.parse-cli-args": patch
"@pnpm/deps.graph-builder": patch
"@pnpm/installing.context": patch
"@pnpm/pkg-manifest.utils": patch
"@pnpm/workspace.commands": patch
"@pnpm/deps.graph-hasher": patch
"@pnpm/installing.client": patch
"@pnpm/network.git-utils": patch
"@pnpm/patching.commands": patch
"@pnpm/text.naming-cases": patch
"@pnpm/store.cafs-types": patch
"@pnpm/store.controller": patch
"@pnpm/building.policy": patch
"@pnpm/config.commands": patch
"@pnpm/deps.peer-range": patch
"@pnpm/lockfile.to-pnp": patch
"@pnpm/config.matcher": patch
"@pnpm/exec.lifecycle": patch
"@pnpm/fetching.types": patch
"@pnpm/fs.graceful-fs": patch
"@pnpm/hooks.pnpmfile": patch
"@pnpm/bins.resolver": patch
"@pnpm/config.reader": patch
"@pnpm/config.writer": patch
"@pnpm/exec.commands": patch
"@pnpm/network.fetch": patch
"@pnpm/bins.remover": patch
"@pnpm/bins.linker": patch
"@pnpm/cli.command": patch
"@pnpm/shell.path": patch
"@pnpm/store.path": patch
"@pnpm/cli.utils": patch
"@pnpm/deps.path": patch
"@pnpm/cli.meta": patch
---
Fix the package name in README.md.

8
bins/linker/README.md
View File

@@ -1,21 +1,21 @@
# @pnpm/link-bins
# @pnpm/bins.linker
> Link bins to node_modules/.bin
<!--@shields('npm')-->
[![npm version](https://img.shields.io/npm/v/@pnpm/link-bins.svg)](https://www.npmjs.com/package/@pnpm/link-bins)
[![npm version](https://img.shields.io/npm/v/@pnpm/bins.linker.svg)](https://npmx.dev/package/@pnpm/bins.linker)
<!--/@-->
## Installation
```sh
pnpm add @pnpm/link-bins
pnpm add @pnpm/bins.linker
```
## Usage
```ts
import linkBins, {linkBinsOfPackages} from '@pnpm/link-bins'
import linkBins, {linkBinsOfPackages} from '@pnpm/bins.linker'
function warn (msg) { console.warn(msg) }

4
bins/remover/README.md
View File

@@ -1,11 +1,11 @@
# @pnpm/remove-bins
# @pnpm/bins.remover
> Remove bins from ./bin
## Install
```
pnpm install @pnpm/remove-bins
pnpm install @pnpm/bins.remover
```
## API

8
bins/resolver/README.md
View File

@@ -1,21 +1,21 @@
# @pnpm/package-bins
# @pnpm/bins.resolver
> Returns bins of a package
<!--@shields('npm')-->
[![npm version](https://img.shields.io/npm/v/@pnpm/package-bins.svg)](https://www.npmjs.com/package/@pnpm/package-bins)
[![npm version](https://img.shields.io/npm/v/@pnpm/bins.resolver.svg)](https://npmx.dev/package/@pnpm/bins.resolver)
<!--/@-->
## Installation
```sh
pnpm add @pnpm/package-bins
pnpm add @pnpm/bins.resolver
```
## Usage
```ts
import getBinsFromPkg from '@pnpm/package-bins'
import getBinsFromPkg from '@pnpm/bins.resolver'
await getBinsFromPkg(path.resolve('package.json'), process.cwd())
//> [{name: 'bin-name', path: 'path-to-bin'}]

2
building/after-install/README.md
View File

@@ -3,7 +3,7 @@
> Rebuild packages that are already installed by running their lifecycle scripts
<!--@shields('npm')-->
[![npm version](https://img.shields.io/npm/v/@pnpm/building.after-install.svg)](https://www.npmjs.com/package/@pnpm/building.after-install)
[![npm version](https://img.shields.io/npm/v/@pnpm/building.after-install.svg)](https://npmx.dev/package/@pnpm/building.after-install)
<!--/@-->
## Installation

6
building/during-install/README.md
View File

@@ -1,15 +1,15 @@
# @pnpm/build-modules
# @pnpm/building.during-install
> Build packages in node_modules
<!--@shields('npm')-->
[![npm version](https://img.shields.io/npm/v/@pnpm/build-modules.svg)](https://www.npmjs.com/package/@pnpm/build-modules)
[![npm version](https://img.shields.io/npm/v/@pnpm/building.during-install.svg)](https://npmx.dev/package/@pnpm/building.during-install)
<!--/@-->
## Installation
```sh
pnpm add @pnpm/build-modules
pnpm add @pnpm/building.during-install
```
## License

6
building/pkg-requires-build/README.md
View File

@@ -1,13 +1,13 @@
# @pnpm/exec.pkg-requires-build
# @pnpm/building.pkg-requires-build
> Checks if a package requires to be built
[![npm version](https://img.shields.io/npm/v/@pnpm/exec.pkg-requires-build.svg)](https://www.npmjs.com/package/@pnpm/exec.pkg-requires-build)
[![npm version](https://img.shields.io/npm/v/@pnpm/building.pkg-requires-build.svg)](https://npmx.dev/package/@pnpm/building.pkg-requires-build)
## Installation
```sh
pnpm add @pnpm/exec.pkg-requires-build
pnpm add @pnpm/building.pkg-requires-build
```
## License

4
building/policy/README.md
View File

@@ -1,11 +1,11 @@
# @pnpm/builder.policy
# @pnpm/building.policy
> Create a function for filtering out dependencies that are not allowed to be built
## Install
```
pnpm add @pnpm/builder.policy
pnpm add @pnpm/building.policy
```
## License

2
cache/api/README.md vendored
View File

@@ -2,7 +2,7 @@
> API for controlling the cache
[![npm version](https://img.shields.io/npm/v/@pnpm/cache.api.svg)](https://www.npmjs.com/package/@pnpm/cache.api)
[![npm version](https://img.shields.io/npm/v/@pnpm/cache.api.svg)](https://npmx.dev/package/@pnpm/cache.api)
## Installation

2
cache/commands/README.md vendored
View File

@@ -2,7 +2,7 @@
> Commands for controlling the cache
[![npm version](https://img.shields.io/npm/v/@pnpm/cache.commands.svg)](https://www.npmjs.com/package/@pnpm/cache.commands)
[![npm version](https://img.shields.io/npm/v/@pnpm/cache.commands.svg)](https://npmx.dev/package/@pnpm/cache.commands)
## Installation

6
cli/command/README.md
View File

@@ -1,13 +1,13 @@
# @pnpm/command
# @pnpm/cli.command
> Types and utils for pnpm commands
[![npm version](https://img.shields.io/npm/v/@pnpm/command.svg)](https://www.npmjs.com/package/@pnpm/command)
[![npm version](https://img.shields.io/npm/v/@pnpm/cli.command.svg)](https://npmx.dev/package/@pnpm/cli.command)
## Installation
```sh
pnpm add @pnpm/command
pnpm add @pnpm/cli.command
```
## License

6
cli/common-cli-options-help/README.md
View File

@@ -1,13 +1,13 @@
# @pnpm/common-cli-options-help
# @pnpm/cli.common-cli-options-help
> Help for some common CLI options
[![npm version](https://img.shields.io/npm/v/@pnpm/common-cli-options-help.svg)](https://www.npmjs.com/package/@pnpm/common-cli-options-help)
[![npm version](https://img.shields.io/npm/v/@pnpm/cli.common-cli-options-help.svg)](https://npmx.dev/package/@pnpm/cli.common-cli-options-help)
## Installation
```sh
pnpm add @pnpm/common-cli-options-help
pnpm add @pnpm/cli.common-cli-options-help
```
## License

6
cli/default-reporter/README.md
View File

@@ -1,18 +1,18 @@
# @pnpm/default-reporter
# @pnpm/cli.default-reporter
> The default reporter of pnpm
## Installation
```
pnpm add @pnpm/default-reporter
pnpm add @pnpm/cli.default-reporter
```
## Usage
```ts
import { streamParser } from '@pnpm/logger'
import { initDefaultReporter } from '@pnpm/default-reporter'
import { initDefaultReporter } from '@pnpm/cli.default-reporter'
const stopReporting = initDefaultReporter({
context: {

6
cli/meta/README.md
View File

@@ -1,13 +1,13 @@
# @pnpm/cli-meta
# @pnpm/cli.meta
> Reads the meta info of the currently running pnpm instance
[![npm version](https://img.shields.io/npm/v/@pnpm/cli-meta.svg)](https://www.npmjs.com/package/@pnpm/cli-meta)
[![npm version](https://img.shields.io/npm/v/@pnpm/cli.meta.svg)](https://npmx.dev/package/@pnpm/cli.meta)
## Installation
```sh
pnpm add @pnpm/cli-meta
pnpm add @pnpm/cli.meta
```
## License

6
cli/parse-cli-args/README.md
View File

@@ -1,13 +1,13 @@
# @pnpm/parse-cli-args
# @pnpm/cli.parse-cli-args
> Parses the CLI args passed to pnpm
[![npm version](https://img.shields.io/npm/v/@pnpm/parse-cli-args.svg)](https://www.npmjs.com/package/@pnpm/parse-cli-args)
[![npm version](https://img.shields.io/npm/v/@pnpm/cli.parse-cli-args.svg)](https://npmx.dev/package/@pnpm/cli.parse-cli-args)
## Installation
```sh
pnpm add @pnpm/parse-cli-args
pnpm add @pnpm/cli.parse-cli-args
```
## License

6
cli/utils/README.md
View File

@@ -1,13 +1,13 @@
# @pnpm/cli-utils
# @pnpm/cli.utils
> Utils for pnpm commands
[![npm version](https://img.shields.io/npm/v/@pnpm/cli-utils.svg)](https://www.npmjs.com/package/@pnpm/cli-utils)
[![npm version](https://img.shields.io/npm/v/@pnpm/cli.utils.svg)](https://npmx.dev/package/@pnpm/cli.utils)
## Installation
```sh
pnpm add @pnpm/cli-utils
pnpm add @pnpm/cli.utils
```
## License

6
config/commands/README.md
View File

@@ -1,13 +1,13 @@
# @pnpm/plugin-commands-config
# @pnpm/config.commands
> Commands for reading and writing settings to/from config files
[![npm version](https://img.shields.io/npm/v/@pnpm/plugin-commands-config.svg)](https://www.npmjs.com/package/@pnpm/plugin-commands-config)
[![npm version](https://img.shields.io/npm/v/@pnpm/config.commands.svg)](https://npmx.dev/package/@pnpm/config.commands)
## Installation
```sh
pnpm add @pnpm/plugin-commands-config
pnpm add @pnpm/config.commands
```
## License

6
config/matcher/README.md
View File

@@ -1,17 +1,17 @@
# @pnpm/matcher
# @pnpm/config.matcher
> A simple pattern matcher for pnpm
## Install
```
pnpm add @pnpm/matcher
pnpm add @pnpm/config.matcher
```
## Usage
```ts
import { createMatcher } from '@pnpm/matcher'
import { createMatcher } from '@pnpm/config.matcher'
const match = createMatcher(['eslint-*'])
match('eslint-plugin-foo')

6
config/normalize-registries/README.md
View File

@@ -1,17 +1,17 @@
# @pnpm/normalize-registries
# @pnpm/config.normalize-registries
> Accepts a mapping of registry URLs and returns a mapping with the same URLs but normalized
## Installation
```
pnpm add @pnpm/normalize-registries
pnpm add @pnpm/config.normalize-registries
```
## Usage
```typescript
import normalizeRegistries from '@pnpm/normalize-registries'
import normalizeRegistries from '@pnpm/config.normalize-registries'
normalizeRegistries({
'default': 'https://registry.npmjs.org',

4
config/package-is-installable/README.md
View File

@@ -1,11 +1,11 @@
# @pnpm/package-is-installable
# @pnpm/config.package-is-installable
> Checks if a package is installable on the current system
## Install
```
pnpm install @pnpm/package-is-installable
pnpm install @pnpm/config.package-is-installable
```
## License

6
config/parse-overrides/README.md
View File

@@ -1,17 +1,17 @@
# @pnpm/parse-overrides
# @pnpm/config.parse-overrides
> Parse overrides
## Installation
```
pnpm add @pnpm/parse-overrides
pnpm add @pnpm/config.parse-overrides
```
## Usage
```ts
import { parseOverrides } from '@pnpm/parse-overrides'
import { parseOverrides } from '@pnpm/config.parse-overrides'
parseOverrides({
'foo': '^1.0.0',

4
config/pick-registry-for-package/README.md
View File

@@ -1,11 +1,11 @@
# @pnpm/pick-registry-for-package
# @pnpm/config.pick-registry-for-package
> Picks the right registry for the package from a registries config
## Installation
```
pnpm add @pnpm/pick-registry-for-package
pnpm add @pnpm/config.pick-registry-for-package
```
## License

8
config/reader/README.md
View File

@@ -1,21 +1,21 @@
# @pnpm/config
# @pnpm/config.reader
> Gets configuration options for pnpm
<!--@shields('npm')-->
[![npm version](https://img.shields.io/npm/v/@pnpm/config.svg)](https://www.npmjs.com/package/@pnpm/config)
[![npm version](https://img.shields.io/npm/v/@pnpm/config.reader.svg)](https://npmx.dev/package/@pnpm/config.reader)
<!--/@-->
## Installation
```sh
pnpm add @pnpm/config
pnpm add @pnpm/config.reader
```
## Usage
```ts
import { getConfig } from '@pnpm/config'
import { getConfig } from '@pnpm/config.reader'
getConfig().then(pnpmConfig => console.log(pnpmConfig))
```

6
config/writer/README.md
View File

@@ -1,15 +1,15 @@
# @pnpm/config.config-writer
# @pnpm/config.writer
> Functions for updating the configuration settings
<!--@shields('npm')-->
[![npm version](https://img.shields.io/npm/v/@pnpm/config.svg)](https://www.npmjs.com/package/@pnpm/config)
[![npm version](https://img.shields.io/npm/v/@pnpm/config.svg)](https://npmx.dev/package/@pnpm/config)
<!--/@-->
## Installation
```sh
pnpm add @pnpm/config.config-writer
pnpm add @pnpm/config.writer
```
## License

2
core/constants/README.md
View File

@@ -3,7 +3,7 @@
> pnpm constants
<!--@shields('npm')-->
[![npm version](https://img.shields.io/npm/v/@pnpm/constants.svg)](https://www.npmjs.com/package/@pnpm/constants)
[![npm version](https://img.shields.io/npm/v/@pnpm/constants.svg)](https://npmx.dev/package/@pnpm/constants)
<!--/@-->
## Installation

2
core/error/README.md
View File

@@ -3,7 +3,7 @@
> An error class for pnpm errors
<!--@shields('npm')-->
[![npm version](https://img.shields.io/npm/v/@pnpm/error.svg)](https://www.npmjs.com/package/@pnpm/error)
[![npm version](https://img.shields.io/npm/v/@pnpm/error.svg)](https://npmx.dev/package/@pnpm/error)
<!--/@-->
## Installation

4
core/logger/README.md
View File

@@ -2,7 +2,7 @@
> Logger for pnpm
[![npm version](https://img.shields.io/npm/v/@pnpm/logger.svg)](https://www.npmjs.com/package/@pnpm/logger)
[![npm version](https://img.shields.io/npm/v/@pnpm/logger.svg)](https://npmx.dev/package/@pnpm/logger)
## Installation
@@ -12,7 +12,7 @@ pnpm add @pnpm/logger
## Usage
`@pnpm/logger` is mostly just a wrapper over [bole](https://www.npmjs.com/package/bole).
`@pnpm/logger` is mostly just a wrapper over [bole](https://npmx.dev/package/bole).
Logging is done the same way as in bole. To listed for logs, use `streamParser` or create
a new parser with `createStreamParser()`.

2
core/types/README.md
View File

@@ -3,7 +3,7 @@
> Basic types used by pnpm
<!--@shields('npm')-->
[![npm version](https://img.shields.io/npm/v/@pnpm/types.svg)](https://www.npmjs.com/package/@pnpm/types)
[![npm version](https://img.shields.io/npm/v/@pnpm/types.svg)](https://npmx.dev/package/@pnpm/types)
<!--/@-->
## Installation

6
deps/compliance/audit/README.md vendored
View File

@@ -1,13 +1,13 @@
# @pnpm/audit
# @pnpm/deps.compliance.audit
> Audit a lockfile
[![npm version](https://img.shields.io/npm/v/@pnpm/audit.svg)](https://www.npmjs.com/package/@pnpm/audit)
[![npm version](https://img.shields.io/npm/v/@pnpm/deps.compliance.audit.svg)](https://npmx.dev/package/@pnpm/deps.compliance.audit)
## Installation
```sh
pnpm add @pnpm/audit
pnpm add @pnpm/deps.compliance.audit
```
## License

2
deps/compliance/license-resolver/README.md vendored
View File

@@ -3,7 +3,7 @@
> Resolve a package's license from its manifest or on-disk LICENSE file
<!--@shields('npm')-->
[![npm version](https://img.shields.io/npm/v/@pnpm/deps.compliance.license-resolver.svg)](https://www.npmjs.com/package/@pnpm/deps.compliance.license-resolver)
[![npm version](https://img.shields.io/npm/v/@pnpm/deps.compliance.license-resolver.svg)](https://npmx.dev/package/@pnpm/deps.compliance.license-resolver)
<!--/@-->
## Installation

6
deps/compliance/license-scanner/README.md vendored
View File

@@ -1,15 +1,15 @@
# @pnpm/license-scanner
# @pnpm/deps.compliance.license-scanner
> Check for the license of packages
<!--@shields('npm')-->
[![npm version](https://img.shields.io/npm/v/@pnpm/license-scanner.svg)](https://www.npmjs.com/package/@pnpm/license-scanner)
[![npm version](https://img.shields.io/npm/v/@pnpm/deps.compliance.license-scanner.svg)](https://npmx.dev/package/@pnpm/deps.compliance.license-scanner)
<!--/@-->
## Installation
```sh
pnpm add @pnpm/license-scanner
pnpm add @pnpm/deps.compliance.license-scanner
```
## License

2
deps/graph-builder/README.md vendored
View File

@@ -5,7 +5,7 @@
## Installation
```
pnpm install @pnpm/deps.graph.builder
pnpm install @pnpm/deps.graph-builder
```
## License

6
deps/graph-hasher/README.md vendored
View File

@@ -1,15 +1,15 @@
# @pnpm/calc-dep-state
# @pnpm/deps.graph-hasher
> Calculates the state of a dependency
<!--@shields('npm')-->
[![npm version](https://img.shields.io/npm/v/@pnpm/calc-dep-state.svg)](https://www.npmjs.com/package/@pnpm/calc-dep-state)
[![npm version](https://img.shields.io/npm/v/@pnpm/deps.graph-hasher.svg)](https://npmx.dev/package/@pnpm/deps.graph-hasher)
<!--/@-->
## Installation
```sh
pnpm add @pnpm/calc-dep-state
pnpm add @pnpm/deps.graph-hasher
```
## License

6
deps/inspection/list/README.md vendored
View File

@@ -1,15 +1,15 @@
# @pnpm/list
# @pnpm/deps.inspection.list
> List installed packages in a symlinked \`node_modules\`
<!--@shields('npm')-->
[![npm version](https://img.shields.io/npm/v/@pnpm/list.svg)](https://www.npmjs.com/package/@pnpm/list)
[![npm version](https://img.shields.io/npm/v/@pnpm/deps.inspection.list.svg)](https://npmx.dev/package/@pnpm/deps.inspection.list)
<!--/@-->
## Installation
```
pnpm add @pnpm/list
pnpm add @pnpm/deps.inspection.list
```
## License

6
deps/inspection/outdated/README.md vendored
View File

@@ -1,15 +1,15 @@
# @pnpm/outdated
# @pnpm/deps.inspection.outdated
> Check for outdated packages
<!--@shields('npm')-->
[![npm version](https://img.shields.io/npm/v/@pnpm/outdated.svg)](https://www.npmjs.com/package/@pnpm/outdated)
[![npm version](https://img.shields.io/npm/v/@pnpm/deps.inspection.outdated.svg)](https://npmx.dev/package/@pnpm/deps.inspection.outdated)
<!--/@-->
## Installation
```sh
pnpm add @pnpm/outdated
pnpm add @pnpm/deps.inspection.outdated
```
## License

6
deps/inspection/tree-builder/README.md vendored
View File

@@ -1,9 +1,9 @@
# @pnpm/reviewing.tree-builder
# @pnpm/deps.inspection.tree-builder
> Creates a dependencies hierarchy for a symlinked \`node_modules\`
<!--@shields('npm')-->
[![npm version](https://img.shields.io/npm/v/tree-builder.svg)](https://www.npmjs.com/package/tree-builder)
[![npm version](https://img.shields.io/npm/v/tree-builder.svg)](https://npmx.dev/package/tree-builder)
<!--/@-->
A symlinked `node_modules` is created when installing using [pnpm](https://github.com/pnpm/pnpm).
@@ -11,7 +11,7 @@ A symlinked `node_modules` is created when installing using [pnpm](https://githu
## Installation
```
pnpm add @pnpm/reviewing.tree-builder
pnpm add @pnpm/deps.inspection.tree-builder
```
## License

8
deps/path/README.md vendored
View File

@@ -1,9 +1,9 @@
# @pnpm/dependency-path
# @pnpm/deps.path
> Utilities for working with symlinked node_modules
<!--@shields('npm')-->
[![npm version](https://img.shields.io/npm/v/dependency-path.svg)](https://www.npmjs.com/package/dependency-path)
[![npm version](https://img.shields.io/npm/v/deps.path.svg)](https://npmx.dev/package/deps.path)
<!--/@-->
Like `path` but for packages in a symlinked `node_modules`. Symlinked `node_modules` is a unique dependencies layout that
@@ -12,7 +12,7 @@ Like `path` but for packages in a symlinked `node_modules`. Symlinked `node_modu
## Installation
```sh
pnpm add @pnpm/dependency-path
pnpm add @pnpm/deps.path
```
## Usage
@@ -20,7 +20,7 @@ pnpm add @pnpm/dependency-path
<!--/* cspell:disable */-->
<!--@example('./example.js')-->
```js
const dependencyPath = require('@pnpm/dependency-path')
const dependencyPath = require('@pnpm/deps.path')
const registry = 'https://registry.npmjs.org/'

6
deps/peer-range/README.md vendored
View File

@@ -1,13 +1,13 @@
# @pnpm/semver.peer-range
# @pnpm/deps.peer-range
> Validates peer ranges
[![npm version](https://img.shields.io/npm/v/@pnpm/semver.peer-range.svg)](https://www.npmjs.com/package/@pnpm/semver.peer-range)
[![npm version](https://img.shields.io/npm/v/@pnpm/deps.peer-range.svg)](https://npmx.dev/package/@pnpm/deps.peer-range)
## Installation
```sh
pnpm add @pnpm/semver.peer-range
pnpm add @pnpm/deps.peer-range
```
## License

2
deps/status/README.md vendored
View File

@@ -2,7 +2,7 @@
> Check dependencies status
[![npm version](https://img.shields.io/npm/v/@pnpm/deps.status.svg)](https://www.npmjs.com/package/@pnpm/deps.status)
[![npm version](https://img.shields.io/npm/v/@pnpm/deps.status.svg)](https://npmx.dev/package/@pnpm/deps.status)
## Installation

2
engine/runtime/bun-resolver/README.md
View File

@@ -2,7 +2,7 @@
> Resolves the Bun runtime
[![npm version](https://img.shields.io/npm/v/@pnpm/engine.runtime.bun-resolver.svg)](https://www.npmjs.com/package/@pnpm/engine.runtime.bun-resolver)
[![npm version](https://img.shields.io/npm/v/@pnpm/engine.runtime.bun-resolver.svg)](https://npmx.dev/package/@pnpm/engine.runtime.bun-resolver)
## Installation

2
engine/runtime/deno-resolver/README.md
View File

@@ -2,7 +2,7 @@
> Resolves the Deno runtime
[![npm version](https://img.shields.io/npm/v/@pnpm/engine.runtime.deno-resolver.svg)](https://www.npmjs.com/package/@pnpm/engine.runtime.deno-resolver)
[![npm version](https://img.shields.io/npm/v/@pnpm/engine.runtime.deno-resolver.svg)](https://npmx.dev/package/@pnpm/engine.runtime.deno-resolver)
## Installation

2
engine/runtime/node-resolver/README.md
View File

@@ -2,7 +2,7 @@
> Resolves a Node.js version specifier to an exact Node.js version
[![npm version](https://img.shields.io/npm/v/@pnpm/engine.runtime.node-resolver.svg)](https://www.npmjs.com/package/@pnpm/engine.runtime.node-resolver)
[![npm version](https://img.shields.io/npm/v/@pnpm/engine.runtime.node-resolver.svg)](https://npmx.dev/package/@pnpm/engine.runtime.node-resolver)
## Installation

6
engine/runtime/system-node-version/README.md
View File

@@ -1,13 +1,13 @@
# @pnpm/env.system-node-version
# @pnpm/engine.runtime.system-node-version
> Detects the current system node version
[![npm version](https://img.shields.io/npm/v/@pnpm/env.system-node-version.svg)](https://www.npmjs.com/package/@pnpm/env.system-node-version)
[![npm version](https://img.shields.io/npm/v/@pnpm/engine.runtime.system-node-version.svg)](https://npmx.dev/package/@pnpm/engine.runtime.system-node-version)
## Installation
```sh
pnpm add @pnpm/env.system-node-version
pnpm add @pnpm/engine.runtime.system-node-version
```
## License

6
exec/commands/README.md
View File

@@ -1,13 +1,13 @@
# @pnpm/plugin-commands-script-runners
# @pnpm/exec.commands
> Commands for running scripts
[![npm version](https://img.shields.io/npm/v/@pnpm/plugin-commands-script-runners.svg)](https://www.npmjs.com/package/@pnpm/plugin-commands-script-runners)
[![npm version](https://img.shields.io/npm/v/@pnpm/exec.commands.svg)](https://npmx.dev/package/@pnpm/exec.commands)
## Installation
```sh
pnpm add @pnpm/plugin-commands-script-runners
pnpm add @pnpm/exec.commands
```
## License

8
exec/lifecycle/README.md
View File

@@ -1,21 +1,21 @@
# @pnpm/lifecycle
# @pnpm/exec.lifecycle
> Package lifecycle hook runner
<!--@shields('npm')-->
[![npm version](https://img.shields.io/npm/v/@pnpm/lifecycle.svg)](https://www.npmjs.com/package/@pnpm/lifecycle)
[![npm version](https://img.shields.io/npm/v/@pnpm/exec.lifecycle.svg)](https://npmx.dev/package/@pnpm/exec.lifecycle)
<!--/@-->
## Installation
```sh
pnpm add @pnpm/logger @pnpm/lifecycle
pnpm add @pnpm/logger @pnpm/exec.lifecycle
```
## Usage
```ts
import runLifecycleHook, {runPostinstallHooks} from '@pnpm/lifecycle'
import runLifecycleHook, {runPostinstallHooks} from '@pnpm/exec.lifecycle'
const targetPkgRoot = path.resolve('node_modules/target-pkg')
const pkg = require(path.join(targetPkgRoot, 'package.json'))

2
exec/pnpm-cli-runner/README.md
View File

@@ -2,7 +2,7 @@
> Runs pnpm CLI
[![npm version](https://img.shields.io/npm/v/@pnpm/exec.pnpm-cli-runner.svg)](https://www.npmjs.com/package/@pnpm/exec.pnpm-cli-runner)
[![npm version](https://img.shields.io/npm/v/@pnpm/exec.pnpm-cli-runner.svg)](https://npmx.dev/package/@pnpm/exec.pnpm-cli-runner)
## Installation

6
exec/prepare-package/README.md
View File

@@ -1,13 +1,13 @@
# @pnpm/prepare-package
# @pnpm/exec.prepare-package
> Prepares a Git-hosted package
[![npm version](https://img.shields.io/npm/v/@pnpm/prepare-package.svg)](https://www.npmjs.com/package/@pnpm/prepare-package)
[![npm version](https://img.shields.io/npm/v/@pnpm/exec.prepare-package.svg)](https://npmx.dev/package/@pnpm/exec.prepare-package)
## Installation
```sh
pnpm add @pnpm/prepare-package
pnpm add @pnpm/exec.prepare-package
```
## License

6
fetching/directory-fetcher/README.md
View File

@@ -1,13 +1,13 @@
# @pnpm/directory-fetcher
# @pnpm/fetching.directory-fetcher
> Fetcher for local directory packages
[![npm version](https://img.shields.io/npm/v/@pnpm/directory-fetcher.svg)](https://www.npmjs.com/package/@pnpm/directory-fetcher)
[![npm version](https://img.shields.io/npm/v/@pnpm/fetching.directory-fetcher.svg)](https://npmx.dev/package/@pnpm/fetching.directory-fetcher)
## Installation
```
pnpm add @pnpm/directory-fetcher
pnpm add @pnpm/fetching.directory-fetcher
```
## License

10
fetching/fetcher-base/README.md
View File

@@ -1,27 +1,27 @@
# @pnpm/fetcher-base
# @pnpm/fetching.fetcher-base
> Types for pnpm-compatible fetchers
<!--@shields('npm')-->
[![npm version](https://img.shields.io/npm/v/@pnpm/fetcher-base.svg)](https://www.npmjs.com/package/@pnpm/fetcher-base)
[![npm version](https://img.shields.io/npm/v/@pnpm/fetching.fetcher-base.svg)](https://npmx.dev/package/@pnpm/fetching.fetcher-base)
<!--/@-->
## Installation
```sh
pnpm add @pnpm/fetcher-base
pnpm add @pnpm/fetching.fetcher-base
```
## Usage
Here's a template for a fetcher using types from `@pnpm/fetcher-base`:
Here's a template for a fetcher using types from `@pnpm/fetching.fetcher-base`:
```ts
import { Resolution } from '@pnpm/resolver-base'
import {
FetchOptions,
FetchResult,
} from '@pnpm/fetcher-base'
} from '@pnpm/fetching.fetcher-base'
export async function demoFetcher (
resolution: Resolution,

6
fetching/git-fetcher/README.md
View File

@@ -1,13 +1,13 @@
# @pnpm/git-fetcher
# @pnpm/fetching.git-fetcher
> Fetcher for git-hosted packages
[![npm version](https://img.shields.io/npm/v/@pnpm/git-fetcher.svg)](https://www.npmjs.com/package/@pnpm/git-fetcher)
[![npm version](https://img.shields.io/npm/v/@pnpm/fetching.git-fetcher.svg)](https://npmx.dev/package/@pnpm/fetching.git-fetcher)
## Installation
```
pnpm add @pnpm/git-fetcher
pnpm add @pnpm/fetching.git-fetcher
```
## License

6
fetching/pick-fetcher/README.md
View File

@@ -1,13 +1,13 @@
# @pnpm/pick-fetcher
# @pnpm/fetching.pick-fetcher
> Pick a package fetcher by type
[![npm version](https://img.shields.io/npm/v/@pnpm/pick-fetcher.svg)](https://www.npmjs.com/package/@pnpm/pick-fetcher)
[![npm version](https://img.shields.io/npm/v/@pnpm/fetching.pick-fetcher.svg)](https://npmx.dev/package/@pnpm/fetching.pick-fetcher)
## Deploy
```sh
pnpm add @pnpm/pick-fetcher
pnpm add @pnpm/fetching.pick-fetcher
```
## License

6
fetching/tarball-fetcher/README.md
View File

@@ -1,13 +1,13 @@
# @pnpm/tarball-fetcher
# @pnpm/fetching.tarball-fetcher
> Fetcher for packages hosted as tarballs
[![npm version](https://img.shields.io/npm/v/@pnpm/tarball-fetcher.svg)](https://www.npmjs.com/package/@pnpm/tarball-fetcher)
[![npm version](https://img.shields.io/npm/v/@pnpm/fetching.tarball-fetcher.svg)](https://npmx.dev/package/@pnpm/fetching.tarball-fetcher)
## Installation
```
pnpm add @pnpm/tarball-fetcher
pnpm add @pnpm/fetching.tarball-fetcher
```
## License

2
fetching/types/README.md
View File

@@ -1,4 +1,4 @@
# @pnpm/fetching-types
# @pnpm/fetching.types
> Types for the fetching

6
fs/graceful-fs/README.md
View File

@@ -1,13 +1,13 @@
# @pnpm/graceful-fs
# @pnpm/fs.graceful-fs
> Promisified graceful-fs
[![npm version](https://img.shields.io/npm/v/@pnpm/graceful-fs.svg)](https://www.npmjs.com/package/@pnpm/graceful-fs)
[![npm version](https://img.shields.io/npm/v/@pnpm/fs.graceful-fs.svg)](https://npmx.dev/package/@pnpm/fs.graceful-fs)
## Installation
```sh
pnpm add @pnpm/graceful-fs
pnpm add @pnpm/fs.graceful-fs
```
## License

2
fs/hard-link-dir/README.md
View File

@@ -3,7 +3,7 @@
> Hard link (or copy if linking fails) all files from a directory to several target directories.
<!--@shields('npm')-->
[![npm version](https://img.shields.io/npm/v/hard-link-dir.svg)](https://www.npmjs.com/package/@pnpm/fs.hard-link-dir)
[![npm version](https://img.shields.io/npm/v/hard-link-dir.svg)](https://npmx.dev/package/@pnpm/fs.hard-link-dir)
<!--/@-->
## Installation

4
fs/indexed-pkg-importer/README.md
View File

@@ -1,11 +1,11 @@
# @pnpm/create-cafs-store
# @pnpm/fs.indexed-pkg-importer
> Replicates indexed directories using hard links, copies, or cloning
## Installation
```
pnpm add @pnpm/create-cafs-store
pnpm add @pnpm/fs.indexed-pkg-importer
```
## License

2
fs/is-empty-dir-or-nothing/README.md
View File

@@ -2,7 +2,7 @@
> Checks if a path is an empty dir or nothing
[![npm version](https://img.shields.io/npm/v/@pnpm/is-empty-dir-or-nothing.svg)](https://www.npmjs.com/package/@pnpm/fs.is-empty-dir-or-nothing)
[![npm version](https://img.shields.io/npm/v/@pnpm/is-empty-dir-or-nothing.svg)](https://npmx.dev/package/@pnpm/fs.is-empty-dir-or-nothing)
## Installation

2
fs/packlist/README.md
View File

@@ -3,7 +3,7 @@
> Get a list of the files to add from a directory into an npm package
<!--@shields('npm')-->
[![npm version](https://img.shields.io/npm/v/packlist.svg)](https://www.npmjs.com/package/@pnpm/fs.packlist)
[![npm version](https://img.shields.io/npm/v/packlist.svg)](https://npmx.dev/package/@pnpm/fs.packlist)
<!--/@-->
## Installation

2
fs/read-modules-dir/README.md
View File

@@ -1,3 +1,3 @@
# @pnpm/read-modules-dir
# @pnpm/fs.read-modules-dir
> Finds all direct packages in node_modules

6
fs/symlink-dependency/README.md
View File

@@ -1,17 +1,17 @@
# @pnpm/symlink-dependency
# @pnpm/fs.symlink-dependency
> Symlink a dependency to node_modules
## Installation
```
pnpm install @pnpm/symlink-dependency
pnpm install @pnpm/fs.symlink-dependency
```
## Usage
```ts
import { symlinkDependency } from '@pnpm/symlink-dependency'
import { symlinkDependency } from '@pnpm/fs.symlink-dependency'
await symlinkDependency('/home/src/foo', '/home/src/my-project/node_modules', 'foo')
//> { reused: false }

6
hooks/pnpmfile/README.md
View File

@@ -1,13 +1,13 @@
# @pnpm/pnpmfile
# @pnpm/hooks.pnpmfile
> Reading a .pnpmfile.cjs
[![npm version](https://img.shields.io/npm/v/@pnpm/pnpmfile.svg)](https://www.npmjs.com/package/@pnpm/pnpmfile)
[![npm version](https://img.shields.io/npm/v/@pnpm/hooks.pnpmfile.svg)](https://npmx.dev/package/@pnpm/hooks.pnpmfile)
## Installation
```sh
pnpm add @pnpm/pnpmfile
pnpm add @pnpm/hooks.pnpmfile
```
## License

2
hooks/types/README.md
View File

@@ -2,7 +2,7 @@
> Types for hooks
[![npm version](https://img.shields.io/npm/v/@pnpm/hooks.types.svg)](https://www.npmjs.com/package/@pnpm/hooks.types)
[![npm version](https://img.shields.io/npm/v/@pnpm/hooks.types.svg)](https://npmx.dev/package/@pnpm/hooks.types)
## Installation

6
installing/client/README.md
View File

@@ -1,15 +1,15 @@
# @pnpm/client
# @pnpm/installing.client
> Creates the package resolve and fetch functions
<!--@shields('npm')-->
[![npm version](https://img.shields.io/npm/v/@pnpm/client.svg)](https://www.npmjs.com/package/@pnpm/client)
[![npm version](https://img.shields.io/npm/v/@pnpm/installing.client.svg)](https://npmx.dev/package/@pnpm/installing.client)
<!--/@-->
## Installation
```sh
pnpm add @pnpm/client
pnpm add @pnpm/installing.client
```
## License

6
installing/commands/README.md
View File

@@ -1,13 +1,13 @@
# @pnpm/plugin-commands-installation
# @pnpm/installing.commands
> Commands for installation
[![npm version](https://img.shields.io/npm/v/@pnpm/plugin-commands-installation.svg)](https://www.npmjs.com/package/@pnpm/plugin-commands-installation)
[![npm version](https://img.shields.io/npm/v/@pnpm/installing.commands.svg)](https://npmx.dev/package/@pnpm/installing.commands)
## Installation
```sh
pnpm add @pnpm/plugin-commands-installation
pnpm add @pnpm/installing.commands
```
## License

6
installing/context/README.md
View File

@@ -1,13 +1,13 @@
# @pnpm/get-context
# @pnpm/installing.context
> Gets context information about a project
[![npm version](https://img.shields.io/npm/v/@pnpm/get-context.svg)](https://www.npmjs.com/package/@pnpm/get-context)
[![npm version](https://img.shields.io/npm/v/@pnpm/installing.context.svg)](https://npmx.dev/package/@pnpm/installing.context)
## Installation
```sh
pnpm add @pnpm/get-context
pnpm add @pnpm/installing.context
```
## License

4
installing/dedupe/check/README.md
View File

@@ -1,11 +1,11 @@
# @pnpm/dedupe.issues-renderer
# @pnpm/installing.dedupe.check
> Logic for "pnpm dedupe --check"
## Installation
```
pnpm add @pnpm/dedupe.check
pnpm add @pnpm/installing.dedupe.check
```
## License

4
installing/dedupe/issues-renderer/README.md
View File

@@ -1,11 +1,11 @@
# @pnpm/dedupe.issues-renderer
# @pnpm/installing.dedupe.issues-renderer
> Visualizes "pnpm dedupe --check" issues
## Installation
```
pnpm add @pnpm/dedupe.issues-renderer
pnpm add @pnpm/installing.dedupe.issues-renderer
```
## License

4
installing/dedupe/types/README.md
View File

@@ -1,11 +1,11 @@
# @pnpm/dedupe.types
# @pnpm/installing.dedupe.types
> Types for the pnpm dedupe command
## Installation
```
pnpm add @pnpm/dedupe.types
pnpm add @pnpm/installing.dedupe.types
```
## License

8
installing/deps-installer/README.md
View File

@@ -1,4 +1,4 @@
# @pnpm/core
# @pnpm/installing.deps-installer
> Fast, disk space efficient installation engine. Used by [pnpm](https://github.com/pnpm/pnpm)
@@ -7,7 +7,7 @@
Install it via npm.
```
pnpm add @pnpm/core
pnpm add @pnpm/installing.deps-installer
```
It also depends on `@pnpm/logger` version `1`, so install it as well via:
@@ -75,7 +75,7 @@ Hooks are functions that can step into the installation process. All hooks can b
### `readPackage(pkg: Manifest, context): Manifest | Promise<Manifest>`
This hook is called with every dependency's manifest information.
The modified manifest returned by this hook is then used by `@pnpm/core` during installation.
The modified manifest returned by this hook is then used by `@pnpm/installing.deps-installer` during installation.
An async function is supported.
**Arguments:**
@@ -86,7 +86,7 @@ An async function is supported.
**Example:**
```js
const { installPkgs } = require('@pnpm/core')
const { installPkgs } = require('@pnpm/installing.deps-installer')
installPkgs({
hooks: {

4
installing/deps-restorer/README.md
View File

@@ -1,11 +1,11 @@
# @pnpm/headless
# @pnpm/installing.deps-restorer
> Fast installation using only pnpm-lock.yaml
## Installation
```
pnpm install @pnpm/headless
pnpm install @pnpm/installing.deps-restorer
```
## License

2
installing/env-installer/README.md
View File

@@ -3,7 +3,7 @@
> Installer for configurational dependencies
<!--@shields('npm')-->
[![npm version](https://img.shields.io/npm/v/@pnpm/installing.env-installer.svg)](https://www.npmjs.com/package/@pnpm/installing.env-installer)
[![npm version](https://img.shields.io/npm/v/@pnpm/installing.env-installer.svg)](https://npmx.dev/package/@pnpm/installing.env-installer)
<!--/@-->
## Installation

4
installing/linking/direct-dep-linker/README.md
View File

@@ -1,11 +1,11 @@
# @pnpm/pkg-manager.direct-dep-linker
# @pnpm/installing.linking.direct-dep-linker
> Links direct dependencies to projects
## Installation
```
pnpm install @pnpm/pkg-manager.direct-dep-linker
pnpm install @pnpm/installing.linking.direct-dep-linker
```
## License

4
installing/linking/hoist/README.md
View File

@@ -1,4 +1,4 @@
# @pnpm/hoist
# @pnpm/installing.linking.hoist
> Hoists dependencies in a node_modules created by pnpm
@@ -7,7 +7,7 @@ Formerly `@pnpm/shamefully-flatten`.
## Installation
```
pnpm add @pnpm/hoist
pnpm add @pnpm/installing.linking.hoist
```
## License

4
installing/linking/modules-cleaner/README.md
View File

@@ -1,11 +1,11 @@
# @pnpm/modules-cleaner
# @pnpm/installing.linking.modules-cleaner
> Exports util functions to clean up node_modules
## Install
```
pnpm install @pnpm/modules-cleaner
pnpm install @pnpm/installing.linking.modules-cleaner
```
## API

4
installing/linking/real-hoist/README.md
View File

@@ -1,11 +1,11 @@
# @pnpm/real-hoist
# @pnpm/installing.linking.real-hoist
> Hoists dependencies in a node_modules created by pnpm
## Installation
```
pnpm add @pnpm/real-hoist
pnpm add @pnpm/installing.linking.real-hoist
```
## License

8
installing/modules-yaml/README.md
View File

@@ -1,21 +1,21 @@
# @pnpm/modules-yaml
# @pnpm/installing.modules-yaml
> Reads/writes \`node_modules/.modules.yaml\`
<!--@shields('npm')-->
[![npm version](https://img.shields.io/npm/v/@pnpm/modules-yaml.svg)](https://www.npmjs.com/package/@pnpm/modules-yaml)
[![npm version](https://img.shields.io/npm/v/@pnpm/installing.modules-yaml.svg)](https://npmx.dev/package/@pnpm/installing.modules-yaml)
<!--/@-->
## Installation
```sh
pnpm add @pnpm/modules-yaml
pnpm add @pnpm/installing.modules-yaml
```
## Usage
```ts
import {write, read} from '@pnpm/modules-yaml'
import {write, read} from '@pnpm/installing.modules-yaml'
await write('node_modules', {
hoistedAliases: {},

6
installing/package-requester/README.md
View File

@@ -1,15 +1,15 @@
# @pnpm/package-requester
# @pnpm/installing.package-requester
> Concurrent downloader of npm-compatible packages
<!--@shields('npm')-->
[![npm version](https://img.shields.io/npm/v/@pnpm/package-requester.svg)](https://www.npmjs.com/package/@pnpm/package-requester)
[![npm version](https://img.shields.io/npm/v/@pnpm/installing.package-requester.svg)](https://npmx.dev/package/@pnpm/installing.package-requester)
<!--/@-->
## Installation
```sh
pnpm add @pnpm/logger @pnpm/package-requester
pnpm add @pnpm/logger @pnpm/installing.package-requester
```
## License

2
installing/read-projects-context/README.md
View File

@@ -1,3 +1,3 @@
# @pnpm/read-projects-context
# @pnpm/installing.read-projects-context
> Reads the current state of projects from modules manifest

6
lockfile/make-dedicated-lockfile/README.md
View File

@@ -1,8 +1,8 @@
# @pnpm/make-dedicated-lockfile
# @pnpm/lockfile.make-dedicated-lockfile
> Creates a dedicated lockfile for a subset of workspace projects
[![npm version](https://img.shields.io/npm/v/@pnpm/make-dedicated-lockfile.svg)](https://www.npmjs.com/package/@pnpm/make-dedicated-lockfile)
[![npm version](https://img.shields.io/npm/v/@pnpm/lockfile.make-dedicated-lockfile.svg)](https://npmx.dev/package/@pnpm/lockfile.make-dedicated-lockfile)
**This package is deprecated. Please use the [pnpm deploy] command instead.**
@@ -11,7 +11,7 @@
## Installation
```sh
pnpm add @pnpm/make-dedicated-lockfile
pnpm add @pnpm/lockfile.make-dedicated-lockfile
```
## Usage

6
lockfile/to-pnp/README.md
View File

@@ -1,13 +1,13 @@
# @pnpm/lockfile-to-pnp
# @pnpm/lockfile.to-pnp
> Creates a Plug'n'Play file from a pnpm-lock.yaml
[![npm version](https://img.shields.io/npm/v/@pnpm/lockfile-to-pnp.svg)](https://www.npmjs.com/package/@pnpm/lockfile-to-pnp)
[![npm version](https://img.shields.io/npm/v/@pnpm/lockfile.to-pnp.svg)](https://npmx.dev/package/@pnpm/lockfile.to-pnp)
## Installation
```
pnpm add -g @pnpm/lockfile-to-pnp
pnpm add -g @pnpm/lockfile.to-pnp
```
## License

2
lockfile/verification/README.md
View File

@@ -2,7 +2,7 @@
> Checks a lockfile
[![npm version](https://img.shields.io/npm/v/@pnpm/lockfile.verification.svg)](https://www.npmjs.com/package/@pnpm/lockfile.verification)
[![npm version](https://img.shields.io/npm/v/@pnpm/lockfile.verification.svg)](https://npmx.dev/package/@pnpm/lockfile.verification)
## Installation

6
modules-mounter/daemon/README.md
View File

@@ -1,13 +1,13 @@
# @pnpm/mount-modules
# @pnpm/modules-mounter.daemon
> Mounts a node_modules directory with FUSE
[![npm version](https://img.shields.io/npm/v/@pnpm/mount-modules.svg)](https://www.npmjs.com/package/@pnpm/mount-modules)
[![npm version](https://img.shields.io/npm/v/@pnpm/modules-mounter.daemon.svg)](https://npmx.dev/package/@pnpm/modules-mounter.daemon)
## Installation
```
pnpm add @pnpm/mount-modules --global
pnpm add @pnpm/modules-mounter.daemon --global
```
## Usage

2
network/auth-header/README.md
View File

@@ -2,7 +2,7 @@
> Gets the authorization header for the given URI
[![npm version](https://img.shields.io/npm/v/@pnpm/network.auth-header.svg)](https://www.npmjs.com/package/@pnpm/network.auth-header)
[![npm version](https://img.shields.io/npm/v/@pnpm/network.auth-header.svg)](https://npmx.dev/package/@pnpm/network.auth-header)
## Installation

6
network/fetch/README.md
View File

@@ -1,15 +1,15 @@
# @pnpm/fetch
# @pnpm/network.fetch
> node-fetch with retries
<!--@shields('npm')-->
[![npm version](https://img.shields.io/npm/v/@pnpm/fetch.svg)](https://www.npmjs.com/package/@pnpm/fetch)
[![npm version](https://img.shields.io/npm/v/@pnpm/network.fetch.svg)](https://npmx.dev/package/@pnpm/network.fetch)
<!--/@-->
## Installation
```sh
pnpm add @pnpm/fetch
pnpm add @pnpm/network.fetch
```
## License

6
network/git-utils/README.md
View File

@@ -1,15 +1,15 @@
# @pnpm/git-utils
# @pnpm/network.git-utils
> Utilities for git
<!--@shields('npm')-->
[![npm version](https://img.shields.io/npm/v/@pnpm/git-utils.svg)](https://www.npmjs.com/package/@pnpm/git-utils)
[![npm version](https://img.shields.io/npm/v/@pnpm/network.git-utils.svg)](https://npmx.dev/package/@pnpm/network.git-utils)
<!--/@-->
## Installation
```
pnpm add @pnpm/git-utils
pnpm add @pnpm/network.git-utils
```
## Usage

2
object/property-path/README.md
View File

@@ -3,7 +3,7 @@
> Basic library to manipulate object property path which includes dots and subscriptions
<!--@shields('npm')-->
[![npm version](https://img.shields.io/npm/v/@pnpm/object.property-path.svg)](https://www.npmjs.com/package/@pnpm/object.property-path)
[![npm version](https://img.shields.io/npm/v/@pnpm/object.property-path.svg)](https://npmx.dev/package/@pnpm/object.property-path)
<!--/@-->
## Installation

2
patching/apply-patch/README.md
View File

@@ -3,7 +3,7 @@
> Apply a patch to a directory
<!--@shields('npm')-->
[![npm version](https://img.shields.io/npm/v/@pnpm/patching.apply-patch.svg)](https://www.npmjs.com/package/@pnpm/patching.apply-patch)
[![npm version](https://img.shields.io/npm/v/@pnpm/patching.apply-patch.svg)](https://npmx.dev/package/@pnpm/patching.apply-patch)
<!--/@-->
## Installation

4
patching/commands/README.md
View File

@@ -1,11 +1,11 @@
# @pnpm/plugin-commands-patches
# @pnpm/patching.commands
> Commands for creating patches
## Installation
```sh
pnpm add @pnpm/plugin-commands-patching
pnpm add @pnpm/patching.commands
```
## License

2
patching/config/README.md
View File

@@ -3,7 +3,7 @@
> Functions related to patching configurations
<!--@shields('npm')-->
[![npm version](https://img.shields.io/npm/v/@pnpm/patching.config.svg)](https://www.npmjs.com/package/@pnpm/patching.config)
[![npm version](https://img.shields.io/npm/v/@pnpm/patching.config.svg)](https://npmx.dev/package/@pnpm/patching.config)
<!--/@-->
## Installation

2
patching/types/README.md
View File

@@ -3,7 +3,7 @@
> Types related to patching
<!--@shields('npm')-->
[![npm version](https://img.shields.io/npm/v/@pnpm/patching.types.svg)](https://www.npmjs.com/package/@pnpm/patching.types)
[![npm version](https://img.shields.io/npm/v/@pnpm/patching.types.svg)](https://npmx.dev/package/@pnpm/patching.types)
<!--/@-->
## Installation

8
pkg-manifest/reader/README.md
View File

@@ -1,21 +1,21 @@
# @pnpm/read-package-json
# @pnpm/pkg-manifest.reader
> Read a package.json
<!--@shields('npm')-->
[![npm version](https://img.shields.io/npm/v/@pnpm/read-package-json.svg)](https://www.npmjs.com/package/@pnpm/read-package-json)
[![npm version](https://img.shields.io/npm/v/@pnpm/pkg-manifest.reader.svg)](https://npmx.dev/package/@pnpm/pkg-manifest.reader)
<!--/@-->
## Installation
```sh
pnpm add @pnpm/read-package-json
pnpm add @pnpm/pkg-manifest.reader
```
## Usage
```ts
import { readPackageJson } from '@pnpm/read-package-json'
import { readPackageJson } from '@pnpm/pkg-manifest.reader'
const pkgJson = await readPackageJson('package.json')
```

4
pkg-manifest/utils/README.md
View File

@@ -1,11 +1,11 @@
# @pnpm/manifest-utils
# @pnpm/pkg-manifest.utils
> Utils for dealing with package manifest
## Installation
```
pnpm i @pnpm/manifest-utils
pnpm i @pnpm/pkg-manifest.utils
```

6
releasing/exportable-manifest/README.md
View File

@@ -1,13 +1,13 @@
# @pnpm/exportable-manifest
# @pnpm/releasing.exportable-manifest
> Creates an exportable manifest
[![npm version](https://img.shields.io/npm/v/@pnpm/exportable-manifest.svg)](https://www.npmjs.com/package/@pnpm/exportable-manifest)
[![npm version](https://img.shields.io/npm/v/@pnpm/releasing.exportable-manifest.svg)](https://npmx.dev/package/@pnpm/releasing.exportable-manifest)
## Installation
```sh
pnpm add @pnpm/exportable-manifest
pnpm add @pnpm/releasing.exportable-manifest
```
## License

6
resolving/default-resolver/README.md
View File

@@ -1,15 +1,15 @@
# @pnpm/default-resolver
# @pnpm/resolving.default-resolver
> pnpm's default package resolver
<!--@shields('npm')-->
[![npm version](https://img.shields.io/npm/v/@pnpm/default-resolver.svg)](https://www.npmjs.com/package/@pnpm/default-resolver)
[![npm version](https://img.shields.io/npm/v/@pnpm/resolving.default-resolver.svg)](https://npmx.dev/package/@pnpm/resolving.default-resolver)
<!--/@-->
## Installation
```sh
pnpm add @pnpm/default-resolver
pnpm add @pnpm/resolving.default-resolver
```
## License

8
resolving/git-resolver/README.md
View File

@@ -1,15 +1,15 @@
# @pnpm/git-resolver
# @pnpm/resolving.git-resolver
> Resolver for git-hosted packages
<!--@shields('npm')-->
[![npm version](https://img.shields.io/npm/v/@pnpm/git-resolver.svg)](https://www.npmjs.com/package/@pnpm/git-resolver)
[![npm version](https://img.shields.io/npm/v/@pnpm/resolving.git-resolver.svg)](https://npmx.dev/package/@pnpm/resolving.git-resolver)
<!--/@-->
## Installation
```
pnpm add @pnpm/git-resolver
pnpm add @pnpm/resolving.git-resolver
```
## Usage
@@ -17,7 +17,7 @@ pnpm add @pnpm/git-resolver
<!--@example('./example.js')-->
```js
'use strict'
const createResolveFromNpm = require('@pnpm/git-resolver').default
const createResolveFromNpm = require('@pnpm/resolving.git-resolver').default
const resolveFromNpm = createResolveFromNpm({})

2
resolving/jsr-specifier-parser/README.md
View File

@@ -3,7 +3,7 @@
> Parser of jsr specifiers
<!--@shields('npm')-->
[![npm version](https://img.shields.io/npm/v/@pnpm/resolving.jsr-specifier-parser.svg)](https://www.npmjs.com/package/@pnpm/resolving.jsr-specifier-parser)
[![npm version](https://img.shields.io/npm/v/@pnpm/resolving.jsr-specifier-parser.svg)](https://npmx.dev/package/@pnpm/resolving.jsr-specifier-parser)
<!--/@-->
## Installation

8
resolving/local-resolver/README.md
View File

@@ -1,22 +1,22 @@
# @pnpm/local-resolver
# @pnpm/resolving.local-resolver
> Resolver for local packages
<!--@shields('npm')-->
[![npm version](https://img.shields.io/npm/v/@pnpm/local-resolver.svg)](https://www.npmjs.com/package/@pnpm/local-resolver)
[![npm version](https://img.shields.io/npm/v/@pnpm/resolving.local-resolver.svg)](https://npmx.dev/package/@pnpm/resolving.local-resolver)
<!--/@-->
## Installation
```
pnpm add @pnpm/local-resolver
pnpm add @pnpm/resolving.local-resolver
```
## Usage
```js
'use strict'
const resolveFromLocal = require('@pnpm/local-resolver').default
const resolveFromLocal = require('@pnpm/resolving.local-resolver').default
resolveFromLocal({bareSpecifier: './example-package'}, {prefix: process.cwd()})
.then(resolveResult => console.log(resolveResult))

8
resolving/npm-resolver/README.md
View File

@@ -1,15 +1,15 @@
# @pnpm/npm-resolver
# @pnpm/resolving.npm-resolver
> Resolver for npm-hosted packages
<!--@shields('npm')-->
[![npm version](https://img.shields.io/npm/v/@pnpm/npm-resolver.svg)](https://www.npmjs.com/package/@pnpm/npm-resolver)
[![npm version](https://img.shields.io/npm/v/@pnpm/resolving.npm-resolver.svg)](https://npmx.dev/package/@pnpm/resolving.npm-resolver)
<!--/@-->
## Installation
```
pnpm add @pnpm/npm-resolver
pnpm add @pnpm/resolving.npm-resolver
```
## Usage
@@ -17,7 +17,7 @@ pnpm add @pnpm/npm-resolver
<!--@example('./example.js')-->
```js
'use strict'
const createResolveFromNpm = require('@pnpm/npm-resolver').default
const createResolveFromNpm = require('@pnpm/resolving.npm-resolver').default
const resolveFromNpm = createResolveFromNpm({
store: '.store',

4
resolving/parse-wanted-dependency/README.md
View File

@@ -1,11 +1,11 @@
# @pnpm/parse-wanted-dependency
# @pnpm/resolving.parse-wanted-dependency
> Parse dependency specifier
## Installation
```
pnpm i @pnpm/parse-wanted-dependency
pnpm i @pnpm/resolving.parse-wanted-dependency
```
## License

8
resolving/registry/pkg-metadata-filter/README.md
View File

@@ -1,21 +1,21 @@
# @pnpm/registry.pkg-metadata-filter
# @pnpm/resolving.registry.pkg-metadata-filter
> Filters the package metadata from the registry
<!--@shields('npm')-->
[![npm version](https://img.shields.io/npm/v/@pnpm/registry.pkg-metadata-filter.svg)](https://www.npmjs.com/package/@pnpm/registry.pkg-metadata-filter)
[![npm version](https://img.shields.io/npm/v/@pnpm/resolving.registry.pkg-metadata-filter.svg)](https://npmx.dev/package/@pnpm/resolving.registry.pkg-metadata-filter)
<!--/@-->
## Installation
```
pnpm add @pnpm/registry.pkg-metadata-filter
pnpm add @pnpm/resolving.registry.pkg-metadata-filter
```
## Usage
```ts
import { filterPkgMetadataByPublishDate } from '@pnpm/registry.pkg-metadata-filter'
import { filterPkgMetadataByPublishDate } from '@pnpm/resolving.registry.pkg-metadata-filter'
const pkgDoc = await (await fetch('https://registry.npmjs.org/is-odd')).json()

Some files were not shown because too many files have changed in this diff Show More