Skip to content

Latest commit

 

History

History
78 lines (63 loc) · 3.41 KB

README.md

File metadata and controls

78 lines (63 loc) · 3.41 KB
Raw

Projectile-phoenix

This project is inspired by Projectile Rails and takes some extra code from Projectile. This is also an early alpha version, so expect a couple bugs. For now the package implements navigation between some Phoenix resources.

Problem proposition

The reason this package came to be was:

  • I started working with Phoenix projects
  • I liked the experience that I had in Projectile Rails
  • There were no similar minor modes for working with Phoenix projects. While Alchemist has alchemist-phoenix-mode, the last version covers the previous version of Phoenix, with a different project structure. To update alchemist would require more work to get around the code, and that package does a lot of stuff already.

I wanted something that concerns itself only with Phoenix projects, and nothing else. So we're going to delegate whatever auxiliary features we can to other projects, such as alchemist itself for alchemist-iex-mode, mix-related stuff to mix.el and so on.

This project aims to offer quicker navigation to Phoenix-related files at first:

  • Find controller
  • Find view
  • Find template
  • Jump to test
  • Run mix tasks

Why not use Alchemist?

Alchemist offers navigation between Phoenix files with a minor mode, but it has been unmaintained for some time now.

Installation

This package is not in MELPA yet, so you need to clone this repository into your local machine:

$ git clone [email protected]:Auralcat/projectile-phoenix.git

In your Emacs configuration (usually init.el), include this snippet:

;; Location of the cloned repository, in this example it is ~/projectile-phoenix
(add-to-list 'load-path "~/projectile-phoenix")
(require "projectile-phoenix")

Configuration

To use the package's functions through keybindings, you need to provide a prefix binding in your init.el like so. This example uses "C-c .", but you're free to use any other chord you like.

(define-key projectile-phoenix-mode-map (kbd "C-c .") 'projectile-phoenix-command-map)

As an alternative, if you use evil-mode and evil-leader, you can set a binding to projectile-phoenix-command-map directly through the find-file-hook. It will bind the specified leader key to the package's functions when inside a Phoenix project buffer.

(add-hook 'find-file-hook #'(lambda ()
                              (when (projectile-phoenix-project-p)
                                (evil-leader/set-key "r" 'projectile-phoenix-command-map))))

To activate projectile-phoenix-mode automatically for Phoenix projects, include this in your init.el:

(projectile-phoenix-global-mode)

Usage

When inside a Phoenix project, press the key prefix that you configured and select a function:

Function Key
Find controller c
Find migration n
Find template l
Find mix task m
Find seed file s
Find test t
Find view v

Contributing

For detailed instructions about how the code is structured and project goals, please check CONTRIBUTING.md. If you've found a bug or want to suggest new features, please open an issue in this repository, and thank you in advance! 💜