https://github.com/ferd/alias_transform
A parse transform to introduce module aliasing into Erlang code
https://github.com/ferd/alias_transform
Last synced: 9 months ago
JSON representation
A parse transform to introduce module aliasing into Erlang code
- Host: GitHub
- URL: https://github.com/ferd/alias_transform
- Owner: ferd
- License: apache-2.0
- Created: 2020-09-30T15:21:25.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2020-09-30T16:16:29.000Z (over 5 years ago)
- Last Synced: 2025-03-24T05:27:03.308Z (10 months ago)
- Language: Erlang
- Size: 5.86 KB
- Stars: 10
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
alias_transform
=====
A demo library that introduces module aliasing attributes into an Erlang code base.
Import it in your project by declaring a build-time dependency in `rebar.config`:
```erlang
{deps, [
{alias_transform,
{git, "https://github.com/ferd/alias_transform.git", {branch, "main"}}}
}.
```
You can then configure the parse transform to run against all your modules:
```erlang
{erl_opts, [
{parse_transform, alias_transform}
]}.
```
There is no need to declare the library as a run-time dependency since it
operates entirely at compile-time. Inside any Erlang module, you can declare
and use aliases such as:
```erlang
-module(whatever).
%% Original Module Name Short Alias
-alias({thrift_foo_namespace_bar_module_baz_service, service}).
f() ->
%% The call is automatically substituted here:
fun service:call/0,
%% and also in:
service:call().
```
## Limitations
Currently, this does not handle cases such as `apply(M, F, Args)`,
`spawn(M, F, Args)`, or module names passed as process or table names,
and so on.
It wouldn't necessarily be super hard to cover the direct literal cases,
but it would fail when indirect assingment using variables takes place.
Similarly, remote types of the form `M:T(...)` are currently not expanded.
This is more of a proof of concept than a serious attempt.
## Development
There's a minimal test suite in `test/`. You can execute it by calling `rebar3 ct`.