mirror of
https://github.com/Hilbis/Hilbish
synced 2025-04-04 04:33:23 +00:00
sammyette
4150001d8b
* fix: make lua implemented hilbish interfaces documented * fix: signature link in table of contents * fix: reduce function list to match in go generated docs * fix: toc appending * docs: enable docs for hilbish.messages * feat: add description gen, and more spacing between param listing * docs: add more detailed documentation for lua modules * docs: update hilbish.messages docs * fix: add description for lua doc'd modules, remove duplicate docs * docs: add back hilbish.jobs doc * feat: generate toc for lua modules * fix: add table heading * ci: add lua docgen * docs: put dirs.old doc on 1 line
81 lines
2.0 KiB
Lua
81 lines
2.0 KiB
Lua
-- @module dirs
|
|
-- internal directory management
|
|
-- The dirs module defines a small set of functions to store and manage
|
|
-- directories.
|
|
local fs = require 'fs'
|
|
|
|
local dirs = {}
|
|
|
|
--- Last (current working) directory. Separate from recentDirs mainly for easier use.
|
|
dirs.old = ''
|
|
--- Table of recent directories. For use, look at public functions.
|
|
dirs.recentDirs = {}
|
|
--- Size of the recentDirs table.
|
|
dirs.recentSize = 10
|
|
|
|
--- Get (and remove) a `num` of entries from recent directories.
|
|
-- @param num number
|
|
-- @param remove boolean Whether to remove items
|
|
function dirRecents(num, remove)
|
|
num = num or 1
|
|
local entries = {}
|
|
|
|
if #dirs.recentDirs ~= 0 then
|
|
for i = 1, num do
|
|
local idx = remove and 1 or i
|
|
if not dirs.recentDirs[idx] then break end
|
|
table.insert(entries, dirs.recentDirs[idx])
|
|
if remove then table.remove(dirs.recentDirs, 1) end
|
|
end
|
|
end
|
|
|
|
if #entries == 1 then
|
|
return entries[1]
|
|
end
|
|
|
|
return entries
|
|
end
|
|
|
|
--- Look at `num` amount of recent directories, starting from the latest.
|
|
--- This returns a table of recent directories, up to the `num` amount.
|
|
-- @param num? number
|
|
function dirs.peak(num)
|
|
return dirRecents(num)
|
|
end
|
|
|
|
--- Add `dir` to the recent directories list.
|
|
--- @param dir string
|
|
function dirs.push(dir)
|
|
dirs.recentDirs[dirs.recentSize + 1] = nil
|
|
if dirs.recentDirs[#dirs.recentDirs - 1] ~= d then
|
|
ok, d = pcall(fs.abs, d)
|
|
assert(ok, 'could not turn "' .. d .. '"into an absolute path')
|
|
|
|
table.insert(dirs.recentDirs, 1, d)
|
|
end
|
|
end
|
|
|
|
--- Remove the specified amount of dirs from the recent directories list.
|
|
-- @param num number
|
|
function dirs.pop(num)
|
|
return dirRecents(num, true)
|
|
end
|
|
|
|
--- Get entry from recent directories list based on index.
|
|
-- @param idx number
|
|
function dirs.recent(idx)
|
|
return dirs.recentDirs[idx]
|
|
end
|
|
|
|
--- Sets the old directory string.
|
|
-- @param d string
|
|
function dirs.setOld(d)
|
|
ok, d = pcall(fs.abs, d)
|
|
assert(ok, 'could not turn "' .. d .. '"into an absolute path')
|
|
|
|
os.setenv('OLDPWD', d)
|
|
dirs.old = d
|
|
end
|
|
|
|
return dirs
|