From 0fc074f0f6b6ea7223edfbc12c9c03bb1804282a Mon Sep 17 00:00:00 2001 From: sammy-ette Date: Thu, 3 Apr 2025 02:07:22 +0000 Subject: [PATCH] deploy: b6a6f4d2765d21095c18b475af1d42d0e7a729d8 --- .../api/hilbish/hilbish.messages/index.html | 12 ++--- .../api/hilbish/hilbish.runner/index.html | 48 +++++++++---------- versions/snail/docs/nature/dirs/index.html | 22 ++++----- versions/snail/docs/nature/doc/index.html | 16 +++---- versions/snail/docs/nature/index.xml | 4 +- versions/snail/index.xml | 4 +- 6 files changed, 53 insertions(+), 53 deletions(-) diff --git a/versions/snail/docs/api/hilbish/hilbish.messages/index.html b/versions/snail/docs/api/hilbish/hilbish.messages/index.html index 18c39d8..3b63c92 100644 --- a/versions/snail/docs/api/hilbish/hilbish.messages/index.html +++ b/versions/snail/docs/api/hilbish/hilbish.messages/index.html @@ -11,7 +11,7 @@ The hilbish.message type is a table with the following keys: summary (string): A short summary of the text. icon (string): Unicode (preferably standard emoji) icon for the message notification read (boolean): Whether the full message has been read or not.

Functions -

unreadCount()Returns the amount of unread messages.
readAll()Marks all messages as read.
send(message)Sends a message.
read(idx)Marks a message at idx as read.
delete(idx)Deletes the message at idx.
clear()Deletes all messages.
all()Returns all messages.

hilbish.messages.all() +

unreadCount()Returns the amount of unread messages.
send(message)Sends a message.
readAll()Marks all messages as read.
read(idx)Marks a message at idx as read.
delete(idx)Deletes the message at idx.
clear()Deletes all messages.
all()Returns all messages.

hilbish.messages.all()

Returns all messages.

Parameters

This function has no parameters.

hilbish.messages.clear()

Deletes all messages.

Parameters @@ -19,10 +19,10 @@ The hilbish.message type is a table with the following keys:

Deletes the message at idx.

Parameters

idx number

hilbish.messages.read(idx)

Marks a message at idx as read.

Parameters -

idx number

hilbish.messages.send(message) -

Sends a message.

Parameters -

message hilbish.message

hilbish.messages.readAll() -

Marks all messages as read.

Parameters -

This function has no parameters.

hilbish.messages.unreadCount() +

idx number

hilbish.messages.readAll() +

Marks all messages as read.

Parameters +

This function has no parameters.

hilbish.messages.send(message) +

Sends a message.

Parameters +

message hilbish.message

hilbish.messages.unreadCount()

Returns the amount of unread messages.

Parameters

This function has no parameters.

Want to help improve this page? Create an issue.

\ No newline at end of file diff --git a/versions/snail/docs/api/hilbish/hilbish.runner/index.html b/versions/snail/docs/api/hilbish/hilbish.runner/index.html index 1bac9e7..27f33c6 100644 --- a/versions/snail/docs/api/hilbish/hilbish.runner/index.html +++ b/versions/snail/docs/api/hilbish/hilbish.runner/index.html @@ -28,34 +28,34 @@ shell script if fennel eval has an error.

11	return hilbish.runner.sh(input)
 12end)

Functions -

lua(cmd)Evaluates cmd as Lua input. This is the same as using dofile
exec(cmd, runnerName)Executes cmd with a runner.
run(input, priv)Runs input with the currently set Hilbish runner.
getCurrent()Returns the current runner by name.
setCurrent(name)Sets Hilbish’s runner mode by name.
setMode(mode)NOTE: This function is deprecated and will be removed in 3.0
sh()nil
add(name, runner)Adds a runner to the table of available runners.
set(name, runner)Sets a runner by name. The difference between this function and
get(name)Get a runner by name.

hilbish.runner.lua(cmd) +

lua(cmd)Evaluates cmd as Lua input. This is the same as using dofile
sh()nil
setMode(mode)NOTE: This function is deprecated and will be removed in 3.0
setCurrent(name)Sets Hilbish’s runner mode by name.
set(name, runner)Sets a runner by name. The difference between this function and
run(input, priv)Runs input with the currently set Hilbish runner.
getCurrent()Returns the current runner by name.
get(name)Get a runner by name.
exec(cmd, runnerName)Executes cmd with a runner.
add(name, runner)Adds a runner to the table of available runners.

hilbish.runner.lua(cmd)

Evaluates cmd as Lua input. This is the same as using dofile
or load, but is appropriated for the runner interface.

Parameters -

string cmd

hilbish.runner.get(name) -

Get a runner by name.

Parameters -

name string
Name of the runner to retrieve.

hilbish.runner.set(name, runner) +

