Projectile Hanami

Summary

Projectile Hanami is an Emacs minor mode, based on Projectile, for navigating Hanami projects. With Projectile Hanami, you can:

• navigate through entities, repositories, actions, views and templates are different apps in your project;
• quickly jump to some important standard files;
• run hanami server
• run hanami console
• run hanami generate
• run Rake tasks

Projectile Hanami is based on Projectile Rails, but is not a complete port of all its functionality.

Installation

This guide assumes you have Projectile already set up.

MELPA

If you have MELPA set up, you can use package-install to install the projectile-hanami package.

Manual installation

You can manually install Projectile hanami by cloning the repository and adding it to your load-path:

(add-to-list 'load-path "/path/to/repo")
        (require 'projectile-hanami)
      

Setup

To have Projectile Hanami loaded whenever Projectile is loaded, you can add it as a hook:

(add-hook 'projectile-mode-hook 'projectile-hanami-on)
      

...but, this will most likely conflict with Projectile Rails. If you use both Ruby on Rails and Hanami, you will probably want something slightly more sophisticated. I use the following snippet:

(defun projectile-rails-or-hanami-on ()
        "Activate either `projectile-rails-mode` or `projectile-hanami-mode`."
        (if (projectile-hanami-applicable-p)
        (projectile-hanami-mode +1)
        (projectile-rails-on)))

        (add-hook 'projectile-mode-hook 'projectile-rails-or-hanami-on)
      

Since Projectile Rails cannot distinguish between Rails and Hanami projects, and Hanami can, we use Projectile Hanami's detection mechanism and fall back to Projectile Rails in case of no match.

Usage

Customization

You can define the Projectile Hanami keybinding prefix:

;; Defaults to C-c ;
        (setq projectile-hanami-keymap-prefix (kbd "C-c p C-q"))
      

To override how Hanami commands are invoked:

;; Defaults to `bundle exec hanami`
        (setq projectile-hanami-cmd "/path/to/hanami")
      

Commands