mirror of
https://github.com/Hilbis/Hilbish
synced 2025-07-01 08:42:04 +00:00
61 lines
14 KiB
HTML
61 lines
14 KiB
HTML
<!doctype html>
|
|
<html class="bg-stone-50 dark:bg-neutral-900 text-black dark:text-white"><head><meta content="width=device-width, initial-scale=1.0" name="viewport"><link href="https://rosettea.github.io/Hilbish/versions/new-website/tailwind.css" rel="stylesheet"><title>Hilbish</title><meta content="#ff89dd" name="theme-color"><meta content="https://rosettea.github.io/Hilbish/versions/new-website/hilbish-flower.png" property="og:image"><meta content="Hilbish" property="og:title"><meta content="Hilbish" property="og:site_name"><meta content="website" property="og:type"><meta content="Something Unique. Hilbish is the new interactive shell for Lua fans. Extensible, scriptable, configurable: All in Lua." property="og:description"><meta content="Something Unique. Hilbish is the new interactive shell for Lua fans. Extensible, scriptable, configurable: All in Lua." name="description"><meta content="Lua,Shell,Hilbish,Linux,zsh,bash" name="keywords"><meta content="https://rosettea.github.io/Hilbish/versions/new-website" property="og:url"><meta name="darkreader-lock"></head><body class="h-screen flex flex-col"><nav class="bg-stone-100/80 dark:bg-neutral-950/80 flex justify-around sticky items-center top-0 w-full z-50 border-b border-b-zinc-300 backdrop-blur-md h-12"><div class="flex my-auto px-2"><div><a class="flex items-center gap-1" href="https://rosettea.github.io/Hilbish/versions/new-website/"><img class="h-8" src="https://rosettea.github.io/Hilbish/versions/new-website/hilbish-flower.png"><span class="self-center text-3xl font-medium">Hilbish</span></a></div></div><div class="flex gap-3"><a href="https://rosettea.github.io/Hilbish/versions/new-website/install"><span class="inline-flex text-light dark:text-pink-300 dark:hover:text-pink-200 text-pink-600 hover:text-pink-500 hover:underline">Install</span></a><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs"><span class="inline-flex text-light dark:text-pink-300 dark:hover:text-pink-200 text-pink-600 hover:text-pink-500 hover:underline">Docs</span></a><a href="https://rosettea.github.io/Hilbish/versions/new-website/blog"><span class="inline-flex text-light dark:text-pink-300 dark:hover:text-pink-200 text-pink-600 hover:text-pink-500 hover:underline">Blog</span></a></div></nav><div class="flex-1 flex flex-col overflow-hidden"><div class="sm:hidden h-10 flex py-2 px-4 border-b border-b-zinc-300 w-full gap-2 backdrop-blur-sm bg-zinc-300/50 dark:bg-zinc-800/50"><label class="cursor-pointer" for="sidebar-toggle"><tag><svg xmlns="http://www.w3.org/2000/svg" height="24px" viewBox="0 -960 960 960" width="24px" class="fill-white"><path d="M120-240v-80h240v80H120Zm0-200v-80h480v80H120Zm0-200v-80h720v80H120Z"/></svg></tag></label><span class="font-bold">Completions</span></div><div class="flex-1 sm:flex grid overflow-hidden"><input class="peer hidden" id="sidebar-toggle" type="checkbox"><div class="overflow-y-scroll p-4 sm:border-r sm:border-r-zinc-300 col-start-1 row-start-1 bg-neutral-100 dark:bg-neutral-950 basis-2/10 transition-transform duration-300 -translate-x-full peer-checked:translate-x-0 sm:translate-x-0 z-30"><ul class="text-lg flex flex-col gap-2"><li class="font-bold"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs">Introduction</a></li><li class="font-bold"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/getting-started">Getting Started</a></li><li class="font-bold"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/faq">Frequently Asked Questions</a></li><li class="font-bold"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/features">Features</a></li><ul class="pl-4"><li class="mb-2 text-pink-400"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/completions"> -> Completions</a></li><li class="mb-2"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/features/notifications">Notification</a></li><li class="mb-2"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/features/opts">Options</a></li><li class="mb-2"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/features/runner-mode">Runner Mode</a></li></ul><li class="font-bold"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/hooks">Signals</a></li><ul class="pl-4"><li class="mb-2"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/hooks/command">Command</a></li><li class="mb-2"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/hooks/hilbish">Hilbish</a></li><li class="mb-2"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/hooks/signal">Signal</a></li></ul><li class="font-bold"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/lunacolors">Lunacolors</a></li><li class="font-bold"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/api">API</a></li><ul class="pl-4"><li class="mb-2"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/api/bait">Module bait</a></li><li class="mb-2"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/api/commander">Module commander</a></li><li class="mb-2"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/api/fs">Module fs</a></li><li class="mb-2"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/api/hilbish">Module hilbish</a></li><li class="mb-2"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/api/readline">Module readline</a></li><li class="mb-2"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/api/snail">Module snail</a></li><li class="mb-2"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/api/terminal">Module terminal</a></li><li class="mb-2"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/api/yarn">Module yarn</a></li></ul><li class="font-bold"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/nature">Nature</a></li><ul class="pl-4"><li class="mb-2"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/nature/dirs">Module dirs</a></li><li class="mb-2"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/nature/doc">Module doc</a></li></ul><li class="font-bold"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/vim-mode">Vim Mode</a></li><ul class="pl-4"><li class="mb-2"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/vim-mode/actions">Actions</a></li></ul></ul></div><main class="flex-1 flex justify-center basis-7/7 col-start-1 row-start-1 transition-all duration-300 peer-checked:filter peer-checked:blur-sm peer-checked:bg-black/30"><div class="flex-1 flex flex-col overflow-y-auto"><div class="flex-1 w-3/4 self-center p-8"><h1 class="my-3 font-bold text-4xl">Completions</h1><i>Tab completion for commands.</i><p>Completions for commands can be created with the <a href="../api/hilbish#complete"><code class="text-violet-600 dark:text-violet-400">hilbish.complete</code></a>
|
|
function. See the link for how to use it.</p><p>To create completions for a command is simple.
|
|
The callback will be passed 3 parameters:</p><ul style="list-style-type:'-';"><li><p><code class="text-violet-600 dark:text-violet-400">query</code> (string): The text that the user is currently trying to complete. This should be used to match entries.</p></li><li><p><code class="text-violet-600 dark:text-violet-400">ctx</code> (string): Contains the entire line. Use this if more text is needed to be parsed for context.</p></li><li><p><code class="text-violet-600 dark:text-violet-400">fields</code> (string): The <code class="text-violet-600 dark:text-violet-400">ctx</code> split up by spaces.</p></li></ul><p><br>In most cases, the completer just uses <code class="text-violet-600 dark:text-violet-400">fields</code> to check the amount
|
|
and <code class="text-violet-600 dark:text-violet-400">query</code> on what to match entries on.<br> <br>In order to return your results, it has to go within a "completion group."
|
|
Then you return a table of completion groups and a prefix. The prefix will
|
|
usually just be the <code class="text-violet-600 dark:text-violet-400">query</code>.<br> <br>Hilbish allows one to mix completion menus of different types, so
|
|
a grid menu and a list menu can be used and complete and display at the same time.
|
|
A completion group is a table with these keys:</p><ul style="list-style-type:'-';"><li><p><code class="text-violet-600 dark:text-violet-400">type</code> (string): type of completion menu, either <code class="text-violet-600 dark:text-violet-400">grid</code> or <code class="text-violet-600 dark:text-violet-400">list</code>.</p></li><li><p><code class="text-violet-600 dark:text-violet-400">items</code> (table): a list of items. </p></li></ul><p><br>
|
|
The requirements of the <code class="text-violet-600 dark:text-violet-400">items</code> table is different based on the
|
|
<code class="text-violet-600 dark:text-violet-400">type</code>. If it is a <code class="text-violet-600 dark:text-violet-400">grid</code>, it can simply be a table of strings.<br>Otherwise if it is a <code class="text-violet-600 dark:text-violet-400">list</code> then each entry can
|
|
either be a string or a table.<br> <br>Example:</p><pre><code data-lang="lua">local cg = {
|
|
items = {
|
|
'list item 1',
|
|
['--command-flag-here'] = {'this does a thing', '--the-flag-alias'}
|
|
},
|
|
type = 'list'
|
|
}
|
|
local cg2 = {
|
|
items = {'just', 'a bunch', 'of items', 'here', 'hehe'},
|
|
type = 'grid'
|
|
}
|
|
|
|
return {cg, cg2}, prefix
|
|
</code></pre><p>Which looks like this:
|
|
{{< video src="https://safe.saya.moe/t4CiLK6dgPbD.mp4" >}}</p><h1 class="my-4 text-neutral-800 dark:text-neutral-300 font-bold text-4xl" id="Completion-Group-Types">Completion Group Types</h1><h3 class="my-1 text-neutral-800 dark:text-neutral-300 font-bold text-2xl" id="grid">grid</h3><p>Grid is the simplest completion group type. All items are strings and when
|
|
completion is done is displayed in a grid based on size.<br> <br>Example:</p><pre><code data-lang="lua">{
|
|
items = {'just', 'a bunch', 'of items', 'here', 'hehe'},
|
|
type = 'grid'
|
|
}
|
|
</code></pre><h3 class="my-1 text-neutral-800 dark:text-neutral-300 font-bold text-2xl" id="list">list</h3><p>The list completion group type displays in a list. A list item can either be a string, or a table for additional display options.<br>A completion alias can be specified either as the <code class="text-violet-600 dark:text-violet-400">2nd</code> entry in the options table
|
|
or te <code class="text-violet-600 dark:text-violet-400">alias</code> key.<br>A description can optionally be displayed for a list item, which is either the <code class="text-violet-600 dark:text-violet-400">1st</code>
|
|
entry or the <code class="text-violet-600 dark:text-violet-400">description</code> key.<br>Lastly, list entries can be styled. This is done with the <code class="text-violet-600 dark:text-violet-400">display</code> key. If this is present, this overrides what the completion item <em>looks</em> like.<br> <br>Example:</p><pre><code data-lang="lua">{
|
|
items = {
|
|
['--flag'] = {
|
|
description = 'this flag nukes the bri ish',
|
|
alias = '--bye-bri-ish',
|
|
display = lunacolors.format('--{blue}fl{red}ag')
|
|
},
|
|
['--flag2'] = {
|
|
'make pizza', -- description
|
|
'--pizzuh', -- alias
|
|
display = lunacolors.yellow '--pizzuh'
|
|
},
|
|
'--flag3'
|
|
},
|
|
type = 'list'
|
|
}
|
|
</code></pre><h1 class="my-4 text-neutral-800 dark:text-neutral-300 font-bold text-4xl" id="Completion-Handler">Completion Handler</h1><p>Like most parts of Hilbish, it's made to be extensible and
|
|
customizable. The default handler for completions in general can
|
|
be overwritten to provide more advanced completions if needed.
|
|
This usually doesn't need to be done though, unless you know
|
|
what you're doing.<br> <br>The default completion handler provides 3 things:<br>binaries (with a plain name requested to complete, those in $PATH)<br>files<br>or command completions.<br> <br>It will try to run a handler for the command or fallback to file completions.<br> <br>To overwrite it, just assign a function to <code class="text-violet-600 dark:text-violet-400">hilbish.completion.handler</code> like so:</p><pre><code data-lang="lua">-- line is the entire line as a string
|
|
-- pos is the position of the cursor.
|
|
function hilbish.completion.handler(line, pos)
|
|
-- do things
|
|
end
|
|
</code></pre></div><footer class="py-4 px-6 flex flex-row justify-around border-t border-t-zinc-300"><div class="flex flex-col"><a class="flex items-center gap-1" href="https://rosettea.github.io/Hilbish/versions/new-website"><img class="h-24" src="https://rosettea.github.io/Hilbish/versions/new-website/hilbish-flower.png"><span class="self-center text-6xl">Hilbish</span></a><span class="text-xl">The Moon-powered shell!</span><span class="text-light text-neutral-500">MIT License, copyright sammyette 2025</span></div><div class="flex flex-col"><a href="https://github.com/Rosettea/Hilbish" target="_blank"><span class="inline-flex text-light dark:text-pink-300 dark:hover:text-pink-200 text-pink-600 hover:text-pink-500 hover:underline"><tag><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor" class="size-6">
|
|
<path stroke-linecap="round" stroke-linejoin="round" d="M13.5 6H5.25A2.25 2.25 0 0 0 3 8.25v10.5A2.25 2.25 0 0 0 5.25 21h10.5A2.25 2.25 0 0 0 18 18.75V10.5m-10.5 6L21 3m0 0h-5.25M21 3v5.25" />
|
|
</svg>
|
|
</tag>GitHub</span></a></div></footer></div></main></div></div></body></html> |