bsdayo / jint-configuration

Add JavaScript modules as your configuration source!

Jint.Extensions.Configuration

Add JavaScript modules as your configuration source! Powered by Jint.

Usage

Install this package using your preferred way.

Simple usage

Prepare a JavaScript module that exports an object:

// appsettings.js

export default {
  host: 'localhost',
  port: 5432
}

Then, add a JavaScript module source to Microsoft.Extensions.Configuration.IConfigurationBuilder:

var builder = new ConfigurationBuilder()
    .AddJavaScriptModule("./path/to/appsettings.js");

var configuration = builder.Build();

// Use configuartion
var host = configuration["host"];

The entire JavaScript code will be executed (with Jint), and the exported object will be added to the configuration.

With ASP.NET Core

In ASP.NET Core, you can simply add a JavaScript module source to builder.Configuration:

builder.Configuration.AddJavaScriptModule("appsettings.js");
builder.Configuration.AddJavaScriptModule($"appsettings.{builder.Environment.EnvironmentName}.js");

As an example,

// appsettings.js

const LogLevel = {
  Information: 'Information',
  Warning: 'Warning',
  // ...
}

export default {
  logging: {
    logLevel: {
      default: LogLevel.Information,
      'Microsoft.AspNetCore': LogLevel.Warning,
    },
  },
  allowedHosts: '*',
}

Full ASP.NET Core example can be found here.

Misc

Export separately is also supported, but cannot mix with export default (if a module exports both, export default will be used and others will be ignored):

export const logging = {
  logLevel: {
    default: LogLevel.Information,
    'Microsoft.AspNetCore': LogLevel.Warning,
  },
}

export const allowedHosts = '*'

License

MIT