Skip to content

feat(config): add versioned JSONC configuration #235

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Waishnav wants to merge 3 commits into from
Closed

feat(config): add versioned JSONC configuration #235

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8f8ff21
feat(config): load versioned jsonc configuration
Waishnav Aug 23, 2026
2b87315
feat(config): publish v1 json schema
Waishnav Aug 23, 2026
a8eb6be
test(config): cover jsonc migration and preservation
Waishnav Aug 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 3 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
"dist",
"docs",
"examples",
"schema",
"scripts",
"skills",
"README.md"
Expand All @@ -29,7 +30,7 @@
"dev": "node scripts/dev-server.mjs",
"postinstall": "node scripts/fix-node-pty-permissions.mjs",
"start": "node dist/cli.js serve",
"test": "tsx src/config.test.ts && tsx src/runtime-config.test.ts && tsx src/onboarding.test.ts && tsx src/cli-workspace.test.ts && tsx src/request-meta.test.ts && tsx src/incoming-artifacts.test.ts && tsx src/artifact-download.test.ts && tsx src/ui/card-types.test.ts && tsx src/ui/patch-display.test.ts && tsx src/ui/tool-display.test.ts && tsx src/apply-patch.test.ts && tsx src/process-platform.test.ts && tsx src/process-sessions.test.ts && tsx src/mcp-sessions.test.ts && tsx src/server-shutdown.test.ts && tsx src/local-agent-config.test.ts && tsx src/local-agent-catalog.test.ts && tsx src/local-agent-presentation.test.ts && tsx src/local-agent-runtime.test.ts && tsx src/local-agent-daemon-lifecycle.test.ts && tsx src/local-agent-daemon-protocol.test.ts && tsx src/local-agent-daemon.test.ts && tsx src/local-agent-codex.test.ts && tsx src/local-agent-opencode.test.ts && tsx src/local-agent-acp.test.ts && tsx src/local-agent-grok.test.ts && tsx src/local-agent-pi-sandbox.test.ts && tsx src/local-agent-pi.test.ts && tsx src/local-agent-claude.test.ts && tsx src/local-agent-adapters.test.ts && tsx src/local-agent-availability.test.ts && tsx src/local-agent-profiles.test.ts && tsx src/local-agent-targets.test.ts && tsx src/local-agent-store.test.ts && tsx src/local-agent-manager.test.ts && tsx src/roots.test.ts && tsx src/skills.test.ts && tsx src/workspaces.test.ts && tsx src/workspace-conversation.test.ts && tsx src/review-checkpoints.test.ts && tsx src/server.test.ts && tsx src/oauth-store.test.ts && tsx src/cli.test.ts",
"test": "tsx src/config.test.ts && tsx src/user-config.test.ts && tsx src/config-schema.test.ts && tsx src/runtime-config.test.ts && tsx src/onboarding.test.ts && tsx src/cli-workspace.test.ts && tsx src/request-meta.test.ts && tsx src/incoming-artifacts.test.ts && tsx src/artifact-download.test.ts && tsx src/ui/card-types.test.ts && tsx src/ui/patch-display.test.ts && tsx src/ui/tool-display.test.ts && tsx src/apply-patch.test.ts && tsx src/process-platform.test.ts && tsx src/process-sessions.test.ts && tsx src/mcp-sessions.test.ts && tsx src/server-shutdown.test.ts && tsx src/local-agent-config.test.ts && tsx src/local-agent-catalog.test.ts && tsx src/local-agent-presentation.test.ts && tsx src/local-agent-runtime.test.ts && tsx src/local-agent-daemon-lifecycle.test.ts && tsx src/local-agent-daemon-protocol.test.ts && tsx src/local-agent-daemon.test.ts && tsx src/local-agent-codex.test.ts && tsx src/local-agent-opencode.test.ts && tsx src/local-agent-acp.test.ts && tsx src/local-agent-grok.test.ts && tsx src/local-agent-pi-sandbox.test.ts && tsx src/local-agent-pi.test.ts && tsx src/local-agent-claude.test.ts && tsx src/local-agent-adapters.test.ts && tsx src/local-agent-availability.test.ts && tsx src/local-agent-profiles.test.ts && tsx src/local-agent-targets.test.ts && tsx src/local-agent-store.test.ts && tsx src/local-agent-manager.test.ts && tsx src/roots.test.ts && tsx src/skills.test.ts && tsx src/workspaces.test.ts && tsx src/workspace-conversation.test.ts && tsx src/review-checkpoints.test.ts && tsx src/server.test.ts && tsx src/oauth-store.test.ts && tsx src/cli.test.ts",
"typecheck": "tsc -p tsconfig.json --noEmit"
},
"keywords": [],
Expand All @@ -51,6 +52,7 @@
"diff": "^8.0.3",
"drizzle-orm": "^0.45.2",
"express": "^5.2.1",
"jsonc-parser": "^3.3.1",
"lucide": "^1.24.0",
"react": "^19.2.6",
"react-dom": "^19.2.6",
Expand Down
308 changes: 308 additions & 0 deletions schema/devspace-config.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,308 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"$schema": {
"description": "JSON Schema URL used by editors.",
"type": "string"
},
"version": {
"type": "number",
"const": 1
},
"server": {
"type": "object",
"properties": {
"host": {
"description": "Local bind host. Defaults to 127.0.0.1.",
"type": "string"
},
"port": {
"description": "Local MCP server port.",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"allowedRoots": {
"description": "Project roots DevSpace may open.",
"type": "array",
"items": {
"type": "string"
}
},
"publicBaseUrl": {
"description": "Public origin used by remote MCP hosts.",
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"allowedHosts": {
"description": "Optional HTTP Host allowlist.",
"type": "array",
"items": {
"type": "string"
}
},
"stateDir": {
"description": "Directory containing persisted DevSpace state.",
"type": "string"
},
"worktreeRoot": {
"description": "Directory for DevSpace-managed Git worktrees.",
"type": "string"
}
},
"additionalProperties": false
},
"harness": {
"oneOf": [
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "claude-code",
"description": "Expose the Claude Code-style coding harness."
},
"inspection": {
"type": "string",
"enum": [
"shell",
"dedicated"
],
"description": "Use shell inspection or expose dedicated grep/glob/ls tools."
}
},
"required": [
"kind",
"inspection"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "codex",
"description": "Expose the Codex-style coding harness."
}
},
"required": [
"kind"
],
"additionalProperties": false
}
]
},
"presentation": {
"oneOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"const": "off"
}
},
"required": [
"mode"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"const": "inline"
}
},
"required": [
"mode"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"const": "change-review"
}
},
"required": [
"mode"
],
"additionalProperties": false
}
]
},
"skills": {
"type": "object",
"properties": {
"enabled": {
"description": "Whether skills are exposed to the host model.",
"type": "boolean"
},
"paths": {
"description": "Additional skill directories.",
"type": "array",
"items": {
"type": "string"
}
},
"agentDir": {
"description": "Compatibility agent directory. Defaults to ~/.codex.",
"type": "string"
}
},
"additionalProperties": false
},
"artifacts": {
"type": "object",
"properties": {
"enabled": {
"description": "Enable native MCP-host artifact download.",
"type": "boolean"
},
"maxFileBytes": {
"description": "Maximum bytes accepted for one artifact.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"additionalProperties": false
},
"subagents": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"providers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"codex",
"claude",
"opencode",
"pi",
"cursor",
"copilot",
"grok"
]
},
"enabled": {
"type": "boolean"
},
"model": {
"type": "string",
"minLength": 1
},
"effort": {
"type": "string",
"minLength": 1
}
},
"required": [
"id",
"enabled"
],
"additionalProperties": false
}
}
},
"required": [
"enabled",
"providers"
],
"additionalProperties": false
},
"logging": {
"type": "object",
"properties": {
"level": {
"type": "string",
"enum": [
"silent",
"error",
"warn",
"info",
"debug"
]
},
"format": {
"type": "string",
"enum": [
"json",
"pretty"
]
},
"requests": {
"type": "boolean"
},
"assets": {
"type": "boolean"
},
"toolCalls": {
"type": "boolean"
},
"shellCommands": {
"type": "boolean"
},
"trustProxy": {
"type": "boolean"
}
},
"additionalProperties": false
},
"oauth": {
"type": "object",
"properties": {
"accessTokenTtlSeconds": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"refreshTokenTtlSeconds": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"scopes": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
},
"allowedRedirectHosts": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
}
},
"additionalProperties": false
}
},
"required": [
"version"
],
"additionalProperties": false,
"$id": "https://raw.githubusercontent.com/Waishnav/devspace/refs/tags/v1.1.0/schema/devspace-config.schema.json",
"title": "DevSpace configuration",
"description": "Versioned configuration for the DevSpace server and coding harness."
}
Loading
Loading