diff --git a/reference/configuration.md b/reference/configuration.md index 15a1d3b..ac28b95 100644 --- a/reference/configuration.md +++ b/reference/configuration.md @@ -22,6 +22,29 @@ Pear versioning is automatic. The `package.json` file does **not** require a ver The name of the application. Overrides `package.json` `name`. +### `pear.builtinsMap` Terminal Applications Only + +Terminal Applications run on the [`bare`](https://github.com/holepunchto/bare) JavaScript runtime, +which has a very small core so code with expects say, an `fs` module will throw MODULE_NOT_FOUND +unless that namespace is mapped to an installed module. + +Provide an object that maps builtin dependency namespaces to installed modules. + +An example `package.json`: + +```json +{ + "name": "example", + "pear": { + "builtinsMap": { + "fs": "bare-fs" + } + } +} +``` + +> In future this option may also apply to Desktop Applications. + ### `pear.gui` Graphical User Interface configuration options.