Question 1

How to read ESLint config from package.json using package-config?

Accepted Answer

Import the library and call packageConfig with 'eslintConfig' as the namespace. For example, `const config = await packageConfig('eslintConfig');` will retrieve the ESLint configuration object stored under that key in the nearest package.json.

Question 2

What's the difference between package-config and read-pkg?

Accepted Answer

package-config is specialized for reading namespaced configuration from package.json with directory traversal, while read-pkg is a general-purpose library for reading any package.json file without focusing on namespaces or automatic search up the directory tree.

Question 3

Can package-config handle nested package.json files in monorepos?

Accepted Answer

Yes, it walks up directories to find the closest package.json, but use the skipOnFalse option or adjust cwd to control which file is read. This is useful for tools like electron-builder with separate app and development package.json files.

Question 4

How to set default configuration values with package-config?

Accepted Answer

Pass a defaults object in the options parameter. For example, `const config = await packageConfig('myNamespace', { defaults: { enabled: true } });` will use the defaults if the namespace is not found in package.json.

Question 5

Is package-config compatible with CommonJS modules?

Accepted Answer

Yes, it supports both ES modules and CommonJS. You can use require() for synchronous access or dynamic imports for async, as the library provides both APIs, though the README examples focus on ES modules.

Question 6

How to get the path of the package.json file read by package-config?

Accepted Answer

Use the packageJsonPath utility function by passing the config object returned from packageConfig. It returns the file path, which is helpful for debugging or logging purposes in complex directory structures.

package-config

What is package-config?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions