libnpmconfig

What is libnpmconfig?

The libnpmconfig package is a utility for reading npm configuration files and resolving npm configuration values. It allows developers to programmatically access and manipulate npm configuration settings within their Node.js applications.

What are libnpmconfig's main functionalities?

Reading npm configuration

This feature allows you to read the npm configuration settings. The code sample demonstrates how to read and print all npm configuration settings.

const libnpmconfig = require('libnpmconfig');

libnpmconfig.read().forEach((value, key) => {
  console.log(`${key} = ${value}`);
});

Resolving npm configuration values

This feature allows you to resolve specific npm configuration values. The code sample demonstrates how to read and print the npm registry URL from the configuration.

const libnpmconfig = require('libnpmconfig');

const registry = libnpmconfig.read().get('registry');
console.log(`Registry URL: ${registry}`);

Handling npm configuration scopes

This feature allows you to handle npm configuration scopes. The code sample demonstrates how to read and print the npm registry URL for a specific scope.

const libnpmconfig = require('libnpmconfig');

const scope = '@my-scope';
const registry = libnpmconfig.read({ scope }).get('registry');
console.log(`Registry URL for ${scope}: ${registry}`);

Other packages similar to libnpmconfig

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 libnpmconfig, which is specifically designed for npm configuration.

config

The config package is a configuration management tool for Node.js applications. It allows for hierarchical configurations for different deployment environments. Unlike libnpmconfig, it is not focused on npm configuration but rather on application configuration in general.

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 handling as libnpmconfig.

README

libnpmconfig

libnpmconfig is a Node.js library for programmatically managing npm's configuration files and data.

Example

const config = require('libnpmconfig')

console.log('configured registry:', config.read({
  registry: 'https://default.registry/'
}))
// => configured registry: https://registry.npmjs.org

Install

$ npm install libnpmconfig

Table of Contents

• Example
• Install
• API

API

> read(cliOpts, builtinOpts)

Reads configurations from the filesystem and the env and returns a figgy-pudding object with the configuration values.

If cliOpts is provided, it will be merged with the returned config pudding, shadowing any read values. These are intended as CLI-provided options. Do your own process.argv parsing, though.

If builtinOpts.cwd is provided, it will be used instead of process.cwd() as the starting point for config searching.

Changelog

1.2.1 (2018-11-13)

Bug Fixes

• proj: make sure proj object exists (8fe2663)

<a name="1.2.0"></a>