Plugin Config Loader

Load your plugin configuration easily into a single plain old javascript object, either if it has been provided in the package.json file or in some file named with your plugin's name.

Install

npm install @universal-packages/plugin-config-loader

Global methods

loadPluginConfig(pluginName: string, [options])

Reads deeply into files and directories named as the plugin name provided and get all the contents of the configuration files into a plain old javascript object.

import { loadPluginConfig } from '@universal-packages/plugin-config-loader'

const config = await loadPluginConfig('plugin')

console.log(config)

Loads all config files as json that matches the criteria in a conventional, files like:

 | package.json           <- First priority
   | "plugin": { ... }
 | plugin                 <- Forth priority
   | anything.json          <- 2
   | anything.yaml          <- loaded if not json
   | anything.[js|ts]       <- loaded if not yaml
 | .plugin                <- Fifth priority
   | anything.json          <- 2
   | anything.yaml          <- loaded if not json
   | anything.[js|ts]       <- loaded if not yaml
 | plugin.json            <- Second priority
 | plugin.yaml            <- loaded if not json
 | plugin.[js|ts]         <- loaded if not yaml
 | .plugin.json           <- Third priority
 | .plugin.yaml           <- loaded if not json
 | .plugin.[js|ts]        <- loaded if not yaml

You can always modify the priority of location and format in the options.

Options

• cleanOrphanReplaceable boolean Replaceable strings that are not found in the environment variables will be removed from the final values.

• defaultConfig Object Use to fill config that may not be present in the configuration files.

• formatPriority ['json' | 'yaml' | 'yml' | 'js' | 'ts'] Prioritization order if one format is desired but does not exists which one try next?

• loadFrom string By default it will try to load from the root path but a different path can be specified to load from.

• locationPriority ['package' | 'root' | '.root' | 'directory' | '.directory'] By default is loaded from the package first but you can change the order of the location to be fetch first.

  • package: Internally embedded in the package.json file
  • root: A file named as the plugin name, ex: jest.js
  • .root: A file named as the plugin name with a prefixed dot, ex: .jest.js
  • directory: A folder containing more that one config file named as the plugin name, ex: ./github
  • .directory: A folder containing more that one config file named as the plugin name with a prefixed dot, ex: ./.github

• selectEnvironment string | boolean If you want your files to be post processed after loaded with a selection of an environment section you can specify the name of the environment to select or pass true to automatically set from NODE_ENV.

Typescript

This library is developed in TypeScript and shipped fully typed.

Contributing

The development of this library happens in the open on GitHub, and we are grateful to the community for contributing bugfixes and improvements. Read below to learn how you can take part in improving this library.

• Code of Conduct
• Contributing Guide

License

MIT licensed.