configng-v2

Module SDK & Development Guide: configng-v2

This guide covers the practical SDK for contributing modules to configng-v2.

📋 For project roadmap and milestone tracking, see ROADMAP.md

staging/ — Work-in-progress modules (development area).
src/ — Develomnet modules (after promotion).
lib/ — Assembled Bash libraries (for the final framework).
SDK/ — Scripts for scaffolding, checking, and automating the SDK.
modules_browsers/ - Protoype GUI emplementaions to interact with modules metadata

Scaffold a Module
- run
```
./SDK/00_start_here.sh <modulename>
```
- Creates staging/<modulename>.sh, and staging/<modulename>.conf.
Develop
- Write module logic in .sh (use tabs for indentation).
- updade the about help message
- Fill out .conf (flat key=value).
Verify & Test
- Manually test your module in staging/.
- Run:
```
./SDK/10_validate_module.sh
```
- fix invalid/missing if any
Promote modules to ./src
- Move ready modules from staging/ to src/ as defined in .conf.
- run
```
./SDK/20_promote_module.sh
```
Generate Documents from promoted metadata
- run
```
./SDK/30_docstring.sh
```
Consolidate modules
- Flatten src/ modules into lib/ as needed for releases.
- run
```
./SDK/40_consolidate_module.sh
```
Generate json object
- json object from consolidated modules array
- Used for:
  - ./modules_browsers/README.md
  - ./docs/index.html
  - ./lib/armbian-config/config.jobs.json
- run
```
 ./SDK/50_array_to_json.sh
```

Tabs for indentation in Bash code.
Keep configs flat: Only key=value pairs in .conf.
Each module must be:
- Runnable as a script (CLI/test).
- Sourceable by the framework (TUI/automation).
Minimal dependencies: Document any required module dependencies.
Clear help output: Each module must support --help.

For more details, see the main README.md or ask in project discussions.

This site is open source. Improve this page.