@pnpm/npm-conf

What is @pnpm/npm-conf?

@pnpm/npm-conf is a configuration management utility for Node.js projects. It allows you to handle npm configuration settings programmatically, making it easier to manage and customize npm behaviors within your applications.

What are @pnpm/npm-conf's main functionalities?

Load Configuration

This feature allows you to load the npm configuration settings. The code sample demonstrates how to load the configuration and retrieve the value of the 'registry' setting.

const npmConf = require('@pnpm/npm-conf');
const config = npmConf();
console.log(config.get('registry'));

Set Configuration

This feature allows you to set npm configuration settings programmatically. The code sample shows how to set a custom registry URL and then retrieve it to verify the change.

const npmConf = require('@pnpm/npm-conf');
const config = npmConf();
config.set('registry', 'https://custom.registry.com');
console.log(config.get('registry'));

Save Configuration

This feature allows you to save the modified configuration settings back to the npm configuration file. The code sample demonstrates setting a custom registry URL and then saving this configuration.

const npmConf = require('@pnpm/npm-conf');
const config = npmConf();
config.set('registry', 'https://custom.registry.com');
config.save();

Other packages similar to @pnpm/npm-conf

rc

The 'rc' package is a non-npm-specific configuration loader that supports various configuration file formats and environment variables. It is more general-purpose compared to @pnpm/npm-conf, which is specifically tailored for npm configurations.

config

The 'config' package provides a way to manage configuration files for Node.js applications. It supports multiple environments and allows for hierarchical configurations. Unlike @pnpm/npm-conf, it is not focused on npm settings but rather on application-specific configurations.

dotenv

The 'dotenv' package loads environment variables from a .env file into process.env. It is useful for managing environment-specific settings but does not provide the same level of npm-specific configuration management as @pnpm/npm-conf.

README

@pnpm/npm-conf

Get the npm config

Install

$ pnpm add @pnpm/npm-conf

Usage

const npmConf = require('@pnpm/npm-conf');

const conf = npmConf();

conf.get('prefix')
//=> //=> /Users/unicorn/.npm-packages

conf.get('registry')
//=> https://registry.npmjs.org/

To get a list of all available npm config options:

$ npm config list --long

API

npmConf()

Returns the npm config.

npmConf.defaults

Returns the default npm config.

License

MIT