From 184ce26f3f5713b7b2c994b09aad448e980a62d0 Mon Sep 17 00:00:00 2001 From: Zoltan Kochan Date: Thu, 30 Apr 2026 18:59:49 +0200 Subject: [PATCH] docs: fix package names in README files (#11409) * docs: fix package names in README files * docs: update links to point to npmx.dev --- .changeset/fiery-parts-clap.md | 96 +++++++++++++++++++ bins/linker/README.md | 8 +- bins/remover/README.md | 4 +- bins/resolver/README.md | 8 +- building/after-install/README.md | 2 +- building/during-install/README.md | 6 +- building/pkg-requires-build/README.md | 6 +- building/policy/README.md | 4 +- cache/api/README.md | 2 +- cache/commands/README.md | 2 +- cli/command/README.md | 6 +- cli/common-cli-options-help/README.md | 6 +- cli/default-reporter/README.md | 6 +- cli/meta/README.md | 6 +- cli/parse-cli-args/README.md | 6 +- cli/utils/README.md | 6 +- config/commands/README.md | 6 +- config/matcher/README.md | 6 +- config/normalize-registries/README.md | 6 +- config/package-is-installable/README.md | 4 +- config/parse-overrides/README.md | 6 +- config/pick-registry-for-package/README.md | 4 +- config/reader/README.md | 8 +- config/writer/README.md | 6 +- core/constants/README.md | 2 +- core/error/README.md | 2 +- core/logger/README.md | 4 +- core/types/README.md | 2 +- deps/compliance/audit/README.md | 6 +- deps/compliance/license-resolver/README.md | 2 +- deps/compliance/license-scanner/README.md | 6 +- deps/graph-builder/README.md | 2 +- deps/graph-hasher/README.md | 6 +- deps/inspection/list/README.md | 6 +- deps/inspection/outdated/README.md | 6 +- deps/inspection/tree-builder/README.md | 6 +- deps/path/README.md | 8 +- deps/peer-range/README.md | 6 +- deps/status/README.md | 2 +- engine/runtime/bun-resolver/README.md | 2 +- engine/runtime/deno-resolver/README.md | 2 +- engine/runtime/node-resolver/README.md | 2 +- engine/runtime/system-node-version/README.md | 6 +- exec/commands/README.md | 6 +- exec/lifecycle/README.md | 8 +- exec/pnpm-cli-runner/README.md | 2 +- exec/prepare-package/README.md | 6 +- fetching/directory-fetcher/README.md | 6 +- fetching/fetcher-base/README.md | 10 +- fetching/git-fetcher/README.md | 6 +- fetching/pick-fetcher/README.md | 6 +- fetching/tarball-fetcher/README.md | 6 +- fetching/types/README.md | 2 +- fs/graceful-fs/README.md | 6 +- fs/hard-link-dir/README.md | 2 +- fs/indexed-pkg-importer/README.md | 4 +- fs/is-empty-dir-or-nothing/README.md | 2 +- fs/packlist/README.md | 2 +- fs/read-modules-dir/README.md | 2 +- fs/symlink-dependency/README.md | 6 +- hooks/pnpmfile/README.md | 6 +- hooks/types/README.md | 2 +- installing/client/README.md | 6 +- installing/commands/README.md | 6 +- installing/context/README.md | 6 +- installing/dedupe/check/README.md | 4 +- installing/dedupe/issues-renderer/README.md | 4 +- installing/dedupe/types/README.md | 4 +- installing/deps-installer/README.md | 8 +- installing/deps-restorer/README.md | 4 +- installing/env-installer/README.md | 2 +- .../linking/direct-dep-linker/README.md | 4 +- installing/linking/hoist/README.md | 4 +- installing/linking/modules-cleaner/README.md | 4 +- installing/linking/real-hoist/README.md | 4 +- installing/modules-yaml/README.md | 8 +- installing/package-requester/README.md | 6 +- installing/read-projects-context/README.md | 2 +- lockfile/make-dedicated-lockfile/README.md | 6 +- lockfile/to-pnp/README.md | 6 +- lockfile/verification/README.md | 2 +- modules-mounter/daemon/README.md | 6 +- network/auth-header/README.md | 2 +- network/fetch/README.md | 6 +- network/git-utils/README.md | 6 +- object/property-path/README.md | 2 +- patching/apply-patch/README.md | 2 +- patching/commands/README.md | 4 +- patching/config/README.md | 2 +- patching/types/README.md | 2 +- pkg-manifest/reader/README.md | 8 +- pkg-manifest/utils/README.md | 4 +- releasing/exportable-manifest/README.md | 6 +- resolving/default-resolver/README.md | 6 +- resolving/git-resolver/README.md | 8 +- resolving/jsr-specifier-parser/README.md | 2 +- resolving/local-resolver/README.md | 8 +- resolving/npm-resolver/README.md | 8 +- resolving/parse-wanted-dependency/README.md | 4 +- .../registry/pkg-metadata-filter/README.md | 8 +- resolving/registry/types/README.md | 6 +- resolving/resolver-base/README.md | 10 +- resolving/tarball-resolver/README.md | 8 +- shell/path/README.md | 6 +- store/cafs-types/README.md | 4 +- store/cafs/README.md | 2 +- store/connection-manager/README.md | 6 +- store/controller-types/README.md | 2 +- store/controller/README.md | 4 +- store/create-cafs-store/README.md | 4 +- store/path/README.md | 8 +- text/naming-cases/README.md | 6 +- worker/README.md | 2 +- workspace/commands/README.md | 6 +- workspace/injected-deps-syncer/README.md | 2 +- workspace/project-manifest-reader/README.md | 8 +- workspace/project-manifest-writer/README.md | 8 +- workspace/projects-filter/README.md | 6 +- workspace/projects-graph/README.md | 2 +- workspace/projects-reader/README.md | 6 +- workspace/projects-sorter/README.md | 2 +- workspace/range-resolver/README.md | 4 +- workspace/root-finder/README.md | 6 +- workspace/spec-parser/README.md | 2 +- workspace/state/README.md | 2 +- yaml/document-sync/README.md | 4 +- 126 files changed, 397 insertions(+), 301 deletions(-) create mode 100644 .changeset/fiery-parts-clap.md diff --git a/.changeset/fiery-parts-clap.md b/.changeset/fiery-parts-clap.md new file mode 100644 index 0000000000..c398fecdc9 --- /dev/null +++ b/.changeset/fiery-parts-clap.md @@ -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. diff --git a/bins/linker/README.md b/bins/linker/README.md index bb82d7a619..b308f0b8ad 100644 --- a/bins/linker/README.md +++ b/bins/linker/README.md @@ -1,21 +1,21 @@ -# @pnpm/link-bins +# @pnpm/bins.linker > Link bins to node_modules/.bin -[![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) } diff --git a/bins/remover/README.md b/bins/remover/README.md index 4f8534f64c..0b6139f007 100644 --- a/bins/remover/README.md +++ b/bins/remover/README.md @@ -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 diff --git a/bins/resolver/README.md b/bins/resolver/README.md index d85cbf0b38..d5124fe154 100644 --- a/bins/resolver/README.md +++ b/bins/resolver/README.md @@ -1,21 +1,21 @@ -# @pnpm/package-bins +# @pnpm/bins.resolver > Returns bins of a package -[![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'}] diff --git a/building/after-install/README.md b/building/after-install/README.md index 6d91e786f9..281449df74 100644 --- a/building/after-install/README.md +++ b/building/after-install/README.md @@ -3,7 +3,7 @@ > Rebuild packages that are already installed by running their lifecycle scripts -[![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 diff --git a/building/during-install/README.md b/building/during-install/README.md index edb139a58a..05dd2ed44d 100644 --- a/building/during-install/README.md +++ b/building/during-install/README.md @@ -1,15 +1,15 @@ -# @pnpm/build-modules +# @pnpm/building.during-install > Build packages in node_modules -[![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 diff --git a/building/pkg-requires-build/README.md b/building/pkg-requires-build/README.md index 11e0f72259..10a9305d4a 100644 --- a/building/pkg-requires-build/README.md +++ b/building/pkg-requires-build/README.md @@ -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 diff --git a/building/policy/README.md b/building/policy/README.md index 448236e599..08b70ca39a 100644 --- a/building/policy/README.md +++ b/building/policy/README.md @@ -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 diff --git a/cache/api/README.md b/cache/api/README.md index 6a91bc32a9..0af41c0703 100644 --- a/cache/api/README.md +++ b/cache/api/README.md @@ -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 diff --git a/cache/commands/README.md b/cache/commands/README.md index a48d38cd6e..d4f3cfe9a2 100644 --- a/cache/commands/README.md +++ b/cache/commands/README.md @@ -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 diff --git a/cli/command/README.md b/cli/command/README.md index e6914c73dd..99d3ec7eb2 100644 --- a/cli/command/README.md +++ b/cli/command/README.md @@ -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 diff --git a/cli/common-cli-options-help/README.md b/cli/common-cli-options-help/README.md index a9223d5a7f..039251a00c 100644 --- a/cli/common-cli-options-help/README.md +++ b/cli/common-cli-options-help/README.md @@ -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 diff --git a/cli/default-reporter/README.md b/cli/default-reporter/README.md index 325cd21435..20848ce338 100644 --- a/cli/default-reporter/README.md +++ b/cli/default-reporter/README.md @@ -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: { diff --git a/cli/meta/README.md b/cli/meta/README.md index b98cc34781..63e65651d7 100644 --- a/cli/meta/README.md +++ b/cli/meta/README.md @@ -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 diff --git a/cli/parse-cli-args/README.md b/cli/parse-cli-args/README.md index 1d96f73e67..36b5583e3f 100644 --- a/cli/parse-cli-args/README.md +++ b/cli/parse-cli-args/README.md @@ -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 diff --git a/cli/utils/README.md b/cli/utils/README.md index 23309766c2..cb454d2eba 100644 --- a/cli/utils/README.md +++ b/cli/utils/README.md @@ -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 diff --git a/config/commands/README.md b/config/commands/README.md index a02fa4c6ed..d77dcbac54 100644 --- a/config/commands/README.md +++ b/config/commands/README.md @@ -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 diff --git a/config/matcher/README.md b/config/matcher/README.md index ce4cec56bc..b31543b266 100644 --- a/config/matcher/README.md +++ b/config/matcher/README.md @@ -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') diff --git a/config/normalize-registries/README.md b/config/normalize-registries/README.md index 14765236ec..af3b2a8916 100644 --- a/config/normalize-registries/README.md +++ b/config/normalize-registries/README.md @@ -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', diff --git a/config/package-is-installable/README.md b/config/package-is-installable/README.md index 570800fe23..55c535ff7f 100644 --- a/config/package-is-installable/README.md +++ b/config/package-is-installable/README.md @@ -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 diff --git a/config/parse-overrides/README.md b/config/parse-overrides/README.md index aeb5d0598b..3db4ba2edd 100644 --- a/config/parse-overrides/README.md +++ b/config/parse-overrides/README.md @@ -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', diff --git a/config/pick-registry-for-package/README.md b/config/pick-registry-for-package/README.md index cc02dea08d..4c02915b26 100644 --- a/config/pick-registry-for-package/README.md +++ b/config/pick-registry-for-package/README.md @@ -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 diff --git a/config/reader/README.md b/config/reader/README.md index 94055e754c..c5b88cbe6a 100644 --- a/config/reader/README.md +++ b/config/reader/README.md @@ -1,21 +1,21 @@ -# @pnpm/config +# @pnpm/config.reader > Gets configuration options for pnpm -[![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)) ``` diff --git a/config/writer/README.md b/config/writer/README.md index df9c9f5b4c..4cfcbcd0c6 100644 --- a/config/writer/README.md +++ b/config/writer/README.md @@ -1,15 +1,15 @@ -# @pnpm/config.config-writer +# @pnpm/config.writer > Functions for updating the configuration settings -[![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 diff --git a/core/constants/README.md b/core/constants/README.md index 1cc54bda2b..8d38999bb7 100644 --- a/core/constants/README.md +++ b/core/constants/README.md @@ -3,7 +3,7 @@ > pnpm constants -[![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 diff --git a/core/error/README.md b/core/error/README.md index 65d016a515..8208a98d87 100644 --- a/core/error/README.md +++ b/core/error/README.md @@ -3,7 +3,7 @@ > An error class for pnpm errors -[![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 diff --git a/core/logger/README.md b/core/logger/README.md index 3879989f17..5880b4c095 100644 --- a/core/logger/README.md +++ b/core/logger/README.md @@ -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()`. diff --git a/core/types/README.md b/core/types/README.md index 7be57caa67..7b632271c5 100644 --- a/core/types/README.md +++ b/core/types/README.md @@ -3,7 +3,7 @@ > Basic types used by pnpm -[![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 diff --git a/deps/compliance/audit/README.md b/deps/compliance/audit/README.md index 6334a888bb..4c1fe79575 100644 --- a/deps/compliance/audit/README.md +++ b/deps/compliance/audit/README.md @@ -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 diff --git a/deps/compliance/license-resolver/README.md b/deps/compliance/license-resolver/README.md index 6c6a8b1831..91d5cddcac 100644 --- a/deps/compliance/license-resolver/README.md +++ b/deps/compliance/license-resolver/README.md @@ -3,7 +3,7 @@ > Resolve a package's license from its manifest or on-disk LICENSE file -[![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 diff --git a/deps/compliance/license-scanner/README.md b/deps/compliance/license-scanner/README.md index 87368e8cfc..e530d9526d 100644 --- a/deps/compliance/license-scanner/README.md +++ b/deps/compliance/license-scanner/README.md @@ -1,15 +1,15 @@ -# @pnpm/license-scanner +# @pnpm/deps.compliance.license-scanner > Check for the license of packages -[![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 diff --git a/deps/graph-builder/README.md b/deps/graph-builder/README.md index 1c8ce7781a..25ec5ab8b0 100644 --- a/deps/graph-builder/README.md +++ b/deps/graph-builder/README.md @@ -5,7 +5,7 @@ ## Installation ``` -pnpm install @pnpm/deps.graph.builder +pnpm install @pnpm/deps.graph-builder ``` ## License diff --git a/deps/graph-hasher/README.md b/deps/graph-hasher/README.md index d41852167a..e82fcc6f80 100644 --- a/deps/graph-hasher/README.md +++ b/deps/graph-hasher/README.md @@ -1,15 +1,15 @@ -# @pnpm/calc-dep-state +# @pnpm/deps.graph-hasher > Calculates the state of a dependency -[![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 diff --git a/deps/inspection/list/README.md b/deps/inspection/list/README.md index 08c7f0a7ad..f3163cf975 100644 --- a/deps/inspection/list/README.md +++ b/deps/inspection/list/README.md @@ -1,15 +1,15 @@ -# @pnpm/list +# @pnpm/deps.inspection.list > List installed packages in a symlinked \`node_modules\` -[![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 diff --git a/deps/inspection/outdated/README.md b/deps/inspection/outdated/README.md index 18f5cb2075..883fa231d1 100644 --- a/deps/inspection/outdated/README.md +++ b/deps/inspection/outdated/README.md @@ -1,15 +1,15 @@ -# @pnpm/outdated +# @pnpm/deps.inspection.outdated > Check for outdated packages -[![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 diff --git a/deps/inspection/tree-builder/README.md b/deps/inspection/tree-builder/README.md index ba6a2cfd96..cbe824ef06 100644 --- a/deps/inspection/tree-builder/README.md +++ b/deps/inspection/tree-builder/README.md @@ -1,9 +1,9 @@ -# @pnpm/reviewing.tree-builder +# @pnpm/deps.inspection.tree-builder > Creates a dependencies hierarchy for a symlinked \`node_modules\` -[![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 diff --git a/deps/path/README.md b/deps/path/README.md index 32159353d1..db0cc78de1 100644 --- a/deps/path/README.md +++ b/deps/path/README.md @@ -1,9 +1,9 @@ -# @pnpm/dependency-path +# @pnpm/deps.path > Utilities for working with symlinked node_modules -[![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 ```js -const dependencyPath = require('@pnpm/dependency-path') +const dependencyPath = require('@pnpm/deps.path') const registry = 'https://registry.npmjs.org/' diff --git a/deps/peer-range/README.md b/deps/peer-range/README.md index 5b8eda0fc1..b0f26c8c34 100644 --- a/deps/peer-range/README.md +++ b/deps/peer-range/README.md @@ -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 diff --git a/deps/status/README.md b/deps/status/README.md index 0d6c9dce09..505c1c3cde 100644 --- a/deps/status/README.md +++ b/deps/status/README.md @@ -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 diff --git a/engine/runtime/bun-resolver/README.md b/engine/runtime/bun-resolver/README.md index 1f36f35154..0f057aa9c4 100644 --- a/engine/runtime/bun-resolver/README.md +++ b/engine/runtime/bun-resolver/README.md @@ -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 diff --git a/engine/runtime/deno-resolver/README.md b/engine/runtime/deno-resolver/README.md index 553ea7e85e..1eceddef53 100644 --- a/engine/runtime/deno-resolver/README.md +++ b/engine/runtime/deno-resolver/README.md @@ -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 diff --git a/engine/runtime/node-resolver/README.md b/engine/runtime/node-resolver/README.md index d1cd87dddf..3b120ac228 100644 --- a/engine/runtime/node-resolver/README.md +++ b/engine/runtime/node-resolver/README.md @@ -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 diff --git a/engine/runtime/system-node-version/README.md b/engine/runtime/system-node-version/README.md index bc8c4942c6..07aba3d15e 100644 --- a/engine/runtime/system-node-version/README.md +++ b/engine/runtime/system-node-version/README.md @@ -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 diff --git a/exec/commands/README.md b/exec/commands/README.md index 91e1fce342..9f0f4be485 100644 --- a/exec/commands/README.md +++ b/exec/commands/README.md @@ -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 diff --git a/exec/lifecycle/README.md b/exec/lifecycle/README.md index 578f32690a..f6e9a4b67f 100644 --- a/exec/lifecycle/README.md +++ b/exec/lifecycle/README.md @@ -1,21 +1,21 @@ -# @pnpm/lifecycle +# @pnpm/exec.lifecycle > Package lifecycle hook runner -[![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')) diff --git a/exec/pnpm-cli-runner/README.md b/exec/pnpm-cli-runner/README.md index faf83a600a..a329768970 100644 --- a/exec/pnpm-cli-runner/README.md +++ b/exec/pnpm-cli-runner/README.md @@ -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 diff --git a/exec/prepare-package/README.md b/exec/prepare-package/README.md index 928012e839..e86bfe3639 100644 --- a/exec/prepare-package/README.md +++ b/exec/prepare-package/README.md @@ -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 diff --git a/fetching/directory-fetcher/README.md b/fetching/directory-fetcher/README.md index 1718a3db4c..5cb50fe6a2 100644 --- a/fetching/directory-fetcher/README.md +++ b/fetching/directory-fetcher/README.md @@ -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 diff --git a/fetching/fetcher-base/README.md b/fetching/fetcher-base/README.md index 41829f3eac..7b0a22a2ee 100644 --- a/fetching/fetcher-base/README.md +++ b/fetching/fetcher-base/README.md @@ -1,27 +1,27 @@ -# @pnpm/fetcher-base +# @pnpm/fetching.fetcher-base > Types for pnpm-compatible fetchers -[![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, diff --git a/fetching/git-fetcher/README.md b/fetching/git-fetcher/README.md index 9e1e11a4ac..3cff1a90c3 100644 --- a/fetching/git-fetcher/README.md +++ b/fetching/git-fetcher/README.md @@ -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 diff --git a/fetching/pick-fetcher/README.md b/fetching/pick-fetcher/README.md index a862dc1f6e..0684f34ede 100644 --- a/fetching/pick-fetcher/README.md +++ b/fetching/pick-fetcher/README.md @@ -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 diff --git a/fetching/tarball-fetcher/README.md b/fetching/tarball-fetcher/README.md index ac0075aead..9d5d921977 100644 --- a/fetching/tarball-fetcher/README.md +++ b/fetching/tarball-fetcher/README.md @@ -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 diff --git a/fetching/types/README.md b/fetching/types/README.md index 55b080426e..322eb1720e 100644 --- a/fetching/types/README.md +++ b/fetching/types/README.md @@ -1,4 +1,4 @@ -# @pnpm/fetching-types +# @pnpm/fetching.types > Types for the fetching diff --git a/fs/graceful-fs/README.md b/fs/graceful-fs/README.md index 56c4a1bb7f..3c5f5f2394 100644 --- a/fs/graceful-fs/README.md +++ b/fs/graceful-fs/README.md @@ -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 diff --git a/fs/hard-link-dir/README.md b/fs/hard-link-dir/README.md index 022d0a2404..0b1f7cb86f 100644 --- a/fs/hard-link-dir/README.md +++ b/fs/hard-link-dir/README.md @@ -3,7 +3,7 @@ > Hard link (or copy if linking fails) all files from a directory to several target directories. -[![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 diff --git a/fs/indexed-pkg-importer/README.md b/fs/indexed-pkg-importer/README.md index d703a7cad6..d62d347fb2 100644 --- a/fs/indexed-pkg-importer/README.md +++ b/fs/indexed-pkg-importer/README.md @@ -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 diff --git a/fs/is-empty-dir-or-nothing/README.md b/fs/is-empty-dir-or-nothing/README.md index 1f40773a34..2c24e284f9 100644 --- a/fs/is-empty-dir-or-nothing/README.md +++ b/fs/is-empty-dir-or-nothing/README.md @@ -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 diff --git a/fs/packlist/README.md b/fs/packlist/README.md index d691f6dd2a..26d67433cd 100644 --- a/fs/packlist/README.md +++ b/fs/packlist/README.md @@ -3,7 +3,7 @@ > Get a list of the files to add from a directory into an npm package -[![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 diff --git a/fs/read-modules-dir/README.md b/fs/read-modules-dir/README.md index 0cafda7939..d1c15c874a 100644 --- a/fs/read-modules-dir/README.md +++ b/fs/read-modules-dir/README.md @@ -1,3 +1,3 @@ -# @pnpm/read-modules-dir +# @pnpm/fs.read-modules-dir > Finds all direct packages in node_modules diff --git a/fs/symlink-dependency/README.md b/fs/symlink-dependency/README.md index 8440a34f31..421e8b82f3 100644 --- a/fs/symlink-dependency/README.md +++ b/fs/symlink-dependency/README.md @@ -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 } diff --git a/hooks/pnpmfile/README.md b/hooks/pnpmfile/README.md index 12fa8a984c..3252eb3b2d 100644 --- a/hooks/pnpmfile/README.md +++ b/hooks/pnpmfile/README.md @@ -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 diff --git a/hooks/types/README.md b/hooks/types/README.md index ed1dd80480..d54dc5f1de 100644 --- a/hooks/types/README.md +++ b/hooks/types/README.md @@ -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 diff --git a/installing/client/README.md b/installing/client/README.md index 4286d7d988..b8a6a38add 100644 --- a/installing/client/README.md +++ b/installing/client/README.md @@ -1,15 +1,15 @@ -# @pnpm/client +# @pnpm/installing.client > Creates the package resolve and fetch functions -[![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 diff --git a/installing/commands/README.md b/installing/commands/README.md index 7da77ec2cb..f971a0d6f7 100644 --- a/installing/commands/README.md +++ b/installing/commands/README.md @@ -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 diff --git a/installing/context/README.md b/installing/context/README.md index 9e0746271b..5c5f5f46ea 100644 --- a/installing/context/README.md +++ b/installing/context/README.md @@ -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 diff --git a/installing/dedupe/check/README.md b/installing/dedupe/check/README.md index f25d252544..0685d6b128 100644 --- a/installing/dedupe/check/README.md +++ b/installing/dedupe/check/README.md @@ -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 diff --git a/installing/dedupe/issues-renderer/README.md b/installing/dedupe/issues-renderer/README.md index c4a7dc0c89..4cc77e9cd7 100644 --- a/installing/dedupe/issues-renderer/README.md +++ b/installing/dedupe/issues-renderer/README.md @@ -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 diff --git a/installing/dedupe/types/README.md b/installing/dedupe/types/README.md index ba9917afb0..61d4c45ec6 100644 --- a/installing/dedupe/types/README.md +++ b/installing/dedupe/types/README.md @@ -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 diff --git a/installing/deps-installer/README.md b/installing/deps-installer/README.md index 17fea22209..2a42a0b5d7 100644 --- a/installing/deps-installer/README.md +++ b/installing/deps-installer/README.md @@ -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` 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: { diff --git a/installing/deps-restorer/README.md b/installing/deps-restorer/README.md index e1c4c6efe2..9cb1421f12 100644 --- a/installing/deps-restorer/README.md +++ b/installing/deps-restorer/README.md @@ -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 diff --git a/installing/env-installer/README.md b/installing/env-installer/README.md index 629ee22e6e..138e880acf 100644 --- a/installing/env-installer/README.md +++ b/installing/env-installer/README.md @@ -3,7 +3,7 @@ > Installer for configurational dependencies -[![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 diff --git a/installing/linking/direct-dep-linker/README.md b/installing/linking/direct-dep-linker/README.md index 95e550026c..11e28868a4 100644 --- a/installing/linking/direct-dep-linker/README.md +++ b/installing/linking/direct-dep-linker/README.md @@ -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 diff --git a/installing/linking/hoist/README.md b/installing/linking/hoist/README.md index ed90131c97..877733620e 100644 --- a/installing/linking/hoist/README.md +++ b/installing/linking/hoist/README.md @@ -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 diff --git a/installing/linking/modules-cleaner/README.md b/installing/linking/modules-cleaner/README.md index ad8c1b0b1f..9d1e99c7b5 100644 --- a/installing/linking/modules-cleaner/README.md +++ b/installing/linking/modules-cleaner/README.md @@ -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 diff --git a/installing/linking/real-hoist/README.md b/installing/linking/real-hoist/README.md index 5453316cc0..cfbd8a5781 100644 --- a/installing/linking/real-hoist/README.md +++ b/installing/linking/real-hoist/README.md @@ -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 diff --git a/installing/modules-yaml/README.md b/installing/modules-yaml/README.md index 39349aca87..609aaaf5d3 100644 --- a/installing/modules-yaml/README.md +++ b/installing/modules-yaml/README.md @@ -1,21 +1,21 @@ -# @pnpm/modules-yaml +# @pnpm/installing.modules-yaml > Reads/writes \`node_modules/.modules.yaml\` -[![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: {}, diff --git a/installing/package-requester/README.md b/installing/package-requester/README.md index bf7ea6aa95..cd24e47ff2 100644 --- a/installing/package-requester/README.md +++ b/installing/package-requester/README.md @@ -1,15 +1,15 @@ -# @pnpm/package-requester +# @pnpm/installing.package-requester > Concurrent downloader of npm-compatible packages -[![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 diff --git a/installing/read-projects-context/README.md b/installing/read-projects-context/README.md index 2858af039a..cd159f7c6c 100644 --- a/installing/read-projects-context/README.md +++ b/installing/read-projects-context/README.md @@ -1,3 +1,3 @@ -# @pnpm/read-projects-context +# @pnpm/installing.read-projects-context > Reads the current state of projects from modules manifest diff --git a/lockfile/make-dedicated-lockfile/README.md b/lockfile/make-dedicated-lockfile/README.md index bf878d0f19..03e38dc6df 100644 --- a/lockfile/make-dedicated-lockfile/README.md +++ b/lockfile/make-dedicated-lockfile/README.md @@ -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 diff --git a/lockfile/to-pnp/README.md b/lockfile/to-pnp/README.md index 2566d0ac7d..b0283d9b08 100644 --- a/lockfile/to-pnp/README.md +++ b/lockfile/to-pnp/README.md @@ -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 diff --git a/lockfile/verification/README.md b/lockfile/verification/README.md index 4b8d056277..261cb3f482 100644 --- a/lockfile/verification/README.md +++ b/lockfile/verification/README.md @@ -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 diff --git a/modules-mounter/daemon/README.md b/modules-mounter/daemon/README.md index 7b7848d93e..29307df550 100644 --- a/modules-mounter/daemon/README.md +++ b/modules-mounter/daemon/README.md @@ -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 diff --git a/network/auth-header/README.md b/network/auth-header/README.md index 0735ab3318..c4a95d5bab 100644 --- a/network/auth-header/README.md +++ b/network/auth-header/README.md @@ -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 diff --git a/network/fetch/README.md b/network/fetch/README.md index eea0e2a1bb..b23951b8cc 100644 --- a/network/fetch/README.md +++ b/network/fetch/README.md @@ -1,15 +1,15 @@ -# @pnpm/fetch +# @pnpm/network.fetch > node-fetch with retries -[![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 diff --git a/network/git-utils/README.md b/network/git-utils/README.md index 7ccb101690..f647dcefe8 100644 --- a/network/git-utils/README.md +++ b/network/git-utils/README.md @@ -1,15 +1,15 @@ -# @pnpm/git-utils +# @pnpm/network.git-utils > Utilities for git -[![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 diff --git a/object/property-path/README.md b/object/property-path/README.md index 5f4074a833..4a0c26b887 100644 --- a/object/property-path/README.md +++ b/object/property-path/README.md @@ -3,7 +3,7 @@ > Basic library to manipulate object property path which includes dots and subscriptions -[![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 diff --git a/patching/apply-patch/README.md b/patching/apply-patch/README.md index 4f1a8a9d5d..fdde703630 100644 --- a/patching/apply-patch/README.md +++ b/patching/apply-patch/README.md @@ -3,7 +3,7 @@ > Apply a patch to a directory -[![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 diff --git a/patching/commands/README.md b/patching/commands/README.md index 0044663059..befec6232f 100644 --- a/patching/commands/README.md +++ b/patching/commands/README.md @@ -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 diff --git a/patching/config/README.md b/patching/config/README.md index 5d553686c4..5a551bca63 100644 --- a/patching/config/README.md +++ b/patching/config/README.md @@ -3,7 +3,7 @@ > Functions related to patching configurations -[![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 diff --git a/patching/types/README.md b/patching/types/README.md index a0a6c10674..91e1c95831 100644 --- a/patching/types/README.md +++ b/patching/types/README.md @@ -3,7 +3,7 @@ > Types related to patching -[![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 diff --git a/pkg-manifest/reader/README.md b/pkg-manifest/reader/README.md index 69f772a246..a3700b93f2 100644 --- a/pkg-manifest/reader/README.md +++ b/pkg-manifest/reader/README.md @@ -1,21 +1,21 @@ -# @pnpm/read-package-json +# @pnpm/pkg-manifest.reader > Read a package.json -[![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') ``` diff --git a/pkg-manifest/utils/README.md b/pkg-manifest/utils/README.md index 93e05cd6ef..1b7b8060d8 100644 --- a/pkg-manifest/utils/README.md +++ b/pkg-manifest/utils/README.md @@ -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 ``` diff --git a/releasing/exportable-manifest/README.md b/releasing/exportable-manifest/README.md index e826694813..2a6b399c9d 100644 --- a/releasing/exportable-manifest/README.md +++ b/releasing/exportable-manifest/README.md @@ -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 diff --git a/resolving/default-resolver/README.md b/resolving/default-resolver/README.md index 78b7243621..f0dd08aabd 100644 --- a/resolving/default-resolver/README.md +++ b/resolving/default-resolver/README.md @@ -1,15 +1,15 @@ -# @pnpm/default-resolver +# @pnpm/resolving.default-resolver > pnpm's default package resolver -[![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 diff --git a/resolving/git-resolver/README.md b/resolving/git-resolver/README.md index 607ff2407b..3ef57a547a 100644 --- a/resolving/git-resolver/README.md +++ b/resolving/git-resolver/README.md @@ -1,15 +1,15 @@ -# @pnpm/git-resolver +# @pnpm/resolving.git-resolver > Resolver for git-hosted packages -[![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 ```js 'use strict' -const createResolveFromNpm = require('@pnpm/git-resolver').default +const createResolveFromNpm = require('@pnpm/resolving.git-resolver').default const resolveFromNpm = createResolveFromNpm({}) diff --git a/resolving/jsr-specifier-parser/README.md b/resolving/jsr-specifier-parser/README.md index 8fd35d4dfd..341d069b37 100644 --- a/resolving/jsr-specifier-parser/README.md +++ b/resolving/jsr-specifier-parser/README.md @@ -3,7 +3,7 @@ > Parser of jsr specifiers -[![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 diff --git a/resolving/local-resolver/README.md b/resolving/local-resolver/README.md index ff2f7c2f40..e6668bbcbd 100644 --- a/resolving/local-resolver/README.md +++ b/resolving/local-resolver/README.md @@ -1,22 +1,22 @@ -# @pnpm/local-resolver +# @pnpm/resolving.local-resolver > Resolver for local packages -[![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)) diff --git a/resolving/npm-resolver/README.md b/resolving/npm-resolver/README.md index 62baf9fa9a..95dc7309d1 100644 --- a/resolving/npm-resolver/README.md +++ b/resolving/npm-resolver/README.md @@ -1,15 +1,15 @@ -# @pnpm/npm-resolver +# @pnpm/resolving.npm-resolver > Resolver for npm-hosted packages -[![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 ```js 'use strict' -const createResolveFromNpm = require('@pnpm/npm-resolver').default +const createResolveFromNpm = require('@pnpm/resolving.npm-resolver').default const resolveFromNpm = createResolveFromNpm({ store: '.store', diff --git a/resolving/parse-wanted-dependency/README.md b/resolving/parse-wanted-dependency/README.md index 04050b2ff8..43717c44f2 100644 --- a/resolving/parse-wanted-dependency/README.md +++ b/resolving/parse-wanted-dependency/README.md @@ -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 diff --git a/resolving/registry/pkg-metadata-filter/README.md b/resolving/registry/pkg-metadata-filter/README.md index d2c4b08ef8..bf777027fc 100644 --- a/resolving/registry/pkg-metadata-filter/README.md +++ b/resolving/registry/pkg-metadata-filter/README.md @@ -1,21 +1,21 @@ -# @pnpm/registry.pkg-metadata-filter +# @pnpm/resolving.registry.pkg-metadata-filter > Filters the package metadata from the registry -[![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() diff --git a/resolving/registry/types/README.md b/resolving/registry/types/README.md index 11ff04db2f..f794cc023c 100644 --- a/resolving/registry/types/README.md +++ b/resolving/registry/types/README.md @@ -1,15 +1,15 @@ -# @pnpm/registry.types +# @pnpm/resolving.registry.types > Types related to the npm registry -[![npm version](https://img.shields.io/npm/v/@pnpm/registry.types.svg)](https://www.npmjs.com/package/@pnpm/registry.types) +[![npm version](https://img.shields.io/npm/v/@pnpm/resolving.registry.types.svg)](https://npmx.dev/package/@pnpm/resolving.registry.types) ## Installation ``` -pnpm add @pnpm/registry.types +pnpm add @pnpm/resolving.registry.types ``` ## License diff --git a/resolving/resolver-base/README.md b/resolving/resolver-base/README.md index 7e25cc6849..9f494969f0 100644 --- a/resolving/resolver-base/README.md +++ b/resolving/resolver-base/README.md @@ -1,27 +1,27 @@ -# @pnpm/resolver-base +# @pnpm/resolving.resolver-base > Types for pnpm-compatible resolvers -[![npm version](https://img.shields.io/npm/v/@pnpm/resolver-base.svg)](https://www.npmjs.com/package/@pnpm/resolver-base) +[![npm version](https://img.shields.io/npm/v/@pnpm/resolving.resolver-base.svg)](https://npmx.dev/package/@pnpm/resolving.resolver-base) ## Installation ```sh -pnpm add @pnpm/resolver-base +pnpm add @pnpm/resolving.resolver-base ``` ## Usage -Here's a template of a resolver using types from `@pnpm/resolver-base`: +Here's a template of a resolver using types from `@pnpm/resolving.resolver-base`: ```ts import { ResolveOptions, ResolveResult, WantedDependency, -} from '@pnpm/resolver-base' +} from '@pnpm/resolving.resolver-base' export async function testResolver ( wantedDependency: WantedDependency, diff --git a/resolving/tarball-resolver/README.md b/resolving/tarball-resolver/README.md index 365752ad0e..063bb90167 100644 --- a/resolving/tarball-resolver/README.md +++ b/resolving/tarball-resolver/README.md @@ -1,15 +1,15 @@ -# @pnpm/tarball-resolver +# @pnpm/resolving.tarball-resolver > Resolver for tarball dependencies -[![npm version](https://img.shields.io/npm/v/@pnpm/tarball-resolver.svg)](https://www.npmjs.com/package/@pnpm/tarball-resolver) +[![npm version](https://img.shields.io/npm/v/@pnpm/resolving.tarball-resolver.svg)](https://npmx.dev/package/@pnpm/resolving.tarball-resolver) ## Installation ```sh -pnpm add @pnpm/tarball-resolver +pnpm add @pnpm/resolving.tarball-resolver ``` ## Usage @@ -17,7 +17,7 @@ pnpm add @pnpm/tarball-resolver ```js 'use strict' -const resolveFromTarball = require('@pnpm/tarball-resolver').default +const resolveFromTarball = require('@pnpm/resolving.tarball-resolver').default resolveFromTarball({bareSpecifier: 'http://registry.npmjs.org/is-array/-/is-array-1.0.1.tgz'}) .then(resolveResult => console.log(JSON.stringify(resolveResult, null, 2))) diff --git a/shell/path/README.md b/shell/path/README.md index dfd39b1ab4..cf6e7a2f27 100644 --- a/shell/path/README.md +++ b/shell/path/README.md @@ -1,13 +1,13 @@ -# @pnpm/env.path +# @pnpm/shell.path > Functions for changing PATH env variable -[![npm version](https://img.shields.io/npm/v/@pnpm/env.path.svg)](https://www.npmjs.com/package/@pnpm/env.path) +[![npm version](https://img.shields.io/npm/v/@pnpm/shell.path.svg)](https://npmx.dev/package/@pnpm/shell.path) ## Installation ```sh -pnpm add @pnpm/env.path +pnpm add @pnpm/shell.path ``` ## License diff --git a/store/cafs-types/README.md b/store/cafs-types/README.md index 63a1a89dd0..701ed184a5 100644 --- a/store/cafs-types/README.md +++ b/store/cafs-types/README.md @@ -1,9 +1,9 @@ -# @pnpm/cafs-types +# @pnpm/store.cafs-types > Types for the cafs -[![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 diff --git a/store/cafs/README.md b/store/cafs/README.md index 111d4a9f7e..731628c209 100644 --- a/store/cafs/README.md +++ b/store/cafs/README.md @@ -3,7 +3,7 @@ > A content-addressable filesystem for the packages storage -[![npm version](https://img.shields.io/npm/v/@pnpm/store.cafs.svg)](https://www.npmjs.com/package/@pnpm/store.cafs) +[![npm version](https://img.shields.io/npm/v/@pnpm/store.cafs.svg)](https://npmx.dev/package/@pnpm/store.cafs) ## Installation diff --git a/store/connection-manager/README.md b/store/connection-manager/README.md index 62bfb06a9d..9d6aff8c68 100644 --- a/store/connection-manager/README.md +++ b/store/connection-manager/README.md @@ -1,13 +1,13 @@ -# @pnpm/store-connection-manager +# @pnpm/store.connection-manager > Create a pnpm store controller -[![npm version](https://img.shields.io/npm/v/@pnpm/store-connection-manager.svg)](https://www.npmjs.com/package/@pnpm/store-connection-manager) +[![npm version](https://img.shields.io/npm/v/@pnpm/store.connection-manager.svg)](https://npmx.dev/package/@pnpm/store.connection-manager) ## Installation ```sh -pnpm add @pnpm/store-connection-manager +pnpm add @pnpm/store.connection-manager ``` ## License diff --git a/store/controller-types/README.md b/store/controller-types/README.md index fc432fb04e..bc292c0e3f 100644 --- a/store/controller-types/README.md +++ b/store/controller-types/README.md @@ -1,3 +1,3 @@ -# @pnpm/store-controller-types +# @pnpm/store.controller-types > Types for the store controller diff --git a/store/controller/README.md b/store/controller/README.md index e97031d884..06aa2108e3 100644 --- a/store/controller/README.md +++ b/store/controller/README.md @@ -1,11 +1,11 @@ -# @pnpm/package-store +# @pnpm/store.controller > A storage for packages ## Installation ``` -pnpm add @pnpm/package-store +pnpm add @pnpm/store.controller ``` ## License diff --git a/store/create-cafs-store/README.md b/store/create-cafs-store/README.md index dbbcd92760..8b733cbdc4 100644 --- a/store/create-cafs-store/README.md +++ b/store/create-cafs-store/README.md @@ -1,11 +1,11 @@ -# @pnpm/create-cafs-store +# @pnpm/store.create-cafs-store > Create a CAFS store controller ## Installation ``` -pnpm add @pnpm/create-cafs-store +pnpm add @pnpm/store.create-cafs-store ``` ## License diff --git a/store/path/README.md b/store/path/README.md index aed06c0096..957080c64e 100644 --- a/store/path/README.md +++ b/store/path/README.md @@ -1,21 +1,21 @@ -# @pnpm/store-path +# @pnpm/store.path > Resolves the pnpm store path -[![npm version](https://img.shields.io/npm/v/@pnpm/store-path.svg)](https://www.npmjs.com/package/@pnpm/store-path) +[![npm version](https://img.shields.io/npm/v/@pnpm/store.path.svg)](https://npmx.dev/package/@pnpm/store.path) ## Installation ```sh - add @pnpm/store-path + add @pnpm/store.path ``` ## Usage ```ts -import resolveStorePath from '@pnpm/store-path' +import resolveStorePath from '@pnpm/store.path' await resolveStorePath('F:\\project', 'pnpm-store') //> F:\\pnpm-store\\2 diff --git a/text/naming-cases/README.md b/text/naming-cases/README.md index c4217f2fe7..74e82dbeb2 100644 --- a/text/naming-cases/README.md +++ b/text/naming-cases/README.md @@ -1,15 +1,15 @@ -# @pnpm/naming-cases +# @pnpm/text.naming-cases > manipulate and check naming cases -[![npm version](https://img.shields.io/npm/v/@pnpm/naming-cases.svg)](https://www.npmjs.com/package/@pnpm/naming-cases) +[![npm version](https://img.shields.io/npm/v/@pnpm/text.naming-cases.svg)](https://npmx.dev/package/@pnpm/text.naming-cases) ## Installation ```sh -pnpm add @pnpm/naming-cases +pnpm add @pnpm/text.naming-cases ``` ## License diff --git a/worker/README.md b/worker/README.md index 76ee09f92f..ca354fed83 100644 --- a/worker/README.md +++ b/worker/README.md @@ -2,7 +2,7 @@ > A worker for extracting package tarballs to the store -[![npm version](https://img.shields.io/npm/v/@pnpm/worker.svg)](https://www.npmjs.com/package/@pnpm/worker) +[![npm version](https://img.shields.io/npm/v/@pnpm/worker.svg)](https://npmx.dev/package/@pnpm/worker) ## Installation diff --git a/workspace/commands/README.md b/workspace/commands/README.md index 359613a965..1ae61c0a60 100644 --- a/workspace/commands/README.md +++ b/workspace/commands/README.md @@ -1,13 +1,13 @@ -# @pnpm/plugin-commands-init +# @pnpm/workspace.commands > Create a package.json file -[![npm version](https://img.shields.io/npm/v/@pnpm/plugin-commands-init.svg)](https://www.npmjs.com/package/@pnpm/plugin-commands-init) +[![npm version](https://img.shields.io/npm/v/@pnpm/workspace.commands.svg)](https://npmx.dev/package/@pnpm/workspace.commands) ## Installation ```sh -pnpm add @pnpm/plugin-commands-init +pnpm add @pnpm/workspace.commands ``` ## License diff --git a/workspace/injected-deps-syncer/README.md b/workspace/injected-deps-syncer/README.md index 64cca4a971..5ee6a329fd 100644 --- a/workspace/injected-deps-syncer/README.md +++ b/workspace/injected-deps-syncer/README.md @@ -2,7 +2,7 @@ > Update all injected replica of a workspace package -[![npm version](https://img.shields.io/npm/v/@pnpm/workspace.injected-deps-syncer.svg)](https://www.npmjs.com/package/@pnpm/workspace.injected-deps-syncer) +[![npm version](https://img.shields.io/npm/v/@pnpm/workspace.injected-deps-syncer.svg)](https://npmx.dev/package/@pnpm/workspace.injected-deps-syncer) ## Installation diff --git a/workspace/project-manifest-reader/README.md b/workspace/project-manifest-reader/README.md index ea8af9de81..e94e0229a5 100644 --- a/workspace/project-manifest-reader/README.md +++ b/workspace/project-manifest-reader/README.md @@ -1,21 +1,21 @@ -# @pnpm/read-project-manifest +# @pnpm/workspace.project-manifest-reader > Read a project manifest (called package.json in most cases) -[![npm version](https://img.shields.io/npm/v/@pnpm/read-project-manifest.svg)](https://www.npmjs.com/package/@pnpm/read-project-manifest) +[![npm version](https://img.shields.io/npm/v/@pnpm/workspace.project-manifest-reader.svg)](https://npmx.dev/package/@pnpm/workspace.project-manifest-reader) ## Installation ```sh -pnpm add @pnpm/read-project-manifest +pnpm add @pnpm/workspace.project-manifest-reader ``` ## Usage ```ts -import { readProjectManifest } from '@pnpm/read-project-manifest' +import { readProjectManifest } from '@pnpm/workspace.project-manifest-reader' const { manifest, fileName } = await readProjectManifest(process.cwd()) ``` diff --git a/workspace/project-manifest-writer/README.md b/workspace/project-manifest-writer/README.md index 7cf6edd063..b1627107e4 100644 --- a/workspace/project-manifest-writer/README.md +++ b/workspace/project-manifest-writer/README.md @@ -1,21 +1,21 @@ -# @pnpm/write-project-manifest +# @pnpm/workspace.project-manifest-writer > Write a project manifest (called package.json in most cases) -[![npm version](https://img.shields.io/npm/v/@pnpm/write-project-manifest.svg)](https://www.npmjs.com/package/@pnpm/write-project-manifest) +[![npm version](https://img.shields.io/npm/v/@pnpm/workspace.project-manifest-writer.svg)](https://npmx.dev/package/@pnpm/workspace.project-manifest-writer) ## Installation ```sh -pnpm add @pnpm/write-project-manifest +pnpm add @pnpm/workspace.project-manifest-writer ``` ## Usage ```ts -import { writeProjectManifest } from '@pnpm/write-project-manifest' +import { writeProjectManifest } from '@pnpm/workspace.project-manifest-writer' import path from 'path' (async () => await writeProjectManifest(path.resolve('package.yaml'), { name: 'foo', version: '1.0.0' }))() diff --git a/workspace/projects-filter/README.md b/workspace/projects-filter/README.md index 476e210738..3a051386aa 100644 --- a/workspace/projects-filter/README.md +++ b/workspace/projects-filter/README.md @@ -1,13 +1,13 @@ -# @pnpm/filter-workspace-packages +# @pnpm/workspace.projects-filter > Filters packages in a workspace -[![npm version](https://img.shields.io/npm/v/@pnpm/filter-workspace-packages.svg)](https://www.npmjs.com/package/@pnpm/filter-workspace-packages) +[![npm version](https://img.shields.io/npm/v/@pnpm/workspace.projects-filter.svg)](https://npmx.dev/package/@pnpm/workspace.projects-filter) ## Installation ```sh -pnpm add @pnpm/filter-workspace-packages +pnpm add @pnpm/workspace.projects-filter ``` ## License diff --git a/workspace/projects-graph/README.md b/workspace/projects-graph/README.md index 76fc1cf70c..dc0ccb0062 100644 --- a/workspace/projects-graph/README.md +++ b/workspace/projects-graph/README.md @@ -2,7 +2,7 @@ > Create a graph from an array of packages -[![npm version](https://img.shields.io/npm/v/pkgs-graph.svg)](https://www.npmjs.com/package/pkgs-graph) +[![npm version](https://img.shields.io/npm/v/pkgs-graph.svg)](https://npmx.dev/package/pkgs-graph) ## Installation diff --git a/workspace/projects-reader/README.md b/workspace/projects-reader/README.md index be99e3ae61..c72ad6bbcf 100644 --- a/workspace/projects-reader/README.md +++ b/workspace/projects-reader/README.md @@ -1,13 +1,13 @@ -# @pnpm/workspace.find-packages +# @pnpm/workspace.projects-reader > Finds packages inside a workspace -[![npm version](https://img.shields.io/npm/v/@pnpm/workspace.find-packages.svg)](https://www.npmjs.com/package/@pnpm/workspace.find-packages) +[![npm version](https://img.shields.io/npm/v/@pnpm/workspace.projects-reader.svg)](https://npmx.dev/package/@pnpm/workspace.projects-reader) ## Installation ```sh -pnpm add @pnpm/workspace.find-packages +pnpm add @pnpm/workspace.projects-reader ``` ## License diff --git a/workspace/projects-sorter/README.md b/workspace/projects-sorter/README.md index 012e8765ca..4e772ecf01 100644 --- a/workspace/projects-sorter/README.md +++ b/workspace/projects-sorter/README.md @@ -2,7 +2,7 @@ > Sort packages -[![npm version](https://img.shields.io/npm/v/@pnpm/workspace.projects-sorter.svg)](https://www.npmjs.com/package/@pnpm/plugin-commands-recursive) +[![npm version](https://img.shields.io/npm/v/@pnpm/workspace.projects-sorter.svg)](https://npmx.dev/package/@pnpm/plugin-commands-recursive) ## Installation diff --git a/workspace/range-resolver/README.md b/workspace/range-resolver/README.md index f3d78caf9e..7ccf1aaa99 100644 --- a/workspace/range-resolver/README.md +++ b/workspace/range-resolver/README.md @@ -1,11 +1,11 @@ -# @pnpm/resolve-workspace-range +# @pnpm/workspace.range-resolver > Resolves a range from versions that are present inside a workspace ## Install ``` -pnpm add @pnpm/resolve-workspace-range +pnpm add @pnpm/workspace.range-resolver ``` ### API diff --git a/workspace/root-finder/README.md b/workspace/root-finder/README.md index 43c1d1ef7c..4082f397eb 100644 --- a/workspace/root-finder/README.md +++ b/workspace/root-finder/README.md @@ -1,13 +1,13 @@ -# @pnpm/find-workspace-dir +# @pnpm/workspace.root-finder > Finds the root of a pnpm workspace -[![npm version](https://img.shields.io/npm/v/@pnpm/find-workspace-dir.svg)](https://www.npmjs.com/package/@pnpm/find-workspace-dir) +[![npm version](https://img.shields.io/npm/v/@pnpm/workspace.root-finder.svg)](https://npmx.dev/package/@pnpm/workspace.root-finder) ## Installation ```sh -pnpm add @pnpm/find-workspace-dir +pnpm add @pnpm/workspace.root-finder ``` ## License diff --git a/workspace/spec-parser/README.md b/workspace/spec-parser/README.md index 3d9149c3a4..775b84be9b 100644 --- a/workspace/spec-parser/README.md +++ b/workspace/spec-parser/README.md @@ -2,7 +2,7 @@ > Parse and stringify workspace specs -[![npm version](https://img.shields.io/npm/v/@pnpm/workspace.spec-parser.svg)](https://www.npmjs.com/package/@pnpm/workspace.spec-parser) +[![npm version](https://img.shields.io/npm/v/@pnpm/workspace.spec-parser.svg)](https://npmx.dev/package/@pnpm/workspace.spec-parser) ## Installation diff --git a/workspace/state/README.md b/workspace/state/README.md index 4fc9254b6c..83f9adea60 100644 --- a/workspace/state/README.md +++ b/workspace/state/README.md @@ -3,7 +3,7 @@ > Track the list of actual paths of workspace packages in a cache. -[![npm version](https://img.shields.io/npm/v/@pnpm/workspace.state.svg)](https://www.npmjs.com/package/@pnpm/workspace.state) +[![npm version](https://img.shields.io/npm/v/@pnpm/workspace.state.svg)](https://npmx.dev/package/@pnpm/workspace.state) ## Installation diff --git a/yaml/document-sync/README.md b/yaml/document-sync/README.md index baf8f983cf..74143314e2 100644 --- a/yaml/document-sync/README.md +++ b/yaml/document-sync/README.md @@ -3,7 +3,7 @@ > Update a YAML document to match the contents of an in-memory object. -[![npm version](https://img.shields.io/npm/v/@pnpm/yaml.document-sync.svg)](https://www.npmjs.com/package/@pnpm/yaml.document-sync) +[![npm version](https://img.shields.io/npm/v/@pnpm/yaml.document-sync.svg)](https://npmx.dev/package/@pnpm/yaml.document-sync) ## Installation @@ -64,7 +64,7 @@ qux: This package is useful when your codebase: -1. Uses the [yaml](https://www.npmjs.com/package/yaml) library. +1. Uses the [yaml](https://npmx.dev/package/yaml) library. 2. Calls `.toJSON()` on the parse result and performs changes to it. 3. Needs to "sync" those changes back to the source document.