From 70b919bdf621bff27f6ce175ae9a580b2995eb5e Mon Sep 17 00:00:00 2001 From: sammy-ette Date: Thu, 3 Apr 2025 01:43:03 +0000 Subject: [PATCH] deploy: be26aff71801655cce8598fca2c7643d639eeb63 --- versions/snail/docs/api/index.xml | 10 +++++----- versions/snail/docs/api/snail/index.html | 23 ++++++----------------- versions/snail/index.xml | 10 +++++----- 3 files changed, 16 insertions(+), 27 deletions(-) diff --git a/versions/snail/docs/api/index.xml b/versions/snail/docs/api/index.xml index f070e74..76bad37 100644 --- a/versions/snail/docs/api/index.xml +++ b/versions/snail/docs/api/index.xml @@ -1,10 +1,10 @@ API on Hilbishhttps://rosettea.github.io/Hilbish/versions/snail/docs/api/Recent content in API on HilbishHugo -- gohugo.ioen-usModule 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 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 snailhttps://rosettea.github.io/Hilbish/versions/snail/docs/api/snail/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/snail/docs/api/snail/Introduction The snail library houses Hilbish's Lua wrapper of its shell script interpreter. It's not very useful other than running shell scripts, which can be done with other Hilbish functions. Functions new() -> @Snail Creates a new Snail instance. snail. Parameters This function has no parameters. -snail. Parameters This function has no parameters. -snail. Parameters This function has no parameters. -snail.new() -> Snail Creates a new Snail instance. -Parameters This function has no parameters.Module terminalhttps://rosettea.github.io/Hilbish/versions/snail/docs/api/terminal/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/snail/docs/api/terminal/Introduction The terminal library is a simple and lower level library for certain terminal interactions. +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 snailhttps://rosettea.github.io/Hilbish/versions/snail/docs/api/snail/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/snail/docs/api/snail/Introduction The snail library houses Hilbish’s Lua wrapper of its shell script interpreter. It’s not very useful other than running shell scripts, which can be done with other Hilbish functions. +Functions new() -> @Snail Creates a new Snail instance. snail.new() -> Snail Creates a new Snail instance. +Parameters This function has no parameters. +Types Snail A Snail is a shell script interpreter instance. +Methods run(command, streams) Runs a shell command.Module terminalhttps://rosettea.github.io/Hilbish/versions/snail/docs/api/terminal/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/snail/docs/api/terminal/Introduction The terminal library is a simple and lower level library for certain terminal interactions. Functions restoreState() Restores the last saved state of the terminal saveState() Saves the current state of the terminal. setRaw() Puts the terminal into raw mode. size() Gets the dimensions of the terminal. Returns a table with width and height terminal.restoreState() Restores the last saved state of the terminal Parameters This function has no parameters. \ No newline at end of file diff --git a/versions/snail/docs/api/snail/index.html b/versions/snail/docs/api/snail/index.html index 1f44607..fa57841 100644 --- a/versions/snail/docs/api/snail/index.html +++ b/versions/snail/docs/api/snail/index.html @@ -2,23 +2,12 @@

Module snail

shell script interpreter library

Introduction -

The snail library houses Hilbish's Lua wrapper of its shell script interpreter.
-It's not very useful other than running shell scripts, which can be done with other
-Hilbish functions.
-

Functions -

new() -> @SnailCreates a new Snail instance.

snail. -

Parameters -

This function has no parameters.

snail. -

Parameters -

This function has no parameters.

snail. -

Parameters -

This function has no parameters.

snail.new() -> Snail -

Creates a new Snail instance.

Parameters -

This function has no parameters.

snail. -

Parameters -

This function has no parameters.

snail. -

Parameters -

This function has no parameters.

Types +

The snail library houses Hilbish’s Lua wrapper of its shell script interpreter. +It’s not very useful other than running shell scripts, which can be done with other +Hilbish functions.

Functions +

new() -> @SnailCreates a new Snail instance.

snail.new() -> Snail +

Creates a new Snail instance.

Parameters +

This function has no parameters.

Types

Snail

A Snail is a shell script interpreter instance.

Methods

run(command, streams) diff --git a/versions/snail/index.xml b/versions/snail/index.xml index 544fb0d..50f0e8d 100644 --- a/versions/snail/index.xml +++ b/versions/snail/index.xml @@ -64,11 +64,11 @@ A runner is passed the input and has to return a table with these values.Module hilbish.userDirhttps://rosettea.github.io/Hilbish/versions/snail/docs/api/hilbish/hilbish.userdir/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/snail/docs/api/hilbish/hilbish.userdir/ Introduction This interface just contains properties to know about certain user directories. It is equivalent to XDG on Linux and gets the user’s preferred directories for configs and data. -Static module fields config The user’s config directory data The user’s directory for program dataModule snailhttps://rosettea.github.io/Hilbish/versions/snail/docs/api/snail/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/snail/docs/api/snail/Introduction The snail library houses Hilbish's Lua wrapper of its shell script interpreter. It's not very useful other than running shell scripts, which can be done with other Hilbish functions. Functions new() -> @Snail Creates a new Snail instance. snail. Parameters This function has no parameters. -snail. Parameters This function has no parameters. -snail. Parameters This function has no parameters. -snail.new() -> Snail Creates a new Snail instance. -Parameters This function has no parameters.Module terminalhttps://rosettea.github.io/Hilbish/versions/snail/docs/api/terminal/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/snail/docs/api/terminal/Introduction The terminal library is a simple and lower level library for certain terminal interactions. +Static module fields config The user’s config directory data The user’s directory for program dataModule snailhttps://rosettea.github.io/Hilbish/versions/snail/docs/api/snail/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/snail/docs/api/snail/Introduction The snail library houses Hilbish’s Lua wrapper of its shell script interpreter. It’s not very useful other than running shell scripts, which can be done with other Hilbish functions. +Functions new() -> @Snail Creates a new Snail instance. snail.new() -> Snail Creates a new Snail instance. +Parameters This function has no parameters. +Types Snail A Snail is a shell script interpreter instance. +Methods run(command, streams) Runs a shell command.Module terminalhttps://rosettea.github.io/Hilbish/versions/snail/docs/api/terminal/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/snail/docs/api/terminal/Introduction The terminal library is a simple and lower level library for certain terminal interactions. Functions restoreState() Restores the last saved state of the terminal saveState() Saves the current state of the terminal. setRaw() Puts the terminal into raw mode. size() Gets the dimensions of the terminal. Returns a table with width and height terminal.restoreState() Restores the last saved state of the terminal Parameters This function has no parameters.Notificationhttps://rosettea.github.io/Hilbish/versions/snail/docs/features/notifications/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/versions/snail/docs/features/notifications/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: