vigneshksaithal/update-devvit-config

Update Devvit Config

All code must follow the Coding Principles in AGENTS.md (functional, minimal, readable, modular).

devvit.json structure

{
  "$schema": "https://developers.reddit.com/schema/config-file.v1.json",
  "name": "app-name",
  "post": {
    "dir": "dist/client",
    "entrypoints": {
      "default": {
        "entry": "src/client/index.html",
        "height": "tall",       // "short" | "regular" | "tall"
        "inline": true          // renders inside post, not popup
      }
    }
  },
  "server": {
    "dir": "dist/server",
    "entry": "index.cjs"
  },
  "menu": { ... },
  "triggers": { ... },
  "dev": { ... }
}

Adding a menu item

Menu items appear in Reddit's "..." menu on posts or subreddits. Each maps to an /internal/menu/* endpoint.

{
  "menu": {
    "items": [
      {
        "label": "Human-readable label",
        "description": "Tooltip text",
        "location": "subreddit",
        "forUserType": "moderator",
        "endpoint": "/internal/menu/action-name"
      }
    ]
  }
}

| Field | Values | Notes | |-------|--------|-------| | location | "subreddit", "post", "comment" | Where the menu item appears | | forUserType | "moderator", "member" | Who can see it | | endpoint | /internal/menu/{name} | Must match a Hono route |

After adding a menu item, create the matching Hono handler:

app.post('/internal/menu/action-name', async (c) => {
  // handler logic
  return c.json({ status: 'success', data: {} })
})

Adding a trigger

Triggers fire on platform events. Each maps to an /internal/* endpoint.

{
  "triggers": {
    "onAppInstall": "/internal/on-app-install",
    "onPostCreate": "/internal/on-post-create",
    "onCommentCreate": "/internal/on-comment-create"
  }
}

| Trigger | Fires when | |---------|-----------| | onAppInstall | App installed on a subreddit | | onAppUpgrade | App updated to new version | | onPostCreate | New post created in subreddit | | onCommentCreate | New comment on any post | | onPostDelete | Post deleted | | onCommentDelete | Comment deleted |

Post height options

| Height | Pixels | Use case | |--------|--------|----------| | "short" | ~240px | Simple widgets, counters | | "regular" | ~320px | Cards, small games | | "tall" | ~512px | Full games, complex UI |

Checklist before finishing

• [ ] Tests written FIRST for corresponding server handlers in src/server/__tests__/
• [ ] Menu item endpoint matches a Hono route in src/server/index.ts
• [ ] Trigger endpoint matches a Hono route
• [ ] location and forUserType are appropriate for the action
• [ ] Endpoint path follows /internal/menu/* or /internal/on-* convention
• [ ] Corresponding server handler exists and handles errors
• [ ] bun run test passes with zero failures