Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aj-foster/phx_copy
Copy assets in your Phoenix app
https://github.com/aj-foster/phx_copy
elixir phoenix
Last synced: 6 days ago
JSON representation
Copy assets in your Phoenix app
- Host: GitHub
- URL: https://github.com/aj-foster/phx_copy
- Owner: aj-foster
- License: mit
- Created: 2022-03-23T00:25:20.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-06-05T16:40:35.000Z (7 months ago)
- Last Synced: 2024-08-09T11:12:26.983Z (5 months ago)
- Topics: elixir, phoenix
- Language: Elixir
- Homepage:
- Size: 61.5 KB
- Stars: 9
- Watchers: 4
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Phoenix Copy
[](https://hex.pm/packages/phoenix_copy)
[](https://hexdocs.pm/phoenix_copy)
[](CODE_OF_CONDUCT.md)
Copy static assets for your Phoenix app during development and deployment.
This project provides:
* A mix task `mix phx.copy` for one-time copying of files during deployment
* Integration with Phoenix watchers to provide continuous copying of files in development
* The ability to configure multiple sources and destinations for more complex workflows
It pairs nicely with the Phoenix team's [esbuild](https://github.com/phoenixframework/esbuild) and [tailwind](https://github.com/phoenixframework/tailwind) helpers for a complete asset pipeline.
## Installation
If you plan to copy assets in production, then add `phoenix_copy` as a dependency in all environments:
```elixir
def deps do
[
{:phoenix_copy, "~> 0.1.4"}
]
end
```
On the other hand, if you only need to copy assets in development, you can install it as a `dev` dependency only:
```elixir
def deps do
[
{:phoenix_copy, "~> 0.1.3", only: :dev}
]
end
```
After installation, `phoenix_copy` requires some configuration.
## Configuration
This project uses configuration _profiles_ to allow multiple configurations with the same package.
To get started, let's create a profile called `default` in the app's configuration:
```elixir
config :phoenix_copy,
default: [
source: Path.expand("../assets/static/", __DIR__),
destination: Path.expand("../priv/static/", __DIR__),
debounce: 100
],
```
In this example, files will be copied from `../assets/static/` to `../priv/static/`, two directories relative to the location of the configuration file.
By using `Path.expand(..., __DIR__)`, we can be sure that the paths won't change depending on the working directory of the caller.
`debounce` is an optional time in milliseconds to wait before executing the copy.
Multiple file changes made within the debounce period will result in a single copy event.
If you need multiple copies to take place, you can add additional profiles:
```elixir
config :phoenix_copy,
images: [
source: Path.expand("../assets/static/images/", __DIR__),
destination: Path.expand("../priv/static/images/", __DIR__)
],
docs: [
source: Path.expand("../docs/", __DIR__),
destination: Path.expand("../priv/static/docs/", __DIR__),
debounce: 100
]
```
## Usage
For **one-time copying** of files — for example, when preparing assets for deployment — use `mix phx.copy [profile] [profile2] ...` with the name of the configuration profiles.
This can integrate with a mix alias for ease-of-use (for example, in `mix.exs`):
```elixir
defp aliases do
[
"assets.deploy": [
"phx.copy default",
"esbuild default --minify",
"tailwind default --minify",
"phx.digest"
],
# ...
]
end
```
For **continuous copying** of files — for example, in development — use `Phoenix.Copy` and the `watch/1` function with the name of the configuration profile.
This can integration with Phoenix endpoint configuration for ease-of-use (for example, in `dev.exs`):
```elixir
config :my_app, MyAppWeb.Endpoint,
http: [port: 4000],
# ...
watchers: [
asset_copy: {Phoenix.Copy, :watch, [:default]},
esbuild: {Esbuild, :install_and_run, [:default, ~w(--sourcemap=inline --watch)]},
tailwind: {Tailwind, :install_and_run, [:default, ~w(--watch)]}
]
```
For continuously copying multiple profiles at once, use `{Phoenix.Copy, :watch, [[:profile1, :profile2, ...]]}`.
## Acknowledgements
This project uses code adapted from the [esbuild](https://github.com/phoenixframework/esbuild) and [tailwind](https://github.com/phoenixframework/tailwind) helpers for Phoenix.
Those projects, like this one, are licensed under the [MIT License](LICENSE).
Thank you to the contributors of both projects.