Environment Variable Template Generator

{
  "type": "object",
  "required": [
    "code",
    "project_description"
  ],
  "properties": {
    "code": {
      "type": "string",
      "minLength": 1,
      "description": "The source code to scan for environment variable references."
    },
    "project_description": {
      "type": "string",
      "minLength": 1,
      "description": "A short plain-language description of the project the code belongs to, used to word the variable descriptions and sample values."
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "properties": {
    "variables": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "The variable's name."
          },
          "required": {
            "type": "boolean",
            "description": "Whether the code needs the variable to be set."
          },
          "description": {
            "type": "string",
            "description": "What the variable configures."
          },
          "source_line": {
            "type": "number",
            "description": "A line number in the given code where the variable is read (not always the first)."
          },
          "example_value": {
            "type": "string",
            "description": "A placeholder sample value, not a real setting."
          }
        }
      },
      "description": "One entry per environment variable found in the code."
    },
    "env_template": {
      "type": "string",
      "description": "The .env file text: a comment line describing each variable (marked required or optional) followed by NAME=sample value."
    },
    "total_variables": {
      "type": "number",
      "description": "How many variables were found."
    }
  },
  "description": "The generated environment template, as returned after shaping."
}