Question 1

How to handle default configuration with package-config?

Accepted Answer

Use the 'defaults' option in the API to provide fallback values. For example, `packageConfig('tool', { defaults: { option: 'value' } })` ensures a config is always returned, even if not set in package.json, as documented in the options.

Question 2

package-config vs cosmiconfig for reading config files?

Accepted Answer

package-config is simpler and focused solely on package.json namespaces, while cosmiconfig supports multiple file formats and sources. Choose package-config for package.json-only needs; use cosmiconfig for broader flexibility with dotfiles and other formats.

Question 3

Can package-config work in a monorepo with nested package.json files?

Accepted Answer

Yes, the parent directory traversal allows it to find the closest package.json in nested structures. However, be mindful of config conflicts between root and sub-package.json files, and use skipOnFalse to control behavior.

Question 4

Does package-config support async/await in Node.js?

Accepted Answer

Yes, the `packageConfig` function returns a Promise, so you can use async/await or .then() for asynchronous handling. The README includes an async example with `await packageConfig('unicorn')`.

Question 5

What happens if the namespace is missing in package.json?

Accepted Answer

It returns an empty object by default, but you can override this with the 'defaults' option. The skipOnFalse option can also skip configs explicitly set to false, continuing the search upwards.

Question 6

How to test code that uses package-config?

Accepted Answer

Mock the package-config module or control the package.json file in tests. Since it reads from the filesystem, ensure test environments have the expected package.json structure or use the cwd option to point to a test directory.

pkg-conf

What is pkg-conf?

Overview

Use Cases

Best For

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions