├── .aka.example
├── .busted
├── .gitignore
├── .luacov
├── .travis.yml
├── .travis
├── platform.sh
├── setenv_lua.sh
└── setup_lua.sh
├── CHANGELOG.md
├── LICENSE
├── Makefile
├── README.md
├── aka-1.3.0-1.rockspec
├── aka.lua
├── aka
├── core.lua
├── init.lua
└── utils.lua
├── bin
└── aka
├── docs
└── resources
│ └── usage.gif
└── spec
├── core_spec.lua
└── utils_spec.lua
/.aka.example:
--------------------------------------------------------------------------------
1 | -- regular aliases
2 | pwd_alias = 'pwd'
3 | du_alias = 'du -h'
4 |
5 | -- nested aliases
6 | alias_group = {
7 | alias_subgroup = {
8 | list = 'ls -alh',
9 | }
10 | }
11 |
--------------------------------------------------------------------------------
/.busted:
--------------------------------------------------------------------------------
1 | return {
2 | _all = {
3 | lua = 'luajit',
4 | verbose = true,
5 | coverage = true
6 | }
7 | }
8 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # configuration file
2 | .aka
3 |
4 | # manual (luastatic) build files
5 | build/
6 |
7 | # luacov report file
8 | luacov.report.out
9 |
10 | # meta directory with project related files, e.g. reminders, todo's etc
11 | meta/
12 |
--------------------------------------------------------------------------------
/.luacov:
--------------------------------------------------------------------------------
1 | -- @class module
2 | -- @name luacov.defaults
3 | return {
4 | runreport = true,
5 | deletestats = true,
6 | ['include'] = {
7 | 'aka/init$',
8 | 'aka/core$',
9 | 'aka/utils$',
10 | },
11 | }
12 |
--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
1 | language: c
2 |
3 | sudo: false
4 |
5 | env:
6 | global:
7 | - LUAROCKS=2.3.0
8 | matrix:
9 | - LUA=luajit
10 | - LUA=luajit2.0
11 | - LUA=luajit2.1
12 |
13 | before_install:
14 | - source .travis/setenv_lua.sh
15 |
16 | install:
17 | - luarocks install busted
18 | - luarocks install luacov
19 | - luarocks install cluacov
20 |
21 | script:
22 | - busted --verbose
23 |
24 | after_success:
25 | - bash <(curl -s https://codecov.io/bash) -t 36624b2d-d94d-487f-a793-7ae95b2e521a
26 |
27 | branches:
28 | only:
29 | - master
30 |
31 | notifications:
32 | email:
33 | on_success: change
34 | on_failure: always
35 |
--------------------------------------------------------------------------------
/.travis/platform.sh:
--------------------------------------------------------------------------------
1 | if [ -z "${PLATFORM:-}" ]; then
2 | PLATFORM=$TRAVIS_OS_NAME;
3 | fi
4 |
5 | if [ "$PLATFORM" == "osx" ]; then
6 | PLATFORM="macosx";
7 | fi
8 |
9 | if [ -z "$PLATFORM" ]; then
10 | if [ "$(uname)" == "Linux" ]; then
11 | PLATFORM="linux";
12 | else
13 | PLATFORM="macosx";
14 | fi;
15 | fi
16 |
--------------------------------------------------------------------------------
/.travis/setenv_lua.sh:
--------------------------------------------------------------------------------
1 | export PATH=${PATH}:$HOME/.lua:$HOME/.local/bin:${TRAVIS_BUILD_DIR}/install/luarocks/bin
2 | bash .travis/setup_lua.sh
3 | eval `$HOME/.lua/luarocks path`
4 |
--------------------------------------------------------------------------------
/.travis/setup_lua.sh:
--------------------------------------------------------------------------------
1 | #! /bin/bash
2 |
3 | set -eufo pipefail
4 |
5 | LUAJIT_VERSION="2.0.4"
6 | LUAJIT_BASE="LuaJIT-$LUAJIT_VERSION"
7 |
8 | source .travis/platform.sh
9 |
10 | LUA_HOME_DIR=$TRAVIS_BUILD_DIR/install/lua
11 |
12 | LR_HOME_DIR=$TRAVIS_BUILD_DIR/install/luarocks
13 |
14 | mkdir $HOME/.lua
15 |
16 | LUAJIT="no"
17 |
18 | if [ "$PLATFORM" == "macosx" ]; then
19 | if [ "$LUA" == "luajit" ]; then
20 | LUAJIT="yes";
21 | fi
22 | if [ "$LUA" == "luajit2.0" ]; then
23 | LUAJIT="yes";
24 | fi
25 | if [ "$LUA" == "luajit2.1" ]; then
26 | LUAJIT="yes";
27 | fi;
28 | elif [ "$(expr substr $LUA 1 6)" == "luajit" ]; then
29 | LUAJIT="yes";
30 | fi
31 |
32 | mkdir -p "$LUA_HOME_DIR"
33 |
34 | if [ "$LUAJIT" == "yes" ]; then
35 |
36 | if [ "$LUA" == "luajit" ]; then
37 | curl --location https://github.com/LuaJIT/LuaJIT/archive/v$LUAJIT_VERSION.tar.gz | tar xz;
38 | else
39 | git clone https://github.com/LuaJIT/LuaJIT.git $LUAJIT_BASE;
40 | fi
41 |
42 | cd $LUAJIT_BASE
43 |
44 | if [ "$LUA" == "luajit2.1" ]; then
45 | git checkout v2.1;
46 | # force the INSTALL_TNAME to be luajit
47 | perl -i -pe 's/INSTALL_TNAME=.+/INSTALL_TNAME= luajit/' Makefile
48 | fi
49 |
50 | make && make install PREFIX="$LUA_HOME_DIR"
51 |
52 | ln -s $LUA_HOME_DIR/bin/luajit $HOME/.lua/luajit
53 | ln -s $LUA_HOME_DIR/bin/luajit $HOME/.lua/lua;
54 |
55 | else
56 |
57 | if [ "$LUA" == "lua5.1" ]; then
58 | curl http://www.lua.org/ftp/lua-5.1.5.tar.gz | tar xz
59 | cd lua-5.1.5;
60 | elif [ "$LUA" == "lua5.2" ]; then
61 | curl http://www.lua.org/ftp/lua-5.2.4.tar.gz | tar xz
62 | cd lua-5.2.4;
63 | elif [ "$LUA" == "lua5.3" ]; then
64 | curl http://www.lua.org/ftp/lua-5.3.2.tar.gz | tar xz
65 | cd lua-5.3.2;
66 | fi
67 |
68 | # Build Lua without backwards compatibility for testing
69 | perl -i -pe 's/-DLUA_COMPAT_(ALL|5_2)//' src/Makefile
70 | make $PLATFORM
71 | make INSTALL_TOP="$LUA_HOME_DIR" install;
72 |
73 | ln -s $LUA_HOME_DIR/bin/lua $HOME/.lua/lua
74 | ln -s $LUA_HOME_DIR/bin/luac $HOME/.lua/luac;
75 |
76 | fi
77 |
78 | cd $TRAVIS_BUILD_DIR
79 |
80 | lua -v
81 |
82 | LUAROCKS_BASE=luarocks-$LUAROCKS
83 |
84 | curl --location http://luarocks.org/releases/$LUAROCKS_BASE.tar.gz | tar xz
85 |
86 | cd $LUAROCKS_BASE
87 |
88 | if [ "$LUA" == "luajit" ]; then
89 | ./configure --lua-suffix=jit --with-lua-include="$LUA_HOME_DIR/include/luajit-2.0" --prefix="$LR_HOME_DIR";
90 | elif [ "$LUA" == "luajit2.0" ]; then
91 | ./configure --lua-suffix=jit --with-lua-include="$LUA_HOME_DIR/include/luajit-2.0" --prefix="$LR_HOME_DIR";
92 | elif [ "$LUA" == "luajit2.1" ]; then
93 | ./configure --lua-suffix=jit --with-lua-include="$LUA_HOME_DIR/include/luajit-2.1" --prefix="$LR_HOME_DIR";
94 | else
95 | ./configure --with-lua="$LUA_HOME_DIR" --prefix="$LR_HOME_DIR"
96 | fi
97 |
98 | make build && make install
99 |
100 | ln -s $LR_HOME_DIR/bin/luarocks $HOME/.lua/luarocks
101 |
102 | cd $TRAVIS_BUILD_DIR
103 |
104 | luarocks --version
105 |
106 | rm -rf $LUAROCKS_BASE
107 |
108 | if [ "$LUAJIT" == "yes" ]; then
109 | rm -rf $LUAJIT_BASE;
110 | elif [ "$LUA" == "lua5.1" ]; then
111 | rm -rf lua-5.1.5;
112 | elif [ "$LUA" == "lua5.2" ]; then
113 | rm -rf lua-5.2.4;
114 | elif [ "$LUA" == "lua5.3" ]; then
115 | rm -rf lua-5.3.2;
116 | fi
117 |
--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
1 | # Changelog
2 | All notable changes to this project will be documented in this file.
3 |
4 | The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
5 | and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
6 |
7 | ## [Unreleased]
8 | ### Added
9 | - Add ability to view the current aka version (`-v`, `--version`)
10 | - Generate help text dynamically (from table in `core.get_available_opts`)
11 |
12 | ## [1.3.0] - 2019-01-20
13 | ### Added
14 | - Alias arguments functionality
15 | - luacov support (with cluacov)
16 | - README: Codecov version badge, alias arguments functionality
17 |
18 | ### Changed
19 | - Switch to LuaJIT instead of pure Lua
20 | - Improve `path_join` helper function
21 |
22 | ## [1.2.0] - 2018-12-23
23 | ### Added
24 | - Recursive config file search functionality
25 | - README: nomenclature section, LuaRocks version badge, list functionality
26 |
27 | ### Changed
28 | - Switch to LuaJIT instead of pure Lua
29 | - Improve `path_join` helper function
30 |
31 | ## [1.1.0] - 2018-12-10
32 | ### Added
33 | - List all aliases functionality
34 | - `core` module tests
35 | - Travis-CI support
36 |
37 | ### Changed
38 | - README: asciicast, badges
39 |
40 | ## [1.0.0] - 2018-12-07
41 | ### Added
42 | - First usable version of the project
43 |
44 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------
/Makefile:
--------------------------------------------------------------------------------
1 | # aka - Per directory shell aliases
2 | #
3 | # Luastatic command line tool is a prerequisite for this build process
4 | # https://github.com/ers35/luastatic
5 |
6 | all: build
7 |
8 | .PHONY: build
9 | build:
10 | rm -rf build
11 | mkdir build
12 | luastatic \
13 | aka.lua \
14 | aka/init.lua \
15 | aka/core.lua \
16 | aka/utils.lua \
17 | /usr/local/lib/libluajit-5.1.a \
18 | -I/usr/local/include/luajit-2.0 \
19 | -no-pie \
20 | -o build/aka
21 | mv aka.lua.c build/
22 |
23 | install: build
24 | sudo cp build/aka /usr/local/bin
25 |
26 | uninstall:
27 | sudo rm /usr/local/bin/aka
28 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # aka
2 |
3 | **aka is a simple, single-file-executable command-line tool which lets you define per directory config files as aliases for shell commands.**
4 |
5 |
6 | [](https://luarocks.org/modules/bonidjukic/aka)
7 | [](https://travis-ci.com/bonidjukic/aka)
8 | [](https://codecov.io/gh/bonidjukic/aka/branch/master)
9 | [](https://www.gnu.org/licenses/gpl-3.0)
10 |
11 | ## Motivation
12 |
13 | Being an avid user of Linux' `alias` command, oftentimes I found myself frustrated with a couple of "more advanced" use-cases and wanted a really simple tool which would:
14 |
15 | - be able to use namespaced (nested) aliases;
16 | - be able to define configuration files in directories which would serve as per-directory-context aliases;
17 | - be able to list all aliases within the current directory's context;
18 | - use simple format for configuration files (as close as possible to `alias` syntax);
19 | - integrate nicely with version control (e.g. add configuration file to the VCS to be shared among team members).
20 |
21 | ## Features
22 |
23 | - define both [simple and nested aliases](#configuration-file)
24 | - list defined aliases (`aka -l` or `aka --list`)
25 | - recursively seek for `.aka` config file in parent directories
26 |
27 | ## Usage
28 |
29 |
30 |
31 | ---
32 |
33 | ### Overview
34 | Using `aka` is quite straightforward:
35 |
36 | - create an `.aka` text file in a directory where you'd like to be able to use `aka` aliases;
37 | - define your aliases;
38 | - run `aka [your_alias]` to execute your aliases;
39 | - run `aka -l` or `aka --list` to list all available aliases
40 |
41 | ### Configuration File
42 |
43 | Configuration files are actually [Lua](https://www.lua.org/) files which means we're using:
44 |
45 | - `lua` strings for regular / simple aliases;
46 | - `lua` tables for namespaced / nested aliases;
47 | - `--` for single line and `[[]]` for multiple line comments.
48 |
49 | Here is an example of a configuration file to get started with:
50 | ```lua
51 | -- regular aliases
52 | pwd_alias = 'pwd' -- usage: aka pwd_alias
53 | du_alias = 'du -h' -- usage: aka du_alias
54 |
55 | -- nested aliases
56 | alias_group = {
57 | alias_subgroup = {
58 | list = 'ls -alh' -- usage: aka alias_group alias_subgroup list
59 | }
60 | }
61 | ```
62 | A more practical example could be:
63 |
64 | ```lua
65 | -- example project's docker containers management commands
66 | docker = {
67 | bash = {
68 | django = 'docker exec -i -t $(docker ps -f name=django --format "{{.Names}}") /bin/bash',
69 | postgres = 'docker exec -i -t $(docker ps -f name=postgres --format "{{.Names}}") /bin/bash'
70 | },
71 | build = {
72 | django = 'docker-compose -f local.yml up --build django',
73 | postgres = 'docker-compose -f local.yml up --build postgres',
74 | all = 'docker-compose -f local.yml up --build'
75 | }
76 | }
77 | ```
78 |
79 | In the example above we'd be able to use namespaced aliases like this:
80 | - `aka docker bash django` or;
81 | - `aka docker bash postgres` or;
82 | - `aka docker build all`
83 | - etc.
84 |
85 | ### Command Line Interface
86 |
87 | ```
88 | aka - per directory shell aliases
89 |
90 | Usage:
91 | aka alias [sub_alias sub_sub_alias ...]
92 | aka -l|--list
93 | aka -h|--help
94 |
95 | Options:
96 | -l, --list List all aliases
97 | -h, --help Print usage
98 | ```
99 |
100 | ## Installation
101 |
102 | ### Use Pre-compiled Binary
103 |
104 | #### Overview
105 |
106 | The goal from the start was for this tool to be easily distributable across Linux machines (not having to have Lua on your system to be able to use `aka`).
107 |
108 | With this in mind and the fact that [Lua is small](https://www.lua.org/about.html), pre-compiled x86_64 linux binaries are available for download which contain the entire LuaJIT compiler and `aka` source code.
109 |
110 | #### Download
111 |
112 | https://github.com/bonidjukic/aka/releases/latest
113 |
114 | ### Using [LuaRocks](https://luarocks.org) To Install
115 |
116 | To install `aka` using `luarocks` package manager, run this command in your terminal:
117 |
118 | ```
119 | luarocks install aka
120 | ```
121 |
122 | If you don't have [LuaRocks](https://luarocks.org) installed, this [document](https://github.com/luarocks/luarocks/wiki/Download) can guide you through the process.
123 |
124 | ### Building From Source
125 |
126 | #### Prerequisites
127 | Building `aka` from source is possible, but at the moment, [luastatic](https://github.com/ers35/luastatic) command line tool is a prerequisite for the build process.
128 |
129 | `luastatic` is used to build a standalone executable from a Lua source code.
130 |
131 | #### Building
132 |
133 | To build `aka` run:
134 |
135 | `make` or `make build`
136 |
137 | #### Installing
138 |
139 | To install `aka` run:
140 |
141 | ```make install```
142 |
143 | #### Uninstalling
144 |
145 | To uninstall `aka` run:
146 |
147 | ```make uninstall```
148 |
149 | ## Testing
150 |
151 | ### Prerequisites
152 |
153 | [Busted](https://github.com/Olivine-Labs/busted) unit testing framework is required to run the tests.
154 |
155 | ### Running The Tests
156 |
157 | Navigate to `aka` project's root directory and run:
158 |
159 | ```
160 | busted
161 | ```
162 |
163 | ## Roadmap
164 |
165 | There are a couple of features I'm planning to add in the near future:
166 |
167 | - [✔] ~~ability to execute `aka` from children directories as well (currently it's only possible to execute `aka` from the same directory where the config file is located);~~
168 | - [✔] ~~ability to pass arguments to aliases (this is not possible ATM);~~
169 | - [...] ability to define `.aka.local` config file which could be used to override aliases from `.aka` config (useful when `.aka` is added to VCS and you'd like to have a different local version of a certain alias);
170 | - [...] ability to autocomplete `aka` aliases using bash completions.
171 |
172 | ## Nomenclature
173 |
174 | If it's not obvious, `aka` was named after the acronym of the *Also known as* adverb, i.e. *a.k.a* which is a synonym of *alias* and also has a nice side effect of being very short to type.
175 |
176 | ## Versioning
177 |
178 | [SemVer](http://semver.org/) is used for versioning. For the versions available, see the [tags on this repository](https://github.com/bonidjukic/aka/tags).
179 |
180 | ## Changelog
181 |
182 | The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) — please see the [CHANGELOG.md](CHANGELOG.md) for a detailed list of changes.
183 |
184 | ## License
185 |
186 | This project is licensed under the GNU General Public License v3.0 - see the [LICENSE.md](LICENSE.md) file for details.
187 |
--------------------------------------------------------------------------------
/aka-1.3.0-1.rockspec:
--------------------------------------------------------------------------------
1 | package = 'aka'
2 | version = '1.3.0-1'
3 | source = {
4 | url = 'https://github.com/bonidjukic/aka/archive/v1.3.0.tar.gz',
5 | dir = 'aka-1.3.0',
6 | }
7 | description = {
8 | summary = 'Per directory shell aliases',
9 | detailed = [[
10 | aka is a simple command-line tool which lets
11 | you define per directory config files as aliases
12 | for shell commands.
13 | ]],
14 | homepage = 'https://github.com/bonidjukic/aka',
15 | license = 'GPL-3.0'
16 | }
17 | build = {
18 | type = 'builtin',
19 | modules = {
20 | ['aka.core'] = 'aka/core.lua',
21 | ['aka.utils'] = 'aka/utils.lua',
22 | ['aka.init'] = 'aka/init.lua',
23 | },
24 | install = {
25 | bin = {
26 | aka = 'bin/aka'
27 | }
28 | }
29 | }
30 |
--------------------------------------------------------------------------------
/aka.lua:
--------------------------------------------------------------------------------
1 | return require 'aka.init'
2 |
--------------------------------------------------------------------------------
/aka/core.lua:
--------------------------------------------------------------------------------
1 | --[[
2 |
3 | aka - Per directory shell aliases
4 |
5 | ]]
6 |
7 | ---------------------------------------------------------------------
8 |
9 | local utils = require 'aka.utils'
10 |
11 | local io_write = io.write
12 | local str_fmt = string.format
13 | local str_rep = string.rep
14 | local table_concat = table.concat
15 | local table_insert = table.insert
16 |
17 | ---------------------------------------------------------------------
18 |
19 | local _M = {}
20 |
21 | ---------------------------------------------------------------------
22 |
23 | _M.CFG_FILE = '.aka'
24 |
25 | ---------------------------------------------------------------------
26 |
27 | -- Returns all available CLI options
28 | --
29 | function _M.get_available_opts()
30 | return { help = { flags = {'-h', '--help'},
31 | help_text = 'List all aliases'},
32 | list = { flags = {'-l', '--list'},
33 | help_text = 'Print usage'},
34 | version = { flags = {'-v', '--version'},
35 | help_text = 'Show version information'} }
36 | end
37 |
38 | -- Returns CLI option which matches one of the available options defined
39 | -- in `get_available_opts` function
40 | --
41 | function _M.get_opt(args)
42 | if #args == 1 then -- option can only be a single argument
43 | for opt_label, opt in pairs(_M.get_available_opts()) do
44 | for _, flag in pairs(opt['flags']) do
45 | if flag == args[1] then return opt_label end
46 | end
47 | end
48 | end
49 |
50 | return nil
51 | end
52 |
53 | -- Calls aka module function with the following name: `run_{opt_name}_opt`
54 | --
55 | function _M.run_opt(t)
56 | return _M['run_' .. t.opt .. '_opt'](t)
57 | end
58 |
59 | -- Prints help message
60 | --
61 | function _M.run_help_opt(t)
62 | print(_M.get_help_str())
63 | end
64 |
65 | -- Prints all available aliases found in the configuration file
66 | --
67 | function _M.run_list_opt(t)
68 | local opt = t.opt
69 | local cfg = t.config
70 | local n = 0
71 |
72 | print('Listing all aka aliases...\n')
73 | print(str_rep('-', 40))
74 |
75 | local list_recur = function(cfg, list_recur)
76 | local indent = function()
77 | for i = 1, n do
78 | io_write(' ')
79 | end
80 | end
81 |
82 | for k, v in pairs(cfg) do
83 | if type(v) == 'table' then
84 | indent()
85 | print('- [' .. k .. ']')
86 | n = n + 1
87 | list_recur(v, list_recur)
88 | else
89 | indent()
90 | print(str_fmt('- [%s = \'%s\']', tostring(k), tostring(v)))
91 | end
92 | end
93 | n = n - 1
94 | end
95 |
96 | for k, v in pairs(cfg) do
97 | if type(v) == 'table' then
98 | print('[' .. k .. ']')
99 | n = n + 1
100 | list_recur(v, list_recur)
101 | else
102 | print(str_fmt('[%s = \'%s\']', tostring(k), tostring(v)))
103 | end
104 | end
105 |
106 | print(str_rep('-', 40))
107 | print('')
108 | end
109 |
110 | -- Prints version information to the screen
111 | --
112 | function _M.run_version_opt(t)
113 | print(str_fmt('aka version: %s', utils.get_aka_version()))
114 | end
115 |
116 | -- Returns the alias specified by the command line argument if there is
117 | -- a match with the configuration file entries.
118 | --
119 | -- Returns nil if unable to find a matched alias.
120 | --
121 | function _M.get_cmd(cfg, args, idx)
122 | if not idx then idx = 1 end
123 | local val = cfg[args[idx]]
124 |
125 | if val then
126 | if type(val) == 'table' then
127 | -- continue searching deeper
128 | return _M.get_cmd(val, args, idx + 1)
129 | else
130 | -- we found the match, let's check for input arguments
131 | local input_args = {}
132 | for i = idx + 1, #args do -- skip the arguments used for alias match
133 | input_args[#input_args + 1] = ' ' .. args[i]
134 | end
135 | -- Return cmd and append input arguments if they exist
136 | return val .. table_concat(input_args)
137 | end
138 | end
139 |
140 | -- Verify that number of arguments match
141 | return (idx == #args) and val or nil
142 | end
143 |
144 | -- Prints error message to the screen
145 | --
146 | function _M.print_err(err)
147 | print(str_fmt('aka: %s\nSee \'aka -h\' or \'aka --help\'', err))
148 | end
149 |
150 | -- Returns the usage text using the definition table
151 | -- from the `get_available_opts` function
152 | --
153 | function _M.get_help_str()
154 | local t = {
155 | 'aka - per directory shell aliases\n\n',
156 | 'Usage:\n',
157 | ' aka alias [sub_alias sub_sub_alias ...]\n\n'
158 | }
159 |
160 | for opt_label, opt in pairs(_M.get_available_opts()) do
161 | local flags = table_concat(opt['flags'], '|')
162 | table_insert(t, str_fmt(' aka %s\n', flags))
163 | end
164 |
165 | table_insert(t, '\nOptions:')
166 |
167 | for opt_label, opt in pairs(_M.get_available_opts()) do
168 | local flags = table_concat(opt['flags'], ', ')
169 | table_insert(t, str_fmt('\n aka %s\t%s', flags, opt['help_text']))
170 | end
171 |
172 | return table_concat(t)
173 | end
174 |
175 | ---------------------------------------------------------------------
176 |
177 | return _M
178 |
--------------------------------------------------------------------------------
/aka/init.lua:
--------------------------------------------------------------------------------
1 | --[[
2 |
3 | aka - Per directory shell aliases
4 |
5 | ]]
6 |
7 | ---------------------------------------------------------------------
8 |
9 | local aka = require 'aka.core'
10 | local utils = require 'aka.utils'
11 |
12 | ---------------------------------------------------------------------
13 |
14 | local args = arg
15 | local os_execute = os.execute
16 |
17 | ---------------------------------------------------------------------
18 |
19 | -- Attempt to retrieve a CLI argument option
20 | local opt = aka.get_opt(args)
21 |
22 | -- If we have a single argument, or a `help` option -> print help message
23 | if #args == 0 or (opt and opt == 'help') then aka.run_help_opt() return end
24 |
25 | -- Load configuration
26 |
27 | local cfg, err = utils.load_cfg(aka.CFG_FILE)
28 | if err then aka.print_err(err) return end
29 |
30 | -- Run option runner function if we have an argument option
31 | if opt then aka.run_opt { opt = opt, config = cfg} return end
32 |
33 | -- Run alias command if it exists
34 | local cmd = aka.get_cmd(cfg, args)
35 | if cmd then os_execute(cmd)
36 | else aka.print_err('alias not found within the .aka config file') end
37 |
--------------------------------------------------------------------------------
/aka/utils.lua:
--------------------------------------------------------------------------------
1 | --[[
2 |
3 | aka - Per directory shell aliases
4 |
5 | ]]
6 |
7 | ---------------------------------------------------------------------
8 |
9 | local ffi = require 'ffi'
10 |
11 | ffi.cdef [[
12 | int chdir(const char*);
13 | char *getcwd(char *buf, size_t size);
14 | ]]
15 |
16 | local const = {
17 | MAX_PATH = 4096 -- UNIX
18 | }
19 |
20 | ---------------------------------------------------------------------
21 |
22 | local io = io
23 | local io_open = io.open
24 | local io_popen = io.popen
25 | local io_close = io.close
26 | local str_gsub = string.gsub
27 | local table_concat = table.concat
28 |
29 | ---------------------------------------------------------------------
30 |
31 | local _M = {}
32 |
33 | ---------------------------------------------------------------------
34 |
35 | -- Checks if file exists on a given location
36 | --
37 | function _M.file_exists(path)
38 | local f = io_open(path, 'r')
39 | if f ~= nil then io_close(f) return true
40 | else return false end
41 | end
42 |
43 | -- Changes the current workdig directory to the specified directory
44 | --
45 | function _M.chdir(dir)
46 | return ffi.C.chdir(dir)
47 | end
48 |
49 | -- Returns the current working directory
50 | --
51 | function _M.getcwd()
52 | local buf = ffi.new('char[?]', const.MAX_PATH)
53 | ffi.C.getcwd(buf, const.MAX_PATH)
54 | return ffi.string(buf)
55 | end
56 |
57 | -- Returns path joined with a slash character, e.g. foo/bar/baz
58 | --
59 | function _M.path_join(...)
60 | return table_concat({...}, '/')
61 | end
62 |
63 | -- Attempts to load the configuration file by recursively seeking for it
64 | -- starting with the current directory and moving up until reaching root dir
65 | --
66 | function _M.load_cfg(cfg_file)
67 | -- Define root directory
68 | local ROOT_DIR = '/'
69 |
70 | -- Recursive seek config function
71 | local function seek_cfg(dir)
72 | -- If not dir then set dir to the current working directory
73 | if not dir then dir = _M.getcwd() end
74 | -- Check if we should stop seeking for the config
75 | if dir == ROOT_DIR then return nil end
76 |
77 | -- If the config file exist this particular location, return its path
78 | if _M.file_exists(cfg_file) then
79 | return _M.path_join(_M.getcwd(), cfg_file)
80 | else
81 | -- Go up one directory and call `seek_cfg` to continue seeking
82 | _M.chdir('..')
83 | return seek_cfg()
84 | end
85 | end
86 |
87 | local cfg = {}
88 | local path = seek_cfg()
89 |
90 | -- Check if we reached `ROOT_DIR` before finding the config
91 | if not path then
92 | return nil, 'config file not found'
93 | end
94 |
95 | -- Load the config chunk and execute it
96 | local chunk, err = loadfile(path, 't', cfg)
97 | if not err then chunk() end
98 |
99 | return cfg, err
100 | end
101 |
102 | -- Executes the command and returns its captured output
103 | -- Thanks to: https://stackoverflow.com/a/326715/6817428
104 | --
105 | function _M.os_capture_exec(cmd)
106 | local f = assert(io_popen(cmd, 'r'))
107 | local s = assert(f:read('*a'))
108 |
109 | f:close()
110 |
111 | s = str_gsub(s, '^%s+', '')
112 | s = str_gsub(s, '%s+$', '')
113 | s = str_gsub(s, '[\n\r]+', ' ')
114 |
115 | return s
116 | end
117 |
118 | -- Returns the full filename of the current rockspec file
119 | --
120 | function _M.get_rockspec_filename()
121 | return _M.os_capture_exec('find *.rockspec')
122 | end
123 |
124 |
125 | -- Returns the aka version from the current rockspec file
126 | --
127 | function _M.get_aka_version()
128 | local rockspec = {}
129 | local chunk, err = loadfile(_M.get_rockspec_filename(), 't', rockspec)
130 |
131 | if not err then
132 | chunk()
133 | return rockspec['version']
134 | end
135 | end
136 |
137 | ---------------------------------------------------------------------
138 |
139 | return _M
140 |
--------------------------------------------------------------------------------
/bin/aka:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env lua
2 | -- aka command-line executable
3 | require 'aka.init'
4 |
--------------------------------------------------------------------------------
/docs/resources/usage.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/bonidjukic/aka/b7eeb8d90855cfa7e965f26326a8b878e3bb8ab5/docs/resources/usage.gif
--------------------------------------------------------------------------------
/spec/core_spec.lua:
--------------------------------------------------------------------------------
1 | --[[
2 |
3 | tests core related functions from the aka library
4 |
5 | ]]
6 |
7 | ---------------------------------------------------------------------
8 |
9 | require 'busted.runner'()
10 |
11 | local core = require 'aka.core'
12 |
13 | ---------------------------------------------------------------------
14 |
15 | -- get_available_opts
16 | --
17 | describe('tests get_available_opts', function()
18 | local opts = core.get_available_opts()
19 |
20 | it('tests help and list', function()
21 | assert.is_true(type(opts) == 'table')
22 |
23 | assert.is_true(type(opts['help']['flags']) == 'table')
24 | assert.are.equal(opts['help']['flags'][1], '-h')
25 | assert.are.equal(opts['help']['flags'][2], '--help')
26 |
27 | assert.is_true(type(opts['list']['flags']) == 'table')
28 | assert.are.equal(opts['list']['flags'][1], '-l')
29 | assert.are.equal(opts['list']['flags'][2], '--list')
30 | end)
31 | end)
32 |
33 | -- get_opt
34 | --
35 | describe('tests get_opt', function()
36 | it('get opt', function()
37 | assert.are.equal(core.get_opt({'foo', 'bar'}), nil)
38 | assert.are.equal(core.get_opt({'-h', 'foo'}), nil)
39 | assert.are.equal(core.get_opt({'--help', 'foo', 'bar'}), nil)
40 | assert.are.equal(core.get_opt({'foo', '-l', 'bar'}), nil)
41 | assert.are.equal(core.get_opt({'foo', 'bar', '--list'}), nil)
42 |
43 | assert.are.equal(core.get_opt({'-h'}), 'help')
44 | assert.are.equal(core.get_opt({'--help'}), 'help')
45 | assert.are.equal(core.get_opt({'-l'}), 'list')
46 | assert.are.equal(core.get_opt({'--list'}), 'list')
47 | end)
48 | end)
49 |
50 | -- get_cmd
51 | --
52 | describe('tests get_cmd', function()
53 | local special_chars = '¤¶§!"#$%&\'()*+,-./0123456789:;<=>?@[\\]^_`{Çüé⹸' ..
54 | 'äàåçêëèïîìæÆôöòûùÿ¢£¥PƒáíCóúñѺµ¿¬½¼¡«»¦ßµ±°•·²€„…' ..
55 | '†‡ˆ‰Š‹Œ‘’“”–—˜™š›œŸ¨C©®¯³´¸¹¾ÀÁÂÃÄÅÈÉÊËÌÍÎÏÐÒÓÔÕÖ×' ..
56 | 'ØÙÚÛÜÝÞãðõ÷øüý£¥€6§¨©ª«¬®¯°7²³´¶'
57 |
58 | local cfg = {
59 | alias_1 = 'alias_1',
60 | alias_2 = {
61 | alias_3 = 'alias_3',
62 | alias_4 = {
63 | alias_5 = 'alias_5'
64 | }
65 | },
66 | alias_6 = special_chars
67 | }
68 |
69 | it('test get_cmd', function()
70 | assert.are.equal(
71 | core.get_cmd(cfg, {'alias_1'}), 'alias_1')
72 | assert.are.equal(
73 | core.get_cmd(cfg, {'alias_2', 'alias_3'}), 'alias_3')
74 | assert.are.equal(
75 | core.get_cmd(cfg, {'alias_2', 'alias_4', 'alias_5'}), 'alias_5')
76 | assert.are.equal(
77 | core.get_cmd(cfg, {'alias_6'}), special_chars)
78 | assert.are.equal(
79 | core.get_cmd(cfg, {'alias_1', 'arg_1'}), 'alias_1 arg_1')
80 | assert.are.equal(
81 | core.get_cmd(cfg, {'alias_1', 'arg_1', 'arg_2'}), 'alias_1 arg_1 arg_2')
82 | assert.are.equal(
83 | core.get_cmd(cfg, {'alias_2', 'alias_3', 'arg_1'}), 'alias_3 arg_1')
84 | assert.are.equal(
85 | core.get_cmd(cfg, {'alias_2', 'arg_1', }), nil)
86 | assert.are.equal(
87 | core.get_cmd(cfg, {'alias_2', 'alias_4', 'arg_1', 'arg_2' }), nil)
88 | assert.are.equal(
89 | core.get_cmd(
90 | cfg, {'alias_2', 'alias_4', 'alias_5', 'arg_1' }
91 | ), 'alias_5 arg_1')
92 | assert.are.equal(
93 | core.get_cmd(
94 | cfg, {'alias_2', 'alias_4', 'alias_5', 'arg_1', 'arg_2' }
95 | ), 'alias_5 arg_1 arg_2')
96 | end)
97 | end)
98 |
99 | -- get_help_str
100 | --
101 | describe('tests get_help_str', function()
102 | local s = core.get_help_str()
103 | local str_match = string.match
104 |
105 | it('tests generation of the help str', function()
106 | assert.is_true(type(s) == 'string')
107 | assert.is_not_nil(str_match(s, 'aka...per directory shell aliases'))
108 | assert.is_not_nil(str_match(s, 'Usage'))
109 | assert.is_not_nil(str_match(s, 'Options'))
110 | assert.is_not_nil(str_match(s, 'aka alias..sub_alias sub_sub_alias ...]'))
111 | assert.is_not_nil(str_match(s, '-h.--help'))
112 | assert.is_not_nil(str_match(s, '-l.--list'))
113 | assert.is_not_nil(str_match(s, '-v.--version'))
114 | end)
115 | end)
116 |
--------------------------------------------------------------------------------
/spec/utils_spec.lua:
--------------------------------------------------------------------------------
1 | --[[
2 |
3 | tests utils related functions from the aka library
4 |
5 | ]]
6 |
7 | ---------------------------------------------------------------------
8 |
9 | require 'busted.runner'()
10 |
11 | local utils = require 'aka.utils'
12 |
13 | ---------------------------------------------------------------------
14 |
15 | -- file_exists
16 | --
17 | describe('tests file_exists', function()
18 | local tmpf = '/tmp/aka_test_file'
19 |
20 | setup(function()
21 | f = io.open(tmpf, 'w')
22 | f:write('Test file')
23 | f:close()
24 | end)
25 |
26 | teardown(function()
27 | os.remove(tmpf)
28 | end)
29 |
30 | it('tmp file exists', function()
31 | assert.is_true(utils.file_exists(tmpf))
32 | end)
33 | end)
34 |
35 | -- chdir
36 | --
37 | describe('tests chdir', function()
38 | local cwd
39 |
40 | setup(function()
41 | cwd = utils.getcwd()
42 | end)
43 |
44 | teardown(function()
45 | utils.chdir(cwd)
46 | end)
47 |
48 | it('tests temporary directory', function()
49 | utils.chdir('/tmp')
50 | utils.chdir('..')
51 | assert.are.equal(utils.getcwd(), '/')
52 | utils.chdir('tmp')
53 | assert.are.equal(utils.getcwd(), '/tmp')
54 | end)
55 | end)
56 |
57 | -- getcwd
58 | --
59 | describe('tests getcwd', function()
60 | it('get current dir', function()
61 | assert.are.equal(utils.getcwd(), io.popen 'pwd':read '*l')
62 | end)
63 | end)
64 |
65 | -- path_join
66 | --
67 | describe('tests path_join', function()
68 | it('zero args', function()
69 | assert.are.equal(utils.path_join(), '')
70 | end)
71 | it('one arg', function()
72 | assert.are.equal(utils.path_join('/tmp'), '/tmp')
73 | end)
74 | it('three args', function()
75 | assert.are.equal(utils.path_join('foo', 'bar', 'baz'), 'foo/bar/baz')
76 | end)
77 | it('six args', function()
78 | assert.are.equal(utils.path_join('a', '1', 'b', '2', 'c', '3'),
79 | 'a/1/b/2/c/3')
80 | end)
81 | end)
82 |
83 | -- load_cfg
84 | --
85 | describe('tests load_cfg', function()
86 | local cwd = utils.getcwd()
87 | local tmpf = 'aka_test_file'
88 | local tmpf_path = utils.path_join('/tmp', tmpf)
89 |
90 | local cfg = {
91 | alias_1 = 'alias_1',
92 | alias_2 = {
93 | alias_3 = 'alias_3'
94 | }
95 | }
96 |
97 | setup(function()
98 | utils.chdir('/tmp')
99 | f = io.open(tmpf_path, 'w')
100 | f:write('alias_1 = "alias_1" alias_2 = { alias_3 = "alias_3" }')
101 | f:close()
102 | end)
103 |
104 | teardown(function()
105 | os.remove(tmpf_path)
106 | utils.chdir(cwd)
107 | end)
108 |
109 | it('test config file', function()
110 | local cfgf, err = utils.load_cfg(tmpf)
111 |
112 | assert.is.truthy(cfgf)
113 | assert.is_nil(err)
114 | assert.are.same(cfg, cfgf)
115 | assert.are.equal(cfg.alias_1, cfgf.alias_1)
116 | assert.are.same(cfg.alias_2, cfgf.alias_2)
117 | assert.are.equal(cfg.alias_3, cfgf.alias_3)
118 | end)
119 | end)
120 |
121 | -- load_cfg recursive
122 | --
123 | describe('tests load_cfg recursive', function()
124 | local cwd = utils.getcwd()
125 | local tmpf = 'aka_test_file'
126 | local tmpf_root_dir = '/tmp/aka_test'
127 | local tmpf_dir = utils.path_join(tmpf_root_dir, 'a/b/c/d/e/f')
128 | local tmpf_path = utils.path_join(tmpf_dir, tmpf)
129 |
130 | local cfg = {
131 | alias_1 = 'alias_1',
132 | alias_2 = {
133 | alias_3 = 'alias_3'
134 | }
135 | }
136 |
137 | setup(function()
138 | utils.os_capture_exec('mkdir -p ' .. tmpf_dir)
139 | utils.chdir(tmpf_dir)
140 |
141 | f = io.open(tmpf_path, 'w')
142 | f:write('alias_1 = "alias_1" alias_2 = { alias_3 = "alias_3" }')
143 | f:close()
144 | end)
145 |
146 | teardown(function()
147 | utils.os_capture_exec('rm -r ' .. tmpf_root_dir)
148 | utils.chdir(cwd)
149 | end)
150 |
151 | it('test config file', function()
152 | local cfgf, err = utils.load_cfg(tmpf)
153 |
154 | assert.is.truthy(cfgf)
155 | assert.is_nil(err)
156 | assert.are.same(cfg, cfgf)
157 | assert.are.equal(cfg.alias_1, cfgf.alias_1)
158 | assert.are.same(cfg.alias_2, cfgf.alias_2)
159 | assert.are.equal(cfg.alias_3, cfgf.alias_3)
160 | end)
161 | end)
162 |
163 | -- load_cfg recursive - no results
164 | --
165 | describe('tests load_cfg recursive - no results', function()
166 | local cwd = utils.getcwd()
167 | local tmpf = 'aka_test_fileys'
168 |
169 | teardown(function()
170 | utils.chdir(cwd)
171 | end)
172 |
173 | it('test config file', function()
174 | local cfgf, err = utils.load_cfg(tmpf)
175 | assert.is_nil(cfgf)
176 | assert.is.truthy(err)
177 | end)
178 | end)
179 |
180 | -- get_rockspec_filename
181 | --
182 | describe('tests get_rockspec_filename', function()
183 | it('test getting current rockspec filename', function()
184 | local filename = utils.get_rockspec_filename()
185 |
186 | assert.is.truthy(filename)
187 | start_idx, end_idx = string.find(filename, 'aka')
188 | assert.equal(start_idx, 1)
189 | assert.equal(end_idx, 3)
190 |
191 | capture = '(%a+)-(%d).(%d).(%d)-(%d).(%a+)'
192 | aka, maj, min, patch, spec, rockspec = string.match(filename, capture)
193 | assert.equal(aka, 'aka')
194 | assert.equal(rockspec, 'rockspec')
195 | end)
196 | end)
197 |
198 | -- get_aka_version
199 | --
200 | describe('tests get_aka_version', function()
201 | it('test getting current aka version from the rockspec file', function()
202 | local version = utils.get_aka_version()
203 |
204 | assert.is.truthy(version)
205 |
206 | capture = '(%d).(%d).(%d)-(%d)'
207 | maj, min, patch, spec = string.match(version, capture)
208 | assert.equal(type(tonumber(maj)), 'number')
209 | assert.equal(type(tonumber(min)), 'number')
210 | assert.equal(type(tonumber(patch)), 'number')
211 |
212 | rockspec_filename = utils.os_capture_exec('find *.rockspec')
213 | local rockspec = {}
214 | local chunk, err = loadfile(rockspec_filename, 't', rockspec)
215 | chunk()
216 | assert.equal(rockspec['version'], version)
217 | end)
218 | end)
219 |
--------------------------------------------------------------------------------