Generate Components

generate-components

Use this skill when generating Hanami 2.x components via the CLI.

Core principle: Generators follow naming conventions. The command name determines the file path and class name.

Quick Reference

Core Rules

1. Generate an Action:

   hanami generate action users.index
   

   Generates:

   • app/actions/users/index.rb
   • Class: MyApp::Actions::Users::Index

   With a Slice:

   hanami generate action api.users.index
   

   Generates:

   • slices/api/actions/users/index.rb
   • Class: MyApp::Slices::Api::Actions::Users::Index

2. Generate a View:

   hanami generate view users.index
   

   Generates:

   • app/views/users/index.rb
   • app/templates/users/index.html.erb

3. Generate a Slice:

   hanami generate slice api
   

   Generates:

   • slices/api/config/routes.rb
   • slices/api/config/slice.rb
   • slices/api/actions/
   • slices/api/views/
   • slices/api/templates/

4. Generate a migration:

   hanami generate migration create_users
   

   Generates:

   • db/migrate/{timestamp}_create_users.rb

5. Always verify generated files: Generators will fail if target files already exist. After generating, confirm the expected files are present and correctly named:

   # Confirm the action file exists
   ls app/actions/users/index.rb
   
   # Confirm the view and template were created together
   ls app/views/users/index.rb app/templates/users/index.html.erb
   
   # Confirm class name matches module nesting by grepping the generated file
   grep 'class Index' app/actions/users/index.rb
   # Expected: class Index < MyApp::Action (or equivalent)
   

   Key checks:

   • File paths match the expected pattern.
   • Class names align with module nesting (e.g. users.index → MyApp::Actions::Users::Index).
   • Slices are correctly prefixed: <slice>.<resource>.<action> (omitting this places components in the default app/ folder).

Common Mistakes & Troubleshooting

Integration