Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/axelson/exsync_lib
https://github.com/axelson/exsync_lib
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/axelson/exsync_lib
- Owner: axelson
- License: bsd-3-clause
- Created: 2024-09-21T07:07:00.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-09-21T07:12:46.000Z (4 months ago)
- Last Synced: 2024-11-29T20:30:56.800Z (about 2 months ago)
- Language: Elixir
- Size: 63.5 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# ExSyncLib
ExSyncLib is a version of [exsync](https://github.com/falood/exsync/) that can be used as a library and is more configurable. If you want to reload code when it is updated and take granular actions then this might be a good fit.
## Current Status
ExSyncLib is partially finished, it might be workable but it is not documented and I don't currently have plans to support it or finish it.
## TODO
TODO:
- [ ] Move mixfile parsing code from NervesLiveReload to ExSyncLib
- [ ] Correctly handle default src_extensions
- [ ] Pass in build_path and use `MIX_BUILD_PATH` to not stomp on the user's compiled code
- Or should it be `MIX_BUILD_ROOT`?
- [ ] This will involve modifying the beam_dirs to match
- [ ] Run `mix compile` once before the beam watcher starts up
- This will save the beam watcher from not being able to watch directories because they don't yet exist
Thoughts:
- Maybe this should be a behavior, that you have to pass an implementing module
to in order to start the supervision tree
## System Support
ExSyncLib deps on [FileSystem](https://github.com/falood/file_system)
## Usage
1. Create a new application:
```bash
mix new my_app
```
2. Add exsync_lib to your `mix.exs` dependencies:
```elixir
def deps do
[
{:exsync_lib, "~> 0.2", only: :dev},
]
end
```
Optionally add this snippet to your `.iex.exs` (in the root of your project) or your `~/.iex.exs`:
```
if Code.ensure_loaded?(ExSyncLib) && function_exported?(ExSyncLib, :register_group_leader, 0) do
ExSyncLib.register_group_leader()
end
```
This will prevent the ExSyncLib logs from overwriting your IEx prompt.
Alternatively you can always just run `ExSyncLib.register_group_leader()` in your
IEx prompt.
## Usage for umbrella project
1. Create an umbrella project
```bash
mix new my_umbrella_app --umbrella
```
2. Add exsync_lib to your `mix.exs` dependencies:
```elixir
def deps do
[
{:exsync_lib, "~> 0.2", only: :dev},
]
end
```
3. start your umbrella project with `exsync_lib` task
```bash
iex -S mix exsync_lib
```
## Config
All configuration for this library is handled via the application environment.
`:addition_dirs` - Additional directories to monitor
For example, to monitor the `priv` directory, add this to your `config.exs`:
```elixir
config :exsync_lib, addition_dirs: ["/priv"]
```
`:extensions` - List of file extensions to watch for changes. Defaults to: `[".erl", ".hrl", ".ex", ".eex"]`
`:extra_extensions` - List of additional extensions to watch for changes (cannot be used with `:extensions`)
For example, to watch `.js` and `.css` files add this to your `config.exs`:
```elixir
config :exsync_lib, extra_extensions: [".js", ".css"]
```
`:logging_enabled` - Set to false to disable logging (default true)
`:reload_callback` - A callback [MFA](https://codereviewvideos.com/blog/what-is-mfa-in-elixir/) that is called when a set of files are done reloading. Can be used to implement your own special handling to react to file reloads.
`:reload_timeout` - Amount of time to wait in milliseconds before triggering the `:reload_callback`. Defaults to 150ms.
For example, to call `MyApp.MyModule.handle_reload()` add this to your `config.exs`:
```elixir
config :exsync_lib,
reload_timeout: 75,
reload_callback: {MyApp.MyModule, :handle_reload, []}
```