Skip to content

Commit f956e8e

Browse files
committed
Replace ACTION with COMMAND. Docs improved
1 parent c044007 commit f956e8e

File tree

1 file changed

+35
-35
lines changed

1 file changed

+35
-35
lines changed

get-elixir.sh

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
11
#!/bin/sh
22

3-
# TODO: add action to add the desired path to path.
4-
53
APP_NAME="elixir-get"
6-
APP_VERSION="0.0.1-dev"
7-
COMMAND="./get-elixir.sh"
4+
APP_VERSION="0.0.1"
5+
APP_COMMAND="./get-elixir.sh"
86
ELIXIR_CSV_URL="https://raw.githubusercontent.com/elixir-lang/elixir-lang.github.com/master/elixir.csv"
97
ELIXIR_RELEASES_URL="https://github.com/elixir-lang/elixir/releases"
108
ELIXIR_RELEASE_TAG_URL=""
@@ -15,65 +13,67 @@ DEFAULT_DEST_DIR="elixir"
1513
DEFAULT_VERSION="latest"
1614

1715
#ARGS VARIABLES
18-
ACTION=""
16+
COMMAND=""
1917
PACKAGE_TYPE=""
2018
VERSION=""
2119
DEST_DIR=""
2220

2321
# FUNCTIONS
2422

2523
short_help() {
26-
echo "${COMMAND}: missing arguments.
24+
echo "${APP_COMMAND}: missing arguments.
2725
28-
Usage: ${COMMAND} (unpack | download) (source | precompiled) [<VERSION_NUMBER> | latest] [<DEST_DIR>]
26+
Usage: ./get-elixir.sh (unpack | download) (source | precompiled)
27+
[<version_number> | latest] [<dest_dir>]
2928
3029
Example:
31-
${COMMAND} unpack source
30+
${APP_COMMAND} unpack source
3231
33-
Try \`${COMMAND} --help\` for more information."
32+
Try '${APP_COMMAND} --help' for more information."
3433
}
3534

3635
help() {
3736
echo "${APP_NAME} version ${VERSION}
3837
39-
Get any released version of the Elixir programming language,
38+
Get any release of the Elixir programming language,
4039
without leaving the comfort of your command line.
41-
http://elixir-lang.org
4240
43-
Usage: ${COMMAND} ACTION PACKAGE_TYPE [VERSION_NUMBER] [DEST_DIR]
41+
Usage: ./get-elixir.sh <command> <package_type> [<version_number>]
42+
[<dest_dir>]
4443
45-
Actions:
46-
download Downloads the package
47-
unpack Downloads the package and unpacks it
44+
Commands:
45+
download Downloads the package
46+
unpack Downloads the package and unpacks it
4847
4948
Package Types:
50-
source Source files
51-
precompiled Precompiled files
49+
source Source files
50+
precompiled Precompiled files
5251
5352
Version Number:
54-
'latest' is the default option, and it's not required to specify it
55-
(unless a DEST_DIR want to be used)
56-
Examples: 'latest', '1.0.5', '1.0.0-rc2'
53+
'latest' is the default option, and it's not required to specify it
54+
(unless a DEST_DIR want to be used)
55+
Examples: 'latest', '1.0.5', '1.0.0-rc2'
5756
5857
Destination Dir:
59-
Where you want to unpack Elixir. Default value: '${DEFAULT_DEST_DIR}'.
58+
Where you want to unpack Elixir. Default value: '${DEFAULT_DEST_DIR}'.
6059
6160
Options:
62-
--version Prints version
63-
--help Prints help menu
61+
--version Prints version
62+
--help Prints help menu
6463
6564
Usage Examples:
66-
\$ ${COMMAND} unpack source
67-
\$ ${COMMAND} unpack source 1.0.5
68-
\$ ${COMMAND} download precompiled 1.0.0-rc2
6965
70-
# Install the latest in a differt directory.
71-
\$ ${COMMAND} unpack source latest ./elixir-new
66+
${APP_COMMAND} unpack source
67+
${APP_COMMAND} unpack source 1.0.5
68+
${APP_COMMAND} download precompiled 1.0.0-rc2
69+
70+
# Install the latest in a differt directory
71+
${APP_COMMAND} unpack source latest ./elixir-new
7272
73-
# Get sources and compiled all in one
74-
\$ ${COMMAND} unpack precompiled && ${COMMAND} unpack source
73+
# Get sources and compiled all in one
74+
${APP_COMMAND} unpack precompiled && ${APP_COMMAND} unpack source
7575
76-
** For a list of available releases, plesase visit
76+
** For a list of available releases, plesase visit:
7777
${ELIXIR_RELEASES_URL}"
7878
}
7979

@@ -170,7 +170,7 @@ do_main() {
170170
fi
171171

172172
# Get Variables from ARGS
173-
ACTION="$1"
173+
COMMAND="$1"
174174
PACKAGE_TYPE="$2"
175175
if [ "$3" = "" ] || [ "$3" = "${DEFAULT_VERSION}" ]; then
176176
echo "* Retrieving version number of latest Elixir release..."
@@ -186,8 +186,8 @@ do_main() {
186186
fi
187187

188188
# Check for unrecognized options
189-
if [ "${ACTION}" != "unpack" ] && [ "${ACTION}" != "download" ]; then
190-
echo "* [ERROR] Unrecognized ACTION \"${ACTION}\". Try 'unpack' or 'download'." >&2
189+
if [ "${COMMAND}" != "unpack" ] && [ "${COMMAND}" != "download" ]; then
190+
echo "* [ERROR] Unrecognized ACTION \"${COMMAND}\". Try 'unpack' or 'download'." >&2
191191
exit 1
192192
fi
193193

@@ -201,7 +201,7 @@ do_main() {
201201
ELIXIR_TREE_URL="https://github.com/elixir-lang/elixir/tree/v${VERSION}"
202202

203203
# Do our logic
204-
case "${ACTION}" in
204+
case "${COMMAND}" in
205205
"download")
206206
case "${PACKAGE_TYPE}" in
207207
"source")

0 commit comments

Comments
 (0)