string cmd

hilbish.runner.add(name, runner) +

Adds a runner to the table of available runners. +If runner is a table, it must have the run function in it.

Parameters +

name string
Name of the runner

runner function|table

hilbish.runner.exec(cmd, runnerName) +

Executes cmd with a runner. +If runnerName is not specified, it uses the default Hilbish runner.

Parameters +

cmd string

runnerName string?

hilbish.runner.get(name) +

Get a runner by name.

Parameters +

name string
Name of the runner to retrieve.

hilbish.runner.getCurrent() +

Returns the current runner by name.

Parameters +

This function has no parameters.

hilbish.runner.run(input, priv) +

Runs input with the currently set Hilbish runner. +This method is how Hilbish executes commands. +priv is an optional boolean used to state if the input should be saved to history.

Parameters +

input string

priv bool

hilbish.runner.set(name, runner)

Sets a runner by name. The difference between this function and add, is set will not check if the named runner exists. -The runner table must have the run function in it.

Parameters -

name string

runner table

hilbish.runner.add(name, runner) -

Adds a runner to the table of available runners. -If runner is a table, it must have the run function in it.

Parameters -

name string
Name of the runner

runner function|table

hilbish.runner.sh() -

Parameters -

This function has no parameters.

hilbish.runner.setMode(mode) +The runner table must have the run function in it.

Parameters +

name string

runner table

hilbish.runner.setCurrent(name) +

Sets Hilbish’s runner mode by name.

Parameters +

name string

hilbish.runner.setMode(mode)

NOTE: This function is deprecated and will be removed in 3.0 Use hilbish.runner.setCurrent instead. This is the same as the hilbish.runnerMode function. It takes a callback, which will be used to execute all interactive input. -Or a string which names the runner mode to use.

Parameters -

mode string|function

hilbish.runner.setCurrent(name) -

Sets Hilbish’s runner mode by name.

Parameters -

name string

hilbish.runner.getCurrent() -

Returns the current runner by name.

Parameters -

This function has no parameters.

hilbish.runner.run(input, priv) -

Runs input with the currently set Hilbish runner. -This method is how Hilbish executes commands. -priv is an optional boolean used to state if the input should be saved to history.

Parameters -

input string

priv bool

hilbish.runner.exec(cmd, runnerName) -

Executes cmd with a runner. -If runnerName is not specified, it uses the default Hilbish runner.

Parameters -

cmd string

runnerName string?

Want to help improve this page? Create an issue.

\ No newline at end of file +Or a string which names the runner mode to use.

Parameters +

mode string|function

hilbish.runner.sh() +

Parameters +

This function has no parameters.

Want to help improve this page? Create an issue.

\ No newline at end of file diff --git a/versions/snail/docs/nature/dirs/index.html b/versions/snail/docs/nature/dirs/index.html index 6a9982e..cbea61a 100644 --- a/versions/snail/docs/nature/dirs/index.html +++ b/versions/snail/docs/nature/dirs/index.html @@ -4,15 +4,15 @@

Module dirs

internal directory management

Introduction

The dirs module defines a small set of functions to store and manage directories.

Functions -

recent(idx)Get entry from recent directories list based on index.
pop(num)Remove the specified amount of dirs from the recent directories list.
peak(num)Look at num amount of recent directories, starting from the latest.
push(dir)Add dir to the recent directories list.
setOld(d)Sets the old directory string.

dirs.setOld(d) -

Sets the old directory string.

Parameters -

d string

dirs.push(dir) -

Add dir to the recent directories list.

Parameters -

dir string

dirs.peak(num) +

setOld(d)Sets the old directory string.
recent(idx)Get entry from recent directories list based on index.
push(dir)Add dir to the recent directories list.
pop(num)Remove the specified amount of dirs from the recent directories list.
peak(num)Look at num amount of recent directories, starting from the latest.

dirs.peak(num)

Look at num amount of recent directories, starting from the latest. -This returns a table of recent directories, up to the num amount.

Parameters -

num number

dirs.pop(num) -

Remove the specified amount of dirs from the recent directories list.

Parameters -

num number

dirs.recent(idx) -

Get entry from recent directories list based on index.

Parameters -

idx number

Want to help improve this page? Create an issue.

\ No newline at end of file +This returns a table of recent directories, up to the num amount.

Parameters +

num number

dirs.pop(num) +

Remove the specified amount of dirs from the recent directories list.

Parameters +

num number

dirs.push(dir) +

Add dir to the recent directories list.

Parameters +

dir string

dirs.recent(idx) +

Get entry from recent directories list based on index.

Parameters +

idx number

dirs.setOld(d) +

Sets the old directory string.

Parameters +

d string

Want to help improve this page? Create an issue.

