npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@prairielearn/config

v3.0.6

Published

Utilities to help load configuration from various sources including a JSON file and AWS Secrets Manager. Config is made type-safe through a [Zod](https://github.com/colinhacks/zod) schema.

Downloads

161

Readme

@prairielearn/config

Utilities to help load configuration from various sources including a JSON file and AWS Secrets Manager. Config is made type-safe through a Zod schema.

This package should not be depended upon by other packages directly. Instead, import it into your application, load the config, and then provide any necessary values to other packages.

Usage

import { ConfigLoader, makeFileConfig } from '@prairielearn/config';
import { z } from 'zod';

const ConfigSchema = z.object({
  hello: z.string().default('world'),
});

const configLoader = new ConfigLoader(ConfigSchema);

await configLoader.loadAndValidate([makeFileConfig('config.json')]);

console.log(configLoader.config);
// { hello: "world" }

Typically, you'll want to have a config.ts file in your own project that encapsulates this. Then, you can import the config elsewhere in the project.

import { ConfigLoader, makeFileConfig } from '@prairielearn/config';
import { z } from 'zod';

const configLoader = new ConfigLoader(z.any());

export async function loadAndValidate(path: string) {
  await configLoader.loadAndValidate([makeFileConfig(path)]);
}

export default configLoader.config;

Loading config from AWS

If you're running in AWS, you can use makeImdsConfig() and makeSecretsManagerConfig() to load config from IMDS and Secrets Manager, respectively:

  • makeImdsConfig() will load hostname, instanceId, and awsRegion, which will be available if you config schema contains these values.
  • makeSecretsManagerConfig() will look for a ConfSecret tag on the instance. If found, the value of that tag will be used treated as a Secrets Manager secret ID, and that secret's value will be parsed as JSON and merged into the config.

Note that both of these config sources are no-ops by default. To active them, you must do one of the following:

  • Set CONFIG_LOAD_FROM_AWS=1 in the process environment.
  • Chain them after makeFileConfig(), and ensure that the config file contains {"runningInEc2": true}.