GitHub.Issues.CLI (GitHub Issues v0.4.59)

View Source

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

Inspired by the book Programming Elixir by Dave Thomas.
Reference https://dev.to/paulasantamaria/command-line-interfaces-structure-syntax-2533

Summary

Types

project()

GitHub project

user()

GitHub user

Functions

main()

Allows to run command mix run -e 'GitHub.Issues.CLI.main()'.

main(argv)

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

Types

project()

@type project() :: String.t()

GitHub project

user()

@type user() :: String.t()

GitHub user

Functions

main()

@spec main() :: :ok

Allows to run command mix run -e 'GitHub.Issues.CLI.main()'.

The above command is equivalent to:
mix run -e 'GitHub.Issues.CLI.main([""Kraigie"", ""nostrum"", ""6""])'

Examples

$env:MIX_ENV="test"; mix run -e 'GitHub.Issues.CLI.main()'
$env:MIX_ENV="dev"; mix run -e 'GitHub.Issues.CLI.main()'
$env:MIX_ENV="prod"; mix run -e 'GitHub.Issues.CLI.main()'

main(argv)

@spec main(OptionParser.argv()) :: :ok

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

argv can be "-h" or "--help", which prints info on the command's usage and syntax. Otherwise it is a GitHub user, a GitHub project, and optionally the number of issues to format (the first n ones). To format the last n issues, specify switch --last.

To ring the bell, specify switch --bell. To choose a table style, specify switch --table-style.

Parameters

  • argv - command line arguments (list)

Switches

  • -h or --help - for help
  • -b or --bell - to ring the bell
  • -l or --last - to format the last n issues
  • -t or --table-style - to choose a 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

alias GitHub.Issues.CLI
CLI.main(["Kraigie", "nostrum", "--last", "--no-help"])
CLI.main(["Kraigie", "nostrum", "--no-last"])
CLI.main(["Kraigie", "nostrum", "--no-bell", "--table-style", "plain"])
CLI.main(["Kraigie", "nostrum", "11", "--last"])
CLI.main(["Kraigie", "nostrum", "--last", "11"])