\ No newline at end of file diff --git a/versions/snail/docs/nature/doc/index.html b/versions/snail/docs/nature/doc/index.html index 53cc96f..1c20e9a 100644 --- a/versions/snail/docs/nature/doc/index.html +++ b/versions/snail/docs/nature/doc/index.html @@ -6,13 +6,13 @@ used by the Greenhouse pager to render parts of the documentation pages. This is only documented for the sake of it. It’s only intended use is by the Greenhouse pager.

Functions -

renderCodeBlock(text)Assembles and renders a code block. This returns
highlight(text)Performs basic Lua code highlighting.
renderInfoBlock(type, text)Renders an info block. An info block is a block of text with

doc.renderInfoBlock(type, text) -

Renders an info block. An info block is a block of text with -an icon and styled text block.

Parameters -

type string
Type of info block. The only one specially styled is the warning.

text string

doc.highlight(text) -

Performs basic Lua code highlighting.

Parameters -

text string
Code/text to do highlighting on.

doc.renderCodeBlock(text) +

renderInfoBlock(type, text)Renders an info block. An info block is a block of text with
renderCodeBlock(text)Assembles and renders a code block. This returns
highlight(text)Performs basic Lua code highlighting.

doc.highlight(text) +

Performs basic Lua code highlighting.

Parameters +

text string
Code/text to do highlighting on.

doc.renderCodeBlock(text)

Assembles and renders a code block. This returns the supplied text based on the number of command line columns, -and styles it to resemble a code block.

Parameters -

text string

Want to help improve this page? Create an issue.

\ No newline at end of file +and styles it to resemble a code block.

Parameters +

text string

doc.renderInfoBlock(type, text) +

Renders an info block. An info block is a block of text with +an icon and styled text block.

Parameters +

type string
Type of info block. The only one specially styled is the warning.

text string

Want to help improve this page? Create an issue.

