PhoenixJsroutes

Brings phoenix router helpers to your javascript code.

This project is a mix compiler task that generates a javascript module containing helpers to access your server routes.

Installation

Add the latest version to your mix.exs file:

def deps do
  [{:phoenix_jsroutes, "~> 1.0.0"}]
end

Compatibility

NOTE: Those are tested versions, it does not mean it will not work on newer versions.

Getting started

Add the jsroutes compiler to the list of compilers in your project.

def project do
    [app: :jsroutes_test,
    ...
    compilers: [:phoenix, :gettext] ++ Mix.compilers ++ [:jsroutes]
    ...]
end

This compiler should be placed after the elixir compiler, this is important because your router module should be already compiled when this compiler runs

After that, if you run mix compile the file assets/static/js/phoenix-jsroutes.js will be generated.

You can clean up the generated file by running mix clean.

The location and file name can be changed (see Configuration section bellow), keep in mind that if you change it, mix clean will not be able to remove the old file. It's recomended to always run mix clean before you update this config.

Using the javascript helpers

The code generated by this compiler is compatible with AMD, Commonjs and Global builds.

The functions are generated with different names from the ones in the server in order to follow javascript best practices. For example:

user_path(:index)                => userIndex()
user_path(:create)               => userCreate()
user_path(:update, 1)            => userUpdate(1)
user_friends_path(:update, 1, 2) => userFriendsUpdate(1, 2)

If you are using the default phoenix configuration with webpack (or any other commonjs compatible build tool like webpack and browserify) you can use the helpers like this

import routes from '../static/js/phoenix-jsroutes'
routes.userIndex(); // /users
routes.userCreate(); // /users
routes.userUpdate(1); // /users/1
routes.userFriendsUpdate(1, 2); // /users/1/friends/2

You can also import only the routes you need

import { userIndex, userUpdate } from '../static/js/phoenix-jsroutes';
userIndex();
userUpdate(1);

For AMD builds

require(['phoenix-jsroutes'], routes => {
  routes.userIndex();
})

For Global builds

PhoenixJsRoutes.userIndex();
// If the name conflicts with anything...
var myBeautifulName = PhoenixJsRoutes.noConflict();

Live reload

If you want the javascript module to be generated automatically when your router changes, just add this compiler to the list of reloadable compilers.

# config/dev.exs

config :my_app, MyApp.Endpoint,
  http: [port: 4000],
  ...
  reloadable_compilers: [:gettext, :phoenix, :elixir, :jsroutes]

Configuration

Configurations should be added to the key :jsroutes in your application.

config :my_app, :jsroutes,
  output_folder: "assets/static/js",
  include: ~r[/api],
  exclude: ~r[/admin]

Contributing

Contributions are very welcome. If you want to contribute to this project first open an issue so we can discuss your ideas, if you're confident in implementing it, fork the project and create a pull request. Thank's in advance :).

Contributors

Special thanks to thep people who have helped me start this project.

Marcio Junior
Horacio Fernandes
Diogo Kersting
Paulo