sammyette
/
Hilbish
mirror of https://github.com/Hilbis/Hilbish
2
2
Fork 0
Code Issues Releases Wiki Activity

deploy: 633658463f94fe9148b9079964ac1b5cd03ff601

gh-pages
TorchedSammy 2023-12-24 22:23:30 +00:00
parent 174865ccd7
commit 3eb4afeea7
5 changed files with 140 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
versions/doc-improvements/docs/hooks/command/index.html
View File

File diff suppressed because one or more lines are too long

35
versions/doc-improvements/docs/hooks/hilbish/index.html
View File

File diff suppressed because one or more lines are too long

31
versions/doc-improvements/docs/hooks/index.xml
View File

@ -1,11 +1,24 @@
<?xml version="1.0" encoding="utf-8" standalone="yes"?><rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>Signals on Hilbish</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/hooks/</link><description>Recent content in Signals on Hilbish</description><generator>Hugo -- gohugo.io</generator><language>en-us</language><atom:link href="https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/hooks/index.xml" rel="self" type="application/rss+xml"/><item><title/><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/hooks/job/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/hooks/job/</guid><description>Note: job refers to a job object. You can check doc jobs for more detail. <?xml version="1.0" encoding="utf-8" standalone="yes"?><rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>Signals on Hilbish</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/hooks/</link><description>Recent content in Signals on Hilbish</description><generator>Hugo -- gohugo.io</generator><language>en-us</language><atom:link href="https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/hooks/index.xml" rel="self" type="application/rss+xml"/><item><title/><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/hooks/job/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/hooks/job/</guid><description>Note: job refers to a job object. You can check doc jobs for more detail.
job.start -&amp;gt; job &amp;gt; Thrown when a new background job starts. job.start -&amp;gt; job &amp;gt; Thrown when a new background job starts.
job.done -&amp;gt; job &amp;gt; Thrown when a background jobs exits.</description></item><item><title>Command</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/hooks/command/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/hooks/command/</guid><description>command.preexec -&amp;gt; input, cmdStr &amp;gt; Thrown before a command is executed. The input is the user written command, while cmdStr is what will be executed (input will have aliases while cmdStr will have alias resolved input). job.done -&amp;gt; job &amp;gt; Thrown when a background jobs exits.</description></item><item><title>Command</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/hooks/command/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/hooks/command/</guid><description>command.preexec Thrown right before a command is executed.
command.exit -&amp;gt; code, cmdStr &amp;gt; Thrown when a command exits. code is the exit code of the command, and cmdStr is the command that was run. Variables string input
command.not-found -&amp;gt; cmdStr &amp;gt; Thrown when a command is not found.</description></item><item><title>Hilbish</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/hooks/hilbish/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/hooks/hilbish/</guid><description>hilbish.exit &amp;gt; Sent when Hilbish is about to exit. The raw string that the user typed. This will include the text without changes applied to it (argument substitution, alias expansion, etc.)
hilbish.vimMode -&amp;gt; modeName &amp;gt; Sent when Hilbish&amp;rsquo;s Vim mode is changed (example insert to normal mode), modeName is the name of the mode changed to (can be insert, normal, delete or replace). string cmdStr
hilbish.vimAction -&amp;gt; actionName, args &amp;gt; Sent when the user does a &amp;ldquo;vim action,&amp;rdquo; being something like yanking or pasting text. See doc vim-mode actions for more info. The command that will be directly executed by the current runner.
hilbish.cancel &amp;gt; Sent when the user cancels their input with Ctrl-C.</description></item><item><title>Signal</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/hooks/signal/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/hooks/signal/</guid><description>signal.sigint &amp;gt; Sent when Hilbish receives SIGINT (on Ctrl-C). command.exit Thrown after the user&amp;rsquo;s ran command is finished.
signal.resize &amp;gt; Sent when the terminal is resized. Variables number code
signal.sigusr1 The exit code of what was executed.
signal.sigusr2</description></item></channel></rss> string cmdStr
The command or code that was executed</description></item><item><title>Hilbish</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/hooks/hilbish/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/hooks/hilbish/</guid><description>hilbish.exit Sent when Hilbish is going to exit.
Variables This signal returns no variables.
hilbish.vimMode Sent when the Vim mode of Hilbish is changed (like from insert to normal mode). This can be used to change the prompt and notify based on Vim mode.
Variables string modeName
The mode that has been set. Can be these values: insert, normal, delete or replace
hilbish.cancel Sent when the user cancels their command input with Ctrl-C</description></item><item><title>Signal</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/hooks/signal/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/hooks/signal/</guid><description>signal.sigint Thrown when Hilbish receive the SIGINT signal, aka when Ctrl-C is pressed.
Variables This signal returns no variables.
signal.resize Thrown when the terminal is resized.
Variables This signal returns no variables.
signal.sigusr1 Thrown when SIGUSR1 is sent to Hilbish.
Variables This signal returns no variables.
signal.sigusr2 Thrown when SIGUSR2 is sent to Hilbish.
Variables This signal returns no variables.</description></item></channel></rss>

