mirror of
https://github.com/Hilbis/Hilbish
synced 2025-04-20 20:43:23 +00:00
sammyette
99c77d1910
- add remove function - change _abbrevs to all for it to be known as publically available - change the signature of the add function (args not only a single table) - add documentation - make expand be either function or string
73 lines
2.5 KiB
Lua
73 lines
2.5 KiB
Lua
-- @module abbr
|
|
-- command line abbreviations
|
|
-- The abbr module manages Hilbish abbreviations. These are words that can be replaced
|
|
-- with longer command line strings when entered.
|
|
-- As an example, `git push` can be abbreviated to `gp`. When the user types
|
|
-- `gp` into the command line, after hitting space or enter, it will expand to `git push`.
|
|
-- Abbreviations can be used as an alternative to aliases. They are saved entirely in the history
|
|
-- Instead of the aliased form of the same command.
|
|
local bait = require 'bait'
|
|
local hilbish = require 'hilbish'
|
|
hilbish.abbr = {
|
|
all = {}
|
|
}
|
|
|
|
print 'abbr loaded'
|
|
|
|
--- Adds an abbreviation. The `abbr` is the abbreviation itself,
|
|
--- while `expanded` is what the abbreviation should expand to.
|
|
--- It can be either a function or a string. If it is a function, it will expand to what
|
|
--- the function returns.
|
|
--- `opts` is a table that accepts 1 key: `anywhere`.
|
|
--- `opts.anywhere` defines whether the abbr expands anywhere in the command line or not,
|
|
--- whereas the default behavior is only at the beginning of the line
|
|
-- @param abbr string
|
|
-- @param expanded|function string
|
|
-- @param opts table
|
|
function hilbish.abbr.add(abbr, expanded, opts)
|
|
print(abbr, expanded, opts)
|
|
opts = opts or {}
|
|
opts.abbr = abbr
|
|
opts.expand = expanded
|
|
hilbish.abbr.all[abbr] = opts
|
|
end
|
|
|
|
--- Removes the named `abbr`.
|
|
-- @param abbr string
|
|
function hilbish.abbr.remove(abbr)
|
|
hilbish.abbr.all[abbr] = nil
|
|
end
|
|
|
|
bait.catch('hilbish.rawInput', function(c)
|
|
-- 0x0d == enter
|
|
if c == ' ' or c == string.char(0x0d) then
|
|
-- check if the last "word" was a valid abbreviation
|
|
local line = hilbish.editor.getLine()
|
|
local lineSplits = string.split(line, ' ')
|
|
local thisAbbr = hilbish.abbr.all[lineSplits[#lineSplits]]
|
|
|
|
if thisAbbr and (#lineSplits == 1 or thisAbbr.anywhere == true) then
|
|
hilbish.editor.deleteByAmount(-lineSplits[#lineSplits]:len())
|
|
if type(thisAbbr.expand) == 'string' then
|
|
hilbish.editor.insert(thisAbbr.expand)
|
|
elseif type(thisAbbr.expand) == 'function' then
|
|
local expandRet = thisAbbr.expand()
|
|
if type(expandRet) ~= 'string' then
|
|
print(string.format('abbr %s has an expand function that did not return a string. instead it returned: %s', thisAbbr.abbr, expandRet))
|
|
end
|
|
hilbish.editor.insert(expandRet)
|
|
end
|
|
end
|
|
end
|
|
end)
|
|
|
|
hilbish.abbr.add('tt', 'echo titties')
|
|
|
|
hilbish.abbr.add('idk', 'i dont know', {
|
|
anywhere = true
|
|
})
|
|
|
|
hilbish.abbr.add('!!', function()
|
|
return hilbish.history.get(hilbish.history.size() - 1)
|
|
end)
|