@yarnpkg/pnp

What is @yarnpkg/pnp?

@yarnpkg/pnp is a package that provides Plug'n'Play (PnP) functionality for Yarn, a popular JavaScript package manager. PnP is a feature that eliminates the need for a node_modules directory by resolving dependencies directly from the Yarn cache, leading to faster installs and more efficient disk usage.

What are @yarnpkg/pnp's main functionalities?

Dependency Resolution

This feature allows you to resolve the path to a dependency without needing a node_modules directory. The code sample demonstrates how to resolve the path to the 'lodash' package.

const { resolveToUnqualified, resolveUnqualified } = require('@yarnpkg/pnp');

const unqualifiedPath = resolveToUnqualified('lodash', __filename);
const qualifiedPath = resolveUnqualified(unqualifiedPath, 'lodash');

console.log(qualifiedPath);

Package Information

This feature provides detailed information about a specific package, such as its location and dependencies. The code sample shows how to retrieve information for the 'lodash' package.

const { getPackageInformation } = require('@yarnpkg/pnp');

const packageLocator = { name: 'lodash', reference: '4.17.21' };
const packageInfo = getPackageInformation(packageLocator);

console.log(packageInfo);

Custom Resolvers

This feature allows you to create custom resolvers for specific packages. The code sample demonstrates how to create a custom resolver for a package named 'custom-package'.

const { makeResolver } = require('@yarnpkg/pnp');

const customResolver = makeResolver({
  resolveToUnqualified: (request, issuer) => {
    if (request === 'custom-package') {
      return '/path/to/custom-package';
    }
    return null;
  }
});

console.log(customResolver.resolveToUnqualified('custom-package', __filename));

Other packages similar to @yarnpkg/pnp

npm

npm is the default package manager for Node.js. Unlike @yarnpkg/pnp, npm uses a node_modules directory to store dependencies, which can lead to slower installs and more disk usage.

pnpm

pnpm is a fast, disk space-efficient package manager. It uses a content-addressable file system to store all files from all module directories in a single place, which is somewhat similar to PnP's approach of avoiding node_modules.

rush

Rush is a scalable monorepo manager for the web. It supports multiple package managers, including Yarn with PnP, and focuses on managing large repositories with many projects.

README

The README file is missing

Changelog

3.2.1

Installs

• The pnpm linker no longer tries to remove node_modules directory, when node-modules linker is active
• The node-modules linker does not fail anymore if portal dependency points to an external project with multiple interdependent workspaces
• The node-modules linker has received various improvements:
  • applies hoisting algorithm on aliased dependencies
  • reinstalls modules that have their directories removed from node_modules by the user
  • improves portal hoisting
  • supports supportedArchitectures

Bugfixes

• The PnP ESM loader is now able to handle symlinked extensionless entrypoints.