Skip to content

config: add json struct tags to ResolvedConfig for stable CLI JSON output #77

Description

@bilby91

`config.ResolvedConfig` has no `json:` struct tags, so `encoding/json` emits Go-PascalCase field names (`DevcontainerID`, `Source`, `ContainerWorkspaceFolder`, …).

That's fine when the library is embedded, but it makes `devcontainer read-configuration` output awkward for anyone piping into `jq` — and it's not a stable shape (a struct field rename silently changes the JSON key).

Add explicit `json:` tags using camelCase / spec-style names where the spec defines them (`workspaceFolder`, `remoteUser`, `containerEnv`, etc.), and our own conventions for fields not in the spec (`devcontainerId`, `source`, `warnings`).

Benefits:

  • Stable CLI output shape, usable with `jq`
  • Spec-aligned where it makes sense
  • Cheaper for any future programmatic consumer

Worth verifying nothing else in the repo (tests, examples) depends on the current PascalCase JSON.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    area/configConfig / devcontainer.json parsing + resolveenhancementNew feature or request

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions