Golem Add Module
Developmentgolem-add-moduleGolem Add Module is an Agent Skill for development published in the ThinkR-open/golem repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.
Add a module to an existing golem Shiny application. Triggers on: - "add a module" - "create a module" - "add a golem module" Do not trigger on: - when the user is not working inside a golem app
How to use this skill
Bring this guide into your coding agent with a prompt tailored to the tool you use.
- Open your project in Codex.
- Copy and paste the prompt below.
- Review files and risks before approving any action.
Inspect the Agent Skill at https://github.com/ThinkR-open/golem/blob/HEAD/inst/agent-skills/skills/golem-add-module/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/golem-add-module, but wait for my approval before writing files or running scripts.
Copying this prompt does not install or run the skill. Review third-party files before use.
Add Module
You are helping a user add a new module to an existing golem Shiny application.
Creating a Module
Use golem::add_module("name", with_test = TRUE) to create a new module with proper structure.
Module Structure
A golem module consists of:
mod_<name>_ui()- User interface functionmod_<name>_server()- Server logic function
Important Rules
UI Functions
- Always use
ns <- NS(id)to namespace UI elements - Check for missing
nsprefixes when building the UI - Never forget to namespace input/output IDs
Server Functions
- Use
moduleServer()- NEVER use the deprecatedcallModule() - Use
reactiveValues()for internal state, NOTreactive()orreactiveVal() - Use
observeEvent()- NEVER useobserve() - Always put reactive values inside a reactive consumer
Example pattern:
mod_<name>_server <- function(id) {
moduleServer(id, function(input, output, session) {
local_rv <- reactiveValues()
observeEvent(
input$btn,
{
local_rv$value <- compute_things(input$btn)
}
)
output$plot <- renderPlot({
local_rv$value
})
})
}
Reactive Programming Rules
- NEVER pass
reactive()objects between modules unless explicitly prompted - Avoid
renderUI()+uiOutput()- preferupdate*()functions - Watch for reactive cycles (A updates B updates A) - break them with explicit conditions
- Use a
reactiveValues()object for sharing data between modules, but only include what's necessary
Testing
- Create tests with
usethis::use_test("mod_<name>") - Each test should set up its own data inline
- Use
withr::local_*()for temporary state changes
Next Steps
After adding the module:
- Edit the module files to add your UI and server logic
- Run
devtools::document()if you added roxygen comments - Add the module to your app UI in
app_ui.R - Call it in
app_server()withmod_<name>_server("module_id") - Run tests with
devtools::test()