actions icon indicating copy to clipboard operation
actions copied to clipboard

Feature Request: Add Validation for `settings.json` Configuration

Open grasmarcussanti129 opened this issue 6 months ago • 0 comments

Background

Currently, the README mentions the creation of a settings.json file that contains both required and optional configurations for the project. However, there is no mention of any validation process for this configuration file to ensure that all necessary parameters are correctly set before executing the commands.

Suggestion

I propose implementing a validation feature that checks the settings.json file for required fields and proper formats before execution. This can help prevent runtime errors due to misconfigured settings and enhance the user experience.

Potential Steps:

  1. Create a validation function within the oscript environment that reads and parses settings.json.
  2. Check for the presence of required keys and validate their values.
  3. Return clear error messages indicating which keys are missing or incorrectly formatted.

Benefits

  • Improved user experience by providing early error detection.
  • Reduction in runtime issues related to misconfigured settings.

This feature would enhance the robustness of the application and further streamline the CI/CD process for users.

grasmarcussanti129 avatar Sep 02 '25 16:09 grasmarcussanti129