mythic-insight/mash
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

chore: Add :env to helper documentation

Browse source
This commit is contained in:
Robert Prehn 2023-08-10 10:58:02 +00:00
parent dbb6241c40
commit 9c6888b694
No known key found for this signature in database
1 changed files with 11 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
lib/mash/helpers.ex
View file

@ -3,8 +3,13 @@ defmodule Mash.Helpers do
Helpers that provide a simple way to write Mash configs. Helpers that provide a simple way to write Mash configs.
""" """
@doc "Create a run function for a job that executes a mix task with name `task_name` and the arguments `args`" @doc """
@spec mix(String.t(), [String.t()]) :: function() Create a run function for a job that executes a mix task with name `task_name` and the arguments `args`.
Available opts:
- `:env` -- a list of {key, value} pairs that will be used as environment variables.
"""
@spec mix(String.t(), [String.t()], Keyword.t()) :: function()
def mix(task_name, args \\ [], opts \\ []) do def mix(task_name, args \\ [], opts \\ []) do
env = Keyword.get(opts, :env, []) env = Keyword.get(opts, :env, [])
@ -21,8 +26,11 @@ defmodule Mash.Helpers do
@doc """ @doc """
Create a run function which executes the script/binary named `command` with the arguments `args`. Create a run function which executes the script/binary named `command` with the arguments `args`.
Available opts:
- `:env` -- a list of {key, value} pairs that will be used as environment variables.
""" """
@spec shell(String.t(), [String.t()]) :: function() @spec shell(String.t(), [String.t()], Keyword.t()) :: function()
def shell(command, args \\ [], opts \\ []) do def shell(command, args \\ [], opts \\ []) do
env = Keyword.get(opts, :env, []) env = Keyword.get(opts, :env, [])