diff --git a/cmd/docgen/docgen.go b/cmd/docgen/docgen.go index 368b1a9..09a5297 100644 --- a/cmd/docgen/docgen.go +++ b/cmd/docgen/docgen.go @@ -203,7 +203,6 @@ func setupDocType(mod string, typ *doc.Type) *docPiece { Tags: tags, } - fmt.Println(typeName, parentMod, interfaces) typeTable[strings.ToLower(typeName)] = []string{parentMod, interfaces} return dps @@ -477,12 +476,9 @@ provided by Hilbish. f, _ := os.Create(docPath) f.WriteString(fmt.Sprintf(header, modOrIface, modname, modu.ShortDescription)) typeTag, _ := regexp.Compile(`\B@\w+`) - //fmt.Println(modu.Description) modDescription := typeTag.ReplaceAllStringFunc(strings.Replace(strings.Replace(modu.Description, "<", `\<`, -1), "{{\\<", "{{<", -1), func(typ string) string { typName := typ[1:] - fmt.Println("typ name", typName) typLookup := typeTable[strings.ToLower(typName)] - fmt.Println(typLookup) ifaces := typLookup[0] + "." + typLookup[1] + "/" if typLookup[1] == "" { ifaces = "" diff --git a/cmd/docgen/docgen.lua b/cmd/docgen/docgen.lua index e1e57d6..0ae2837 100644 --- a/cmd/docgen/docgen.lua +++ b/cmd/docgen/docgen.lua @@ -15,7 +15,6 @@ for _, fname in ipairs(files) do local mod = header:match(modpattern) if not mod then goto continue end - print(fname, mod) pieces[mod] = {} descriptions[mod] = {} @@ -59,14 +58,12 @@ for _, fname in ipairs(files) do if emmy then if emmy == 'param' then - print('bruh', emmythings[1], emmythings[2]) table.insert(dps.params, 1, { name = emmythings[1], type = emmythings[2], -- the +1 accounts for space. description = table.concat(emmythings, ' '):sub(emmythings[1]:len() + 1 + emmythings[2]:len() + 1) }) - print(table.concat(emmythings, '/')) end else table.insert(dps.description, 1, docline) @@ -109,11 +106,15 @@ for iface, dps in pairs(pieces) do docParent = "API" path = string.format('docs/api/%s/%s.md', mod, iface) end + if iface == 'hilbish' then + docParent = "API" + path = string.format('docs/api/hilbish/_index.md', mod, iface) + end fs.mkdir(fs.dir(path), true) local exists = pcall(fs.stat, path) - local newOrNotNature = exists and mod ~= 'nature' + local newOrNotNature = (exists and mod ~= 'nature') or iface == 'hilbish' local f = io.open(path, newOrNotNature and 'r+' or 'w+') local tocPos @@ -129,9 +130,6 @@ for iface, dps in pairs(pieces) do tocPos = f:seek() end end - print(f) - - print('mod and path:', mod, path) local tocSearch = false for line in f:lines() do diff --git a/docs/api/hilbish/_index.md b/docs/api/hilbish/_index.md index 02ffea3..60e5323 100644 --- a/docs/api/hilbish/_index.md +++ b/docs/api/hilbish/_index.md @@ -30,6 +30,7 @@ interfaces and functions which directly relate to shell functionality. |read(prompt) -> input (string)|Read input from the user, using Hilbish's line editor/input reader.| |timeout(cb, time) -> @Timer|Executed the `cb` function after a period of `time`.| |which(name) -> string|Checks if `name` is a valid command.| +|runnerMode(mode)|Sets the execution/runner mode for interactive Hilbish.| ## Static module fields ||| @@ -447,3 +448,27 @@ Will return the path of the binary, or a basename if it's a commander. +
+
+

+hilbish.runnerMode(mode) + + + +

