File Plugin

A file plugin for Config Dug

This plugin allows you to load configuration values from JSON and JavaScript files. It supports automatic reloading of configuration files at specified intervals, ensuring that your application always has the most up-to-date configuration values.

Usage

Defining the File plugin

const filePlugin = new FilePlugin({
  files: ['config.json'],
  reloadInterval: '1m',
});

Parameter Reference

| Parameter | Type | Description | | :--------------- | :------- | :-------------------------------------------------------------------------------- | | files | string | The file extensions used for configuration values | | reloadInterval | array | Specifies the interval at which the plugin should reload the configuration files. |

Adding targeted flags to the Config Dug schema

[!IMPORTANT] The File plugin exports a custom type targetedFileFlagSchema that can be used to define targeted flags within the schema. This is a custom zod definition that matches the function definition returned by this plugin and should be used for all targeted flags.

const schema = {
  value1: {
    schema: targetedFileFlagSchema,
    description: 'Targeted File config boolean',
    sensitive: false,
  },
};

Adding the plugin to Config Dug

The File plugin can be added to the plugins array in the Config Dug constructor. Keep in mind the plugin load order dictates which values will be used.

const configDug = new ConfigDug(schema, {
  plugins: [filePlugin],
  printConfig: true,
});

Export your configuration

The file plugin will read from your configuration files. Currently supported formats include .js and .json.

module.exports = {
  logLevel: 'debug',
};

Complete example

const schema = {
  value1: {
    schema: z.string(),
    description: 'Non-targeted File string',
    sensitive: false,
  },
  value2: {
    schema: targetedFileFlagSchema,
    description: 'Targeted File value',
    sensitive: true,
  },
};

const filePlugin = new FilePlugin({
  files: ['config.json'],
  reloadInterval: '1m',
});

const configDug = new ConfigDug(schema, {
  plugins: [filePlugin],
  printConfig: true,
});

await configDug.load();
const config = configDug.getConfig();

console.log(config.value1); // returns a string value from File
console.log(await config.value2({ identifier: 'Some Id Value' })); // returns the targeted flag response