Skip to content

Feature Request: Add Validation for settings.json Configuration #3

@grasmarcussanti129

Description

@grasmarcussanti129

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions