config-lifecycle

Classify, match, and alert on CLI config keys — active, deprecated, expired, unknown.
Never drop detection of outdated keys.
Explore the docs »

Report Bug · Request Feature

About The Project

CLIs that delete recognition of old config keys create silent mystery debt. This library loads a machine-readable key catalog, scans key=value config text, and emits structured findings plus human alert lines for deprecated, expired, and unknown keys.

Expired keys stay in the catalog forever and still produce alerts — they are not forgotten.

Formerly named config-key-sanitation; the old repository URL redirects here.

Built With

• Runtime / language

  • D (Phobos std.json)

• Docs / standard

  • OpenShellOrg Config Lifecycle Management

• Packaging

  • DUB

Getting Started

Prerequisites

LDC or DMD, DUB.

Install

Prefer the registry once published:

dub add config-lifecycle

Until the first DUB release, use a path dependency on a sibling clone:

dependency "config-lifecycle" path="../config-lifecycle"

Demo

dub run --config=demo -- fixtures/sample.npmrc

Usage

import config_lifecycle;
import std.file : readText;

auto catalog = Catalog.loadJson(readText("fixtures/example-catalog.json"));
auto keys = parseKeyValueFile(readText("fixtures/sample.npmrc"));
foreach (f; catalog.classify(keys)) {
    if (f.needsAlert)
        stderr.writeln(f.alertLine);
}

Changelog

See CHANGELOG.adoc.

License

MIT — see LICENSE.

(back to top)