GitHub Issues

v0.4.19

GitHub Issues v0.4.19 GitHub.Issues.CLI View Source

Parses the command line and generates a table of the first or last n issues of a GitHub project.

Inspired by the book Programming Elixir by Dave Thomas.

Link to this section Summary

Types

bell()
count()
parsed()
project()
user()

Functions

main(argv)

Parses and processes argv (command line arguments)

parse(argv)

Parses argv (command line arguments)

Link to this section Types

Link to this type parsed() View Source 
parsed() ::
  {user(), project(), count(), bell(), IO.ANSI.Table.Style.t()} | :help

Link to this section Functions

Link to this function main(argv) View Source 
main([String.t()]) :: :ok | no_return()

Parses and processes argv (command line arguments).

Parameters

  • argv - command line arguments (list)
Link to this function parse(argv) View Source 
parse([String.t()]) :: parsed()

Parses argv (command line arguments).

argv can be [“-h”] or [“—help”], which returns :help. Otherwise it contains a user name, project name, and optionally the number of issues to format (the first n ones). To format the last n issues, specify switch --last which will return a negative count. To ring the bell, specify switch --bell. To apply a specific table style, use switch --table-style.

Returns either a tuple of {user, project, count, bell, table_style} or :help if --help was specified.

Parameters

  • argv - command line arguments (list)

Switches

  • -h or --help - for help
  • -l or --last - to format the last n issues
  • -b or --bell - to ring the bell
  • -t or --table-style - to apply a specific table style

Table styles

  • bare - no colors
  • barish - like bare but colored
  • cyan - cyan background
  • cyan-alt - cyan header, alternating row colors
  • cyan-border - light cyan border
  • cyan-mult - cyan header, 3 repeating row colors
  • dark - dark colors
  • dark-alt - dark colors, alternating row colors
  • dark-mult - dark colors, 3 repeating row colors
  • dashed - no colors
  • dotted - slightly colored
  • dotted-alt - slightly colored, alternating row colors
  • dotted-mult - slightly colored, 3 repeating row colors
  • game - game board
  • green - green background
  • green-alt - green header, alternating row colors
  • green-border - light green border
  • green-border-padded - light green border with extra padding
  • green-border-unpadded - light green border without padding
  • green-mult - green header, 3 repeating row colors
  • green-padded - like green but with extra padding
  • green-unpadded - like green but without padding
  • light - light colors
  • light-alt - light colors, alternating row colors
  • light-mult - light colors, 3 repeating row colors
  • medium - medium colors
  • medium-alt - medium colors, alternating row colors
  • medium-mult - medium colors, 3 repeating row colors
  • mixed - fillers revealed
  • plain - slightly colored
  • pretty - multicolored
  • pretty-alt - multicolored, alternating row colors
  • pretty-mult - multicolored, 3 repeating row colors
  • test - no colors
  • yellow - light yellow background
  • yellow-border - light yellow border

Examples 

iex> alias GitHub.Issues.CLI
iex> CLI.parse(["-h"])
:help

iex> alias GitHub.Issues.CLI
iex> CLI.parse(["user", "project", "99"])
{"user", "project", 99, false, :medium}

iex> alias GitHub.Issues.CLI
iex> CLI.parse(["user", "project", "88", "--last", "--bell"])
{"user", "project", -88, true, :medium}

iex> alias GitHub.Issues.CLI
iex> CLI.parse(["user", "project", "6", "--table-style", "dark"])
{"user", "project", 6, false, :dark}