Digital-Alchemy-TS / Digital-Alchemy-TS/core

Add support for --help flag in core

Open
#7 1 comment 0 reactions 0 assignees View on GitHub
enhancement feat: configuration
Dominant language
TypeScript
Stars
53
Forks
1
Avg merge
1m
Merged PRs (30d)
1

Description

Passing the `--help` flag should cause the application to print a document to the console describing the way the configuration system was wired together. This work **MUST** be done prior to wiring any modules, so additional logs will not be emitted

This command will:
- iterate through each project going into the application
- print out a list of all configuration properties
- name, description, type, module level default value, value enum, required state
- environment variable / `--switch` that can be used to define the value

A related flag should also be introduced to just dump the data as json, for processing by other scripts

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.