+ +Sets the execution/runner mode for interactive Hilbish. +**NOTE: This function is deprecated and will be removed in 3.0** +Use `hilbish.runner.setCurrent` instead. +This determines whether Hilbish wll try to run input as Lua +and/or sh or only do one of either. +Accepted values for mode are hybrid (the default), hybridRev (sh first then Lua), +sh, and lua. It also accepts a function, to which if it is passed one +will call it to execute user input instead. +Read [about runner mode](../features/runner-mode) for more information. +#### Parameters +`mode` **`string|function`** + + +
+ diff --git a/docs/api/hilbish/hilbish.runner.md b/docs/api/hilbish/hilbish.runner.md index 7cb2522..305348a 100644 --- a/docs/api/hilbish/hilbish.runner.md +++ b/docs/api/hilbish/hilbish.runner.md @@ -56,13 +56,14 @@ end) |----|----| |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.| -|add(name, runner)|Adds a runner to the table of available runners.| -|setCurrent(name)|Sets Hilbish's runner mode by name.| -|getCurrent()|Returns the current runner by name.| -|run(input, priv)|Runs `input` with the currently set Hilbish runner.| -|sh()|nil|
@@ -80,91 +81,6 @@ or `load`, but is appropriated for the runner interface. `string` **`cmd`** -
- -
-
-

-hilbish.runner.sh() - - - -

- - -#### 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.getCurrent() - - - -

- -Returns the current runner by name. -#### Parameters -This function has no parameters. -
- -
-
-

-hilbish.runner.setCurrent(name) - - - -

- -Sets Hilbish's runner mode by name. -#### Parameters -`name` **`string`** - - -
- -
-
-

-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`** - -
@@ -202,6 +118,111 @@ The runner table must have the run function in it. `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) + + + +

+ +**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`** + +
diff --git a/docs/nature/hilbish.md b/docs/nature/hilbish.md deleted file mode 100644 index 830e241..0000000 --- a/docs/nature/hilbish.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: Module hilbish -description: No description. -layout: doc -menu: - docs: - parent: "Nature" ---- - -
-
-

-hilbish.runner(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.runnerMode(mode) - - - -

- -**NOTE: This function is deprecated and will be removed in 3.0** -Use `hilbish.runner.setCurrent` instead. -Sets the execution/runner mode for interactive Hilbish. -This determines whether Hilbish wll try to run input as Lua -and/or sh or only do one of either. -Accepted values for mode are hybrid (the default), hybridRev (sh first then Lua), -sh, and lua. It also accepts a function, to which if it is passed one -will call it to execute user input instead. -Read [about runner mode](../features/runner-mode) for more information. -#### Parameters -`mode` **`string|function`** - - -
- diff --git a/nature/runner.lua b/nature/runner.lua index e05d16b..427fb7e 100644 --- a/nature/runner.lua +++ b/nature/runner.lua @@ -82,6 +82,16 @@ function hilbish.runner.getCurrent() return currentRunner end +--- **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. +-- @param mode string|function +function hilbish.runner.setMode(mode) + hilbish.runnerMode(mode) +end + local function finishExec(exitCode, input, priv) hilbish.exitCode = exitCode bait.throw('command.exit', exitCode, input, priv) diff --git a/nature/runnerLegacy.lua b/nature/runnerLegacy.lua index 5bd132a..2192685 100644 --- a/nature/runnerLegacy.lua +++ b/nature/runnerLegacy.lua @@ -1,8 +1,8 @@ -- @module hilbish +--- Sets the execution/runner mode for interactive Hilbish. --- **NOTE: This function is deprecated and will be removed in 3.0** --- Use `hilbish.runner.setCurrent` instead. ---- Sets the execution/runner mode for interactive Hilbish. --- This determines whether Hilbish wll try to run input as Lua --- and/or sh or only do one of either. --- Accepted values for mode are hybrid (the default), hybridRev (sh first then Lua), @@ -22,13 +22,3 @@ function hilbish.runnerMode(mode) error('expected runner mode type to be either string or function, got', type(mode)) end end - ---- **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. --- @param mode string|function -function hilbish.runner.setMode(mode) - hilbish.runnerMode(mode) -end