eashy 0.3.1

No more hassle writing shell functions! Easy subcommands and help documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101

/*
    This file is an example of eashy file:
    a command line tool for managing shell commands.
*/

/*
This is a simple example of a command line tool that manages Python virtual environments.
It includes commands to create, activate, deactivate, and delete a virtual environment.
Commands and arguments are prefixed with a description for help section.
*/
("Python venv management") \
venv {
    ("Create a new virtual environment")\
    init {
        python -m venv ".venv"
        source ".venv/bin/activate"
        echo "Activated virtual environment, version: $(python --version)"
    }

    ("Activate the virtual environment")\
    activate {
        source ".venv/bin/activate" && \
        echo "Activated virtual environment, version: $(python --version)" || \
        echo "Failed to activate virtual environment. Make sure .venv exists."
    }

    ("Deactivate the virtual environment")\
    deactivate {
        deactivate && echo "Deactivated virtual environment"
    }
    ("Delete the virtual environment") \
    delete {
        deactivate
        rm -rf ".venv" && \
        echo "Removed virtual environment"
    }
}
/*
This is an example showing how to use various argument types.
Try running `args --help`!
*/
("Test various argument types") \
args {
    ("Exactly two arguments needed") \
    two ("First mandatory arg")arg1 ("Second mandatory arg")arg2 {
        echo "Arg1: [$arg1]"
        echo "Arg2: [$arg2]"

    }
    ("At least 1 args, the last is always arg2") \
    complex1 ("Zero or more")*arg1 ("Required flag")arg2{
        echo "Arg1: [$arg1]"
        echo "Arg2: [$arg2]"
    }

    ("At least 1 args, the first is always arg1, unless if it's the only one") \
    complex2 ("zero or one")?arg1 ("one or more")+arg2  {
        echo "Arg1: [$arg1]"
        echo "Arg2: [$arg2]"
    }

    ("Optional flags, can be in any order")\
    val_flags str_flag=("Long name flag")"" n=("Short name flag")42 empty_flag=("Default is empty")#null {
        echo #"" --str_flag: [$str_flag] default is \"\"""#
        echo #"" --n: [$n] default is 42""#
        echo #"" --empty_flag: [$empty_flag], default is \"\"""#
        if "[" "$n" -lt 42 "]"; then
            echo " -n flag is smaller than 42 (n == $n)"
        elif "[" "$n" -gt 42 "]"; then
            echo " -n flag is greater than 42 (n == $n)"
        elif "[" "$n" -eq 42 "]"; then
            echo " -n flag is equal to 42"
        fi
    }

    ("Boolean optional flags") \
    bool_flags a=("Set to make it true")#false b=("Set to make it false")#true {
        if "$a"; then
            echo " -a present (a == true)"
        else
            echo " -a absent (a == false)"
        fi
        if "$b"; then
            echo " -b is absent (b == true)"
        else
            echo " -b present (b == false)"
        fi
    }
}

&stop_on_error {
    echo "This command has a & prefix"
    "false"
    echo "This command will not run as the previous command fails"
}

|stop_on_success {
    "false"
    echo "This command has a | prefix"
    echo "This command will not run as the previous command succeeds"
}