[Development] Updated Centralized Metadata Storage (Database)

[Tearran]

module_options: Centralized Metadata Storage (Database)

The module_options array is used as a centralized Metadata Storage (Database) in the Armbian config system. This tool and pull request aim to unify the relative key pairs used between unit-testing, UX-menu, and CLI-api, ensuring consistency and preventing divergence across different paths.

Purpose

The primary purpose of module_options is to store all relevant metadata for each module in a centralized manner. By centralizing this metadata, the system can dynamically generate various configurations and scripts, such as JSON objects, unit tests, and documentation, while reducing redundancy and ensuring consistency.

Commands

The module_api_files script provides several commands to work with the module_options array:

./bin/armbian-config --api module_api_files help

Usage

Usage: module_api_files <command>
Commands:  help array json test all
Available commands:
        array   - Generate module_options files from production module_options array.
        json    - Generate JSON object from module_options.
        test    - Generate unit-test CONF from module_options.
        all     - Generate all of the above.

Command Descriptions

1. array

   • Description: Generate module_options files from the production module_options array.
   • Usage:

     ./bin/armbian-config --api module_api_files array

   • Details: Disassembles the array and adds missing keys. If the Menu subgroup keys exist, it places a *_array.sh file in the corresponding parent folder. For arrays without the required subgroup keys, the added *_array.sh file is placed in ./tools/dev/array/ to indicate an update is needed.

2. json

   • Description: Generate a JSON object from module_options.
   • Usage:

     ./bin/armbian-config --api module_api_files json

   • Details: Converts the module_options array into a JSON object, providing a structured format for the metadata.

3. test

   • Description: Generate unit-test CONF from module_options.
   • Usage:

     ./bin/armbian-config --api module_api_files test

   • Details: Creates unit-test configuration files based on the module_options array.

4. all

   • Description: Generate all of the above (array, json, test).
   • Usage:

     ./bin/armbian-config --api module_api_files all

   • Details: Executes all the above commands sequentially, generating the respective outputs.

Example

To generate the module_options files and add missing keys, use:

./bin/armbian-config --api module_api_files array

This will disassemble the array and handle the keys as described, ensuring that the metadata is up-to-date and accurately reflects the current state of the modules.

By using module_options as a centralized metadata storage (database), the Armbian config system can dynamically handle commands, generate required configurations, and reduce redundancy, leading to a more streamlined and unified process.

[Tearran]

./bin/armbian-config --api see_menu module_api_files