33
versions/doc-improvements/docs/hooks/signal/index.html
View File

File diff suppressed because one or more lines are too long

35
versions/doc-improvements/index.xml
View File

@ -19,14 +19,23 @@ This is a big release, coming 9 months after the previous v1.2.0 and featuring o
Documentation When querying about the problems people have with Hilbish, one of the issues was its poor documentation.</description></item><item><title/><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/hooks/job/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/hooks/job/</guid><description>Note: job refers to a job object. You can check doc jobs for more detail. Documentation When querying about the problems people have with Hilbish, one of the issues was its poor documentation.</description></item><item><title/><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/hooks/job/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/hooks/job/</guid><description>Note: job refers to a job object. You can check doc jobs for more detail.
job.start -&amp;gt; job &amp;gt; Thrown when a new background job starts. job.start -&amp;gt; job &amp;gt; Thrown when a new background job starts.
job.done -&amp;gt; job &amp;gt; Thrown when a background jobs exits.</description></item><item><title/><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/runner-mode/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/runner-mode/</guid><description>Hilbish allows you to change how interactive text can be interpreted. This is mainly due to the fact that the default method Hilbish uses is that it runs Lua first and then falls back to shell script. job.done -&amp;gt; job &amp;gt; Thrown when a background jobs exits.</description></item><item><title/><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/runner-mode/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/runner-mode/</guid><description>Hilbish allows you to change how interactive text can be interpreted. This is mainly due to the fact that the default method Hilbish uses is that it runs Lua first and then falls back to shell script.
In some cases, someone might want to switch to just shell script to avoid it while interactive but still have a Lua config, or go full Lua to use Hilbish as a REPL. This also allows users to add alternative languages like Fennel as the interactive script runner.</description></item><item><title/><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/timers/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/timers/</guid><description>This has been moved to the hilbish.timers API doc (accessible by doc api hilbish.timers)</description></item><item><title>Command</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/hooks/command/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/hooks/command/</guid><description>command.preexec -&amp;gt; input, cmdStr &amp;gt; Thrown before a command is executed. The input is the user written command, while cmdStr is what will be executed (input will have aliases while cmdStr will have alias resolved input). In some cases, someone might want to switch to just shell script to avoid it while interactive but still have a Lua config, or go full Lua to use Hilbish as a REPL. This also allows users to add alternative languages like Fennel as the interactive script runner.</description></item><item><title/><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/timers/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/timers/</guid><description>This has been moved to the hilbish.timers API doc (accessible by doc api hilbish.timers)</description></item><item><title>Command</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/hooks/command/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/hooks/command/</guid><description>command.preexec Thrown right before a command is executed.
command.exit -&amp;gt; code, cmdStr &amp;gt; Thrown when a command exits. code is the exit code of the command, and cmdStr is the command that was run. Variables string input
command.not-found -&amp;gt; cmdStr &amp;gt; Thrown when a command is not found.</description></item><item><title>Completions</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/completions/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/completions/</guid><description>Hilbish has a pretty good completion system. It has a nice looking menu, with 2 types of menus: grid (like file completions) or list. The raw string that the user typed. This will include the text without changes applied to it (argument substitution, alias expansion, etc.)
string cmdStr
The command that will be directly executed by the current runner.
command.exit Thrown after the user&amp;rsquo;s ran command is finished.
Variables number code
The exit code of what was executed.
string cmdStr
The command or code that was executed</description></item><item><title>Completions</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/completions/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/completions/</guid><description>Hilbish has a pretty good completion system. It has a nice looking menu, with 2 types of menus: grid (like file completions) or list.
Like most parts of Hilbish, it&amp;rsquo;s made to be extensible and customizable. The default handler for completions in general can be overwritten to provide more advanced completions if needed. Like most parts of Hilbish, it&amp;rsquo;s made to be extensible and customizable. The default handler for completions in general can be overwritten to provide more advanced completions if needed.
Completion Handler By default, it provides 3 things: for the first argument, binaries (with a plain name requested to complete, those in $PATH), files, or command completions.</description></item><item><title>Hilbish</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/hooks/hilbish/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/hooks/hilbish/</guid><description>hilbish.exit &amp;gt; Sent when Hilbish is about to exit. Completion Handler By default, it provides 3 things: for the first argument, binaries (with a plain name requested to complete, those in $PATH), files, or command completions.</description></item><item><title>Hilbish</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/hooks/hilbish/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/hooks/hilbish/</guid><description>hilbish.exit Sent when Hilbish is going to exit.
hilbish.vimMode -&amp;gt; modeName &amp;gt; Sent when Hilbish&amp;rsquo;s Vim mode is changed (example insert to normal mode), modeName is the name of the mode changed to (can be insert, normal, delete or replace). Variables This signal returns no variables.
hilbish.vimAction -&amp;gt; actionName, args &amp;gt; Sent when the user does a &amp;ldquo;vim action,&amp;rdquo; being something like yanking or pasting text. See doc vim-mode actions for more info. hilbish.vimMode Sent when the Vim mode of Hilbish is changed (like from insert to normal mode). This can be used to change the prompt and notify based on Vim mode.
hilbish.cancel &amp;gt; Sent when the user cancels their input with Ctrl-C.</description></item><item><title>Install</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/install/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/install/</guid><description>Official Binaries The best way to get Hilbish is to get a build directly from GitHub. At any time, there are 2 versions of Hilbish recommended for download: the latest stable release, and development builds from the master branch. Variables string modeName
The mode that has been set. Can be these values: insert, normal, delete or replace
hilbish.cancel Sent when the user cancels their command input with Ctrl-C</description></item><item><title>Install</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/install/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/install/</guid><description>Official Binaries The best way to get Hilbish is to get a build directly from GitHub. At any time, there are 2 versions of Hilbish recommended for download: the latest stable release, and development builds from the master branch.
You can download both at any time, but note that the development builds may have breaking changes. You can download both at any time, but note that the development builds may have breaking changes.
For the latest stable release, check here: https://github.com/Rosettea/Hilbish/releases/latest For a development build: https://nightly.link/Rosettea/Hilbish/workflows/build/master Compiling To read the steps for compiling Hilbish, head over to the GitHub repository.</description></item><item><title>Jobs</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/jobs/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/jobs/</guid><description>Hilbish has pretty standard job control. It&amp;rsquo;s missing one or two things, but works well. One thing which is different from other shells (besides Hilbish) itself is the API for jobs, and of course it&amp;rsquo;s in Lua. You can add jobs, stop and delete (disown) them and even get output. For the latest stable release, check here: https://github.com/Rosettea/Hilbish/releases/latest For a development build: https://nightly.link/Rosettea/Hilbish/workflows/build/master Compiling To read the steps for compiling Hilbish, head over to the GitHub repository.</description></item><item><title>Jobs</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/jobs/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/jobs/</guid><description>Hilbish has pretty standard job control. It&amp;rsquo;s missing one or two things, but works well. One thing which is different from other shells (besides Hilbish) itself is the API for jobs, and of course it&amp;rsquo;s in Lua. You can add jobs, stop and delete (disown) them and even get output.
Job Interface The job interface refers to hilbish.jobs. Job Interface The job interface refers to hilbish.jobs.
@ -51,7 +60,11 @@ Functions restoreState() Restores the last saved state of the terminal saveState
Parameters This function has no parameters.</description></item><item><title>Notification</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/features/notifications/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/features/notifications/</guid><description>Hilbish features a simple notification system which can be used by other plugins and parts of the shell to notify the user of various actions. This is used via the hilbish.message interface. Parameters This function has no parameters.</description></item><item><title>Notification</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/features/notifications/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/features/notifications/</guid><description>Hilbish features a simple notification system which can be used by other plugins and parts of the shell to notify the user of various actions. This is used via the hilbish.message interface.
A message is defined as a table with the following properties: A message is defined as a table with the following properties:
icon: A unicode/emoji icon for the notification. title: The title of the message text: Message text/body channel: The source of the message. This should be a unique and easily readable text identifier.</description></item><item><title>Runner Mode</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/features/runner-mode/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/features/runner-mode/</guid><description>Hilbish allows you to change how interactive text can be interpreted. This is mainly due to the fact that the default method Hilbish uses is that it runs Lua first and then falls back to shell script. icon: A unicode/emoji icon for the notification. title: The title of the message text: Message text/body channel: The source of the message. This should be a unique and easily readable text identifier.</description></item><item><title>Runner Mode</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/features/runner-mode/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/features/runner-mode/</guid><description>Hilbish allows you to change how interactive text can be interpreted. This is mainly due to the fact that the default method Hilbish uses is that it runs Lua first and then falls back to shell script.
In some cases, someone might want to switch to just shell script to avoid it while interactive but still have a Lua config, or go full Lua to use Hilbish as a REPL. This also allows users to add alternative languages like Fennel as the interactive script runner.</description></item><item><title>Signal</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/hooks/signal/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/hooks/signal/</guid><description>signal.sigint &amp;gt; Sent when Hilbish receives SIGINT (on Ctrl-C). In some cases, someone might want to switch to just shell script to avoid it while interactive but still have a Lua config, or go full Lua to use Hilbish as a REPL. This also allows users to add alternative languages like Fennel as the interactive script runner.</description></item><item><title>Signal</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/hooks/signal/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/hooks/signal/</guid><description>signal.sigint Thrown when Hilbish receive the SIGINT signal, aka when Ctrl-C is pressed.
signal.resize &amp;gt; Sent when the terminal is resized. Variables This signal returns no variables.
signal.sigusr1 signal.resize Thrown when the terminal is resized.
signal.sigusr2</description></item><item><title>Welcome to the Hilbish blog</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/blog/welcome/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/blog/welcome/</guid><description>Hello! Welcome to the Hilbish blog. This will mainly contain release announcements and some other things relating to Hilbish (development).</description></item></channel></rss> Variables This signal returns no variables.
signal.sigusr1 Thrown when SIGUSR1 is sent to Hilbish.
Variables This signal returns no variables.
signal.sigusr2 Thrown when SIGUSR2 is sent to Hilbish.
Variables This signal returns no variables.</description></item><item><title>Welcome to the Hilbish blog</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/blog/welcome/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/blog/welcome/</guid><description>Hello! Welcome to the Hilbish blog. This will mainly contain release announcements and some other things relating to Hilbish (development).</description></item></channel></rss>