nox

v0.3.2

nox

nox v0.3.2 Nox.Npm View Source

NPM wrapper

Link to this section Summary

Types

compile_opt()

Option values specific to the compile function

compile_opts()

Options used by the compile function

install_opt()

Option values used by the install function

install_opts()

Options used by the install function

Functions

clean(_, dir)

Clean up application

compile(env, dir, opts \\ [])

Launch npm install if node_modules is stale

exe(env)

Returns full path to npm executable

install(env, dir)

Launch npm install

install(env, dir, opts)
install(env, dir, archive, opts)
install_global(env, name, opts \\ [])

Install global

node_path(dir)

Return NODE_PATH for given project

stale?(env)

Returns true if installed version matches required one

version(dir)

Returns real version given a dir

Link to this section Types

Link to this type compile_opt() View Source 
compile_opt() :: {:force, boolean()}

Option values specific to the compile function

Link to this type compile_opts() View Source 
compile_opts() :: [compile_opt() | install_opt()]

Options used by the compile function

Link to this type install_opt() View Source 
install_opt() :: {:werror, boolean()}

Option values used by the install function

Link to this type install_opts() View Source 
install_opts() :: [install_opt()]

Options used by the install function

Link to this section Functions

Link to this function clean(_, dir) View Source 
clean(Nox.Env.t(), Path.t()) :: :ok

Clean up application

Link to this function compile(env, dir, opts \\ []) View Source 
compile(Nox.Env.t(), Path.t(), compile_opts()) ::
  {:ok, warnings :: [String.t()] | :uptodate}
  | {:error,
     {code :: number(), warnings :: [String.t()], errors :: [String.t()]}}

Launch npm install if node_modules is stale

Can be forced with force opt

Link to this function exe(env) View Source

Returns full path to npm executable

Link to this function install(env, dir) View Source

Launch npm install

Link to this function install(env, dir, archive, opts) View Source 
install(Nox.Env.t(), Path.t(), install_opts() | Path.t(), install_opts()) ::
  {:ok, warnings :: [String.t()]}
  | {:error,
     {code :: number(), warnings :: [String.t()], errors :: [String.t()]}}
Link to this function install_global(env, name, opts \\ []) View Source 
install_global(Nox.Env.t(), String.t(), install_opts()) ::
  {:ok, warnings :: [String.t()]}
  | {:error,
     {code :: number(), warnings :: [String.t()], errors :: [String.t()]}}

Install global

Link to this function node_path(dir) View Source

Return NODE_PATH for given project

Link to this function stale?(env) View Source 
stale?(Nox.Env.t()) :: boolean()

Returns true if installed version matches required one

Link to this function version(dir) View Source 
version(Nox.Env.t() | Path.t()) :: String.t() | :error

Returns real version given a dir