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

@brickblock/strong-config-browser

v1.2.4

Published

<PLEASE FILL ME WITH SOMETHING USEFUL>

Downloads

16

Readme

@brickblock/strong-config-browser

strong-config is a library for managing runtime-specific configuration such as:

  1. Runtime environment (e.g. development / review / staging / production)
  2. Sentry DSN or Logger config
  3. Auth0 config
  4. etc

It does 3 things:

  1. Loads a yaml file into memory as an object
  2. Optionally, validates the config against a json-schema
  3. Exposes a React Context that can be used in child components

IMPORTANT: Do NOT store any secrets such as API secret keys in config files used in single-page applications. They WILL be available to client-side JavaScript including 3rd party scripts and browser extensions which should be avoided at all costs.

Installation

The library should be installed as a dependency:

yarn add @brickblock/strong-config-browser

Conventions

  • strong-config-browser will read the config from public/config/${REACT_APP_BBK_ENV}.yml
  • If a public/config/schema.yml exists, the resulting config object is validated against the schema using json-schema

Usage

REACT_APP_BBK_ENV=production yarn start
/* public/config/production.yml */

logger:
  level: INFO
  name: my-prod-logger
/* src/index.js */
import React from 'react'
import ReactDOM from 'react-dom'

import App from './app'
import { ConfigContext, loadConfig } from '@brickblock/strong-config-browser'

const render = async NextApp => {
  const config = await loadConfig()

  ReactDOM.render(
    <ConfigContext.Provider value={{ config }}>
      <NextApp />
    </ConfigContext.Provider>,
    document.getElementById('root')
  )
}

render(App)

Note the <ConfigContext.Provider> above.

This context can be used in child components in the usual ways that React.Context is used. We recommend using the useContext hook as follows:

import { ConfigContext } from '@brickblock/strong-config-browser'

const MyComponent = () => {
  const { config } = useContext(ConfigContext)
  return <span>{config.some.property}</span>
}

export default MyComponent