View Source NpmDeps (NpmDeps v0.2.1)
a-tool-to-help-you-manage-your-npm-dependencies-in-elixir-projects-without-the-need-of-node-js-or-npm-in-your-project-or-in-your-machine
A tool to help you manage your NPM dependencies in Elixir projects without the need of Node.js or NPM in your project or in your machine.
⚠️ This project is very experimental, in early development and should be used with caution.
setup
Setup
The package can be installed by adding npm_deps
to your list of dependencies in mix.exs
. And you should also add the npm_deps
to your project/0
, pointing to a list with your desired NPM dependencies.
def project do
[
app: :your_app,
version: "0.1.0",
elixir: "~> 1.14",
...
npm_deps: npm_deps()
]
end
def deps do
[
...
{:npm_deps, "~> 0.2.1", runtime: false}
]
end
def npm_deps do
[
{:topbar, "1.0.1"}
]
end
Once you have added it, you can run mix npm_deps.get
to get your NPM dependencies.
The NPM dependencies will be installed in the deps/
directory of your project, side by side with the Elixir dependencies.
If you are using Phoenix and ESBuild, the default setup will work out of the box. Allowing you to import the NPM dependencies in your JS files.
import "phoenix_html";
import { Socket } from "phoenix";
import { LiveSocket } from "phoenix_live_view";
import topbar from "topbar";
// Show progress bar on live navigation and form submits
topbar.config({ barColors: { 0: "#29d" }, shadowColor: "rgba(0, 0, 0, .3)" });
window.addEventListener("phx:page-loading-start", info => topbar.show());
window.addEventListener("phx:page-loading-stop", info => topbar.hide());
To run npm_deps.get
in your deploy pipeline, you can add it to your assets.deploy
task, also in mix.exs
.
defp aliases do
[
...
"assets.deploy": [
"npm_deps.get",
"esbuild default --minify",
"phx.digest"
]
]
end
Link to this section Summary
Functions
Returns the path to the package. The package may not be available if it was not yet installed.
Link to this section Functions
Returns the path to the package. The package may not be available if it was not yet installed.