NPM.Hooks (NPM v0.6.0)

Hooks for integrating npm operations with Mix workflows.

Provides callbacks that can be triggered before and after npm operations, useful for mix compiler integration and build pipelines.

Summary

hook()

available()

Available hook points.

configured()

List all configured hooks.

Check if a hook is configured.

Run a hook callback if configured.

@type hook() :: :pre_install | :post_install | :pre_resolve | :post_resolve

@spec available() :: [hook()]

Available hook points.

@spec configured() :: %{required(hook()) => term()}

List all configured hooks.

@spec configured?(hook()) :: boolean()

Check if a hook is configured.

@spec run(
  hook(),
  keyword()
) :: :ok

Run a hook callback if configured.

Hooks are configured via application config:

config :npm, hooks: %{
  post_install: {MyApp, :on_npm_install, []}
}