https://github.com/sindresorhus/package-config

Get namespaced config from the closest package.json
https://github.com/sindresorhus/package-config

Last synced: 2 months ago
JSON representation

Get namespaced config from the closest package.json

• Host: GitHub
• URL: https://github.com/sindresorhus/package-config
• Owner: sindresorhus
• License: mit
• Created: 2015-09-02T10:19:05.000Z (almost 9 years ago)
• Default Branch: main
• Last Pushed: 2023-11-05T19:11:54.000Z (8 months ago)
• Last Synced: 2024-04-13T16:32:47.988Z (3 months ago)
• Language: JavaScript
• Size: 31.3 KB
• Stars: 117
• Watchers: 7
• Forks: 14
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • Funding: .github/funding.yml
  • License: license
  • Security: .github/security.md

Lists

• awesome-micro-npm-packages - pkg-conf - Get namespaced config from the closest package.json. (Modules / Module management)
• awesome-npm - package-config - Get namespaced config from the closest package.json. (Packages / Other)

README

        
# package-config

> Get namespaced config from the closest package.json

Having tool specific config in package.json reduces the amount of metafiles in your repo (there are usually a lot!) and makes the config obvious compared to hidden dotfiles like `.eslintrc`, which can end up causing confusion. [XO](https://github.com/xojs/xo), for example, uses the `xo` namespace in package.json, and [ESLint](http://eslint.org) uses `eslintConfig`. Many more tools supports this, like [AVA](https://avajs.dev), [Babel](https://babeljs.io), [nyc](https://github.com/istanbuljs/nyc), etc.

## Install

```sh

npm install package-config

```

## Usage

```json

{

	"name": "some-package",

	"version": "1.0.0",

	"unicorn": {

		"rainbow": true

	}

}

```

```js

import {packageConfig} from 'package-config';

const config = await packageConfig('unicorn');

console.log(config.rainbow);

//=> true

```

## API

It [walks up](https://github.com/sindresorhus/find-up-simple) parent directories until a `package.json` can be found, reads it, and returns the user specified namespace or an empty object if not found.

### packageConfig(namespace, options?)

Returns a `Promise` for the config.

### packageConfigSync(namespace, options?)

Returns the config.

#### namespace

Type: `string`

The package.json namespace you want.

#### options

Type: `object`

##### cwd

Type: `string`\

Default: `process.cwd()`

The directory to start looking up for a package.json file.

##### defaults

Type: `object`

The default config.

##### skipOnFalse

Type: `boolean`\

Default: `false`

Skip `package.json` files that have the namespaced config explicitly set to `false`.

Continues searching upwards until the next `package.json` file is reached. This can be useful when you need to support the ability for users to have nested `package.json` files, but only read from the root one, like in the case of [`electron-builder`](https://github.com/electron-userland/electron-builder/wiki/Options#AppMetadata) where you have one `package.json` file for the app and one top-level for development.

Example usage for the user:

```json

{

	"name": "some-package",

	"version": "1.0.0",

	"unicorn": false

}

```

### packageJsonPath(config)

Pass in the config returned from any of the above methods.

Returns the file path to the package.json file or `undefined` if not found.

## Related

- [read-package-up](https://github.com/sindresorhus/read-package-up) - Read the closest package.json file

- [read-pkg](https://github.com/sindresorhus/read-pkg) - Read a package.json file

- [find-up](https://github.com/sindresorhus/find-up) - Find a file by walking up parent directories