\ No newline at end of file diff --git a/versions/snail/docs/nature/index.xml b/versions/snail/docs/nature/index.xml index a4bddce..cfa5216 100644 --- a/versions/snail/docs/nature/index.xml +++ b/versions/snail/docs/nature/index.xml @@ -1,3 +1,3 @@ Nature on Hilbishhttps://rosettea.github.io/Hilbish/versions/snail/docs/nature/Recent content in Nature on HilbishHugo -- gohugo.ioen-usModule dirshttps://rosettea.github.io/Hilbish/versions/snail/docs/nature/dirs/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/snail/docs/nature/dirs/Introduction The dirs module defines a small set of functions to store and manage directories. -Functions recent(idx) Get entry from recent directories list based on index. pop(num) Remove the specified amount of dirs from the recent directories list. peak(num) Look at num amount of recent directories, starting from the latest. push(dir) Add dir to the recent directories list. setOld(d) Sets the old directory string. dirs.setOld(d) Sets the old directory string.Module dochttps://rosettea.github.io/Hilbish/versions/snail/docs/nature/doc/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/snail/docs/nature/doc/Introduction The doc module contains a small set of functions used by the Greenhouse pager to render parts of the documentation pages. This is only documented for the sake of it. It’s only intended use is by the Greenhouse pager. -Functions renderCodeBlock(text) Assembles and renders a code block. This returns highlight(text) Performs basic Lua code highlighting. renderInfoBlock(type, text) Renders an info block. An info block is a block of text with doc. \ No newline at end of file +Functions setOld(d) Sets the old directory string. recent(idx) Get entry from recent directories list based on index. push(dir) Add dir to the recent directories list. pop(num) Remove the specified amount of dirs from the recent directories list. peak(num) Look at num amount of recent directories, starting from the latest. dirs.peak(num) Look at num amount of recent directories, starting from the latest.Module dochttps://rosettea.github.io/Hilbish/versions/snail/docs/nature/doc/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/snail/docs/nature/doc/Introduction The doc module contains a small set of functions used by the Greenhouse pager to render parts of the documentation pages. This is only documented for the sake of it. It’s only intended use is by the Greenhouse pager. +Functions renderInfoBlock(type, text) Renders an info block. An info block is a block of text with renderCodeBlock(text) Assembles and renders a code block. This returns highlight(text) Performs basic Lua code highlighting. \ No newline at end of file diff --git a/versions/snail/index.xml b/versions/snail/index.xml index 53f7490..65f9fc5 100644 --- a/versions/snail/index.xml +++ b/versions/snail/index.xml @@ -46,8 +46,8 @@ You can download both at any time, but note that the development builds may have 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.Module baithttps://rosettea.github.io/Hilbish/versions/snail/docs/api/bait/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/snail/docs/api/bait/Introduction Bait is the event emitter for Hilbish. Much like Node.js and its events system, many actions in Hilbish emit events. Unlike Node.js, Hilbish events are global. So make sure to pick a unique name! Usage of the Bait module consists of userstanding event-driven architecture, but it’s pretty simple: If you want to act on a certain event, you can catch it. You can act on events via callback functions.Module commanderhttps://rosettea.github.io/Hilbish/versions/snail/docs/api/commander/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/snail/docs/api/commander/Introduction Commander is the library which handles Hilbish commands. This makes the user able to add Lua-written commands to their shell without making a separate script in a bin folder. Instead, you may simply use the Commander library in your Hilbish config. 1local commander = require 'commander' 2 3commander.register('hello', function(args, sinks) 4 sinks.out:writeln 'Hello world!' 5end) In this example, a command with the name of hello is created that will print Hello world!Module dirshttps://rosettea.github.io/Hilbish/versions/snail/docs/nature/dirs/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/snail/docs/nature/dirs/Introduction The dirs module defines a small set of functions to store and manage directories. -Functions recent(idx) Get entry from recent directories list based on index. pop(num) Remove the specified amount of dirs from the recent directories list. peak(num) Look at num amount of recent directories, starting from the latest. push(dir) Add dir to the recent directories list. setOld(d) Sets the old directory string. dirs.setOld(d) Sets the old directory string.Module dochttps://rosettea.github.io/Hilbish/versions/snail/docs/nature/doc/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/snail/docs/nature/doc/Introduction The doc module contains a small set of functions used by the Greenhouse pager to render parts of the documentation pages. This is only documented for the sake of it. It’s only intended use is by the Greenhouse pager. -Functions renderCodeBlock(text) Assembles and renders a code block. This returns highlight(text) Performs basic Lua code highlighting. renderInfoBlock(type, text) Renders an info block. An info block is a block of text with doc.Module fshttps://rosettea.github.io/Hilbish/versions/snail/docs/api/fs/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/snail/docs/api/fs/Introduction The fs module provides filesystem functions to Hilbish. While Lua’s standard library has some I/O functions, they’re missing a lot of the basics. The fs library offers more functions and will work on any operating system Hilbish does. +Functions setOld(d) Sets the old directory string. recent(idx) Get entry from recent directories list based on index. push(dir) Add dir to the recent directories list. pop(num) Remove the specified amount of dirs from the recent directories list. peak(num) Look at num amount of recent directories, starting from the latest. dirs.peak(num) Look at num amount of recent directories, starting from the latest.Module dochttps://rosettea.github.io/Hilbish/versions/snail/docs/nature/doc/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/snail/docs/nature/doc/Introduction The doc module contains a small set of functions used by the Greenhouse pager to render parts of the documentation pages. This is only documented for the sake of it. It’s only intended use is by the Greenhouse pager. +Functions renderInfoBlock(type, text) Renders an info block. An info block is a block of text with renderCodeBlock(text) Assembles and renders a code block. This returns highlight(text) Performs basic Lua code highlighting.Module fshttps://rosettea.github.io/Hilbish/versions/snail/docs/api/fs/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/snail/docs/api/fs/Introduction The fs module provides filesystem functions to Hilbish. While Lua’s standard library has some I/O functions, they’re missing a lot of the basics. The fs library offers more functions and will work on any operating system Hilbish does. Functions abs(path) -> string Returns an absolute version of the path. basename(path) -> string Returns the “basename,” or the last part of the provided path. If path is empty, cd(dir) Changes Hilbish’s directory to dir.Module hilbish.aliaseshttps://rosettea.github.io/Hilbish/versions/snail/docs/api/hilbish/hilbish.aliases/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/snail/docs/api/hilbish/hilbish.aliases/Introduction The alias interface deals with all command aliases in Hilbish. Functions add(alias, cmd) This is an alias (ha) for the hilbish.alias function. delete(name) Removes an alias. list() -> table[string, string] Get a table of all aliases, with string keys as the alias and the value as the command. resolve(alias) -> string? Resolves an alias to its original command. Will thrown an error if the alias doesn’t exist. hilbish.aliases.add(alias, cmd) This is an alias (ha) for the hilbish.Module hilbish.completionhttps://rosettea.github.io/Hilbish/versions/snail/docs/api/hilbish/hilbish.completion/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/snail/docs/api/hilbish/hilbish.completion/Introduction The completions interface deals with tab completions. Functions bins(query, ctx, fields) -> entries (table), prefix (string) Return binaries/executables based on the provided parameters. call(name, query, ctx, fields) -> completionGroups (table), prefix (string) Calls a completer function. This is mainly used to call a command completer, which will have a name files(query, ctx, fields) -> entries (table), prefix (string) Returns file matches based on the provided parameters. handler(line, pos) This function contains the general completion handler for Hilbish.Module hilbish.editorhttps://rosettea.github.io/Hilbish/versions/snail/docs/api/hilbish/hilbish.editor/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/snail/docs/api/hilbish/hilbish.editor/Introduction The hilbish.editor interface provides functions to directly interact with the line editor in use.