willsoto / node-konfig

Node.js configuration management library

Node Konfig

Documentation is available at https://willsoto.github.io/node-konfig/

node-konfig's Issues

Make Store generic for better type inference on the config object

node-konfig/packages/core/src/store.ts

Line 11 in 93688ee

export class Store {

https://github.com/ahejlsberg/tsconf2020-demos/blob/master/template/main.ts#L108-L136

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Other Branches

These updates are pending. To force PRs open, click the checkbox below.

• fix(deps): update dependency node-fetch to v3.3.1

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• chore(deps): update pnpm to v8.6.0
• fix(deps): update dependency meow to v12

Detected dependencies

docker-compose

docker-compose.yml

• vault 1.13.2
• consul 1.15.2
• docker.io/bitnami/etcd 3-debian-10

github-actions

.github/workflows/docs.yml

• actions/checkout v3
• volta-cli/action v4
• actions/cache v3
• peaceiris/actions-gh-pages v3

.github/workflows/release.yml

• actions/checkout v3
• volta-cli/action v4
• actions/cache v3
• changesets/action v1

.github/workflows/tests.yml

• actions/checkout v3
• volta-cli/action v4
• actions/cache v3

npm

core/package.json

• cockatiel ~3.1.0
• lodash ~4.17.21
• @types/lodash 4.14.195

internal/package.json

loaders/consul/package.json

• consul ~1.2.0
• @types/consul 0.40.0
• @willsoto/node-konfig-core ^5.0.0

loaders/etcd/package.json

• etcd3 ~1.1.0
• @willsoto/node-konfig-core ^5.0.0

loaders/file/package.json

• @willsoto/node-konfig-core ^5.0.0

loaders/flag/package.json

• meow ~11.0.0
• @willsoto/node-konfig-core ^5.0.0

loaders/http/package.json

• node-fetch ~3.3.0
• nock 13.3.1
• @willsoto/node-konfig-core ^5.0.0

loaders/vault/package.json

• @types/request ~2.48.7
• node-vault ~0.9.22
• @willsoto/node-konfig-core ^5.0.0

package.json

• @changesets/cli 2.26.1
• @commitlint/cli 17.6.5
• @commitlint/config-conventional 17.6.5
• @types/node 18.16.16
• @types/sinon 10.0.15
• @typescript-eslint/eslint-plugin 5.59.8
• @typescript-eslint/parser 5.59.8
• ava 5.3.0
• c8 7.14.0
• eslint 8.41.0
• eslint-config-prettier 8.8.0
• eslint-plugin-ava 14.0.0
• husky 8.0.3
• lint-staged 13.2.2
• prettier 2.8.8
• prettier-plugin-organize-imports 3.2.2
• prettier-plugin-packagejson 2.4.3
• rimraf 5.0.1
• sinon 15.1.0
• ts-node 10.9.1
• turbo 1.9.9
• typescript 5.0.4
• vitepress 1.0.0-beta.1
• vue 3.3.4
• node 18.16.0
• pnpm 8.5.1

parsers/toml/package.json

• toml ~3.0.0
• @willsoto/node-konfig-core ^5.0.0

parsers/yaml/package.json

• js-yaml ~4.1.0
• @types/js-yaml 4.0.5
• @willsoto/node-konfig-core ^5.0.0

---

• Check this box to trigger a request for Renovate to run again on this repository

Implement YAML parser

Enable member-ordering eslint rule

https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/member-ordering.md

Deploy docs to GitHub pages

https://v2.docusaurus.io/docs/deployment#deploying-to-github-pages

Add support for Consul

https://github.com/lalamove/konfig/blob/master/loader/klconsul/README.md

Implement http loader

https://github.com/lalamove/konfig/tree/master/loader/klhttp

Implement TOML parser

Add nicer/better documentation

Maybe Docusaurus or VuePress?

Add etcd loader

https://github.com/lalamove/konfig/tree/master/loader/kletcd

Implement config groups

https://github.com/lalamove/konfig#config-groups

Implement remaining loader features

https://github.com/lalamove/konfig#loaders

type Loader interface {
	// Name return the name of the load, it is used to create labeled vectors metrics per loader
	Name() string
	// StopOnFailure indicates if a failure of the loader should trigger a stop
	StopOnFailure() bool
	// Loads the config and add it to the Store
	Load(Store) error
	// MaxRetry returns the maximum number of times to allow retrying on load failure
	MaxRetry() int
	// RetryDelay returns the delay to wait before retrying
	RetryDelay() time.Duration
}

• StopOnFailure
• MaxRetry
• RetryDelay

Implement value loader

Simple loader that accepts objects