fix: Releases, port to new scripts
"+ Releases used the lib/ folder instead of a darklua processed dist/ folder, leading to them using unsupported string requires" -m "+ Port lune scripts to new, more awesome and strictly typed scripts" -m "+ Bump to and release v0.1.1"
This commit is contained in:
parent
655d47274e
commit
f30b3b677d
21 changed files with 2671 additions and 64 deletions
161
.lune/.lune-defs/stdio.luau
Normal file
161
.lune/.lune-defs/stdio.luau
Normal file
|
@ -0,0 +1,161 @@
|
|||
export type Color =
|
||||
"reset"
|
||||
| "black"
|
||||
| "red"
|
||||
| "green"
|
||||
| "yellow"
|
||||
| "blue"
|
||||
| "purple"
|
||||
| "cyan"
|
||||
| "white"
|
||||
export type Style = "reset" | "bold" | "dim"
|
||||
|
||||
type PromptFn = (
|
||||
(() -> string)
|
||||
& ((kind: "text", message: string?, defaultOrOptions: string?) -> string)
|
||||
& ((kind: "confirm", message: string, defaultOrOptions: boolean?) -> boolean)
|
||||
& ((kind: "select", message: string?, defaultOrOptions: { string }) -> number?)
|
||||
& ((kind: "multiselect", message: string?, defaultOrOptions: { string }) -> { number }?)
|
||||
)
|
||||
|
||||
--[=[
|
||||
@within Stdio
|
||||
@function prompt
|
||||
@tag must_use
|
||||
|
||||
Prompts for user input using the wanted kind of prompt:
|
||||
|
||||
* `"text"` - Prompts for a plain text string from the user
|
||||
* `"confirm"` - Prompts the user to confirm with y / n (yes / no)
|
||||
* `"select"` - Prompts the user to select *one* value from a list
|
||||
* `"multiselect"` - Prompts the user to select *one or more* values from a list
|
||||
* `nil` - Equivalent to `"text"` with no extra arguments
|
||||
|
||||
@param kind The kind of prompt to use
|
||||
@param message The message to show the user
|
||||
@param defaultOrOptions The default value for the prompt, or options to choose from for selection prompts
|
||||
]=]
|
||||
local prompt: PromptFn = function(kind: any, message: any, defaultOrOptions: any)
|
||||
return nil :: any
|
||||
end
|
||||
|
||||
--[=[
|
||||
@class Stdio
|
||||
|
||||
Built-in standard input / output & utility functions
|
||||
|
||||
### Example usage
|
||||
|
||||
```lua
|
||||
local stdio = require("@lune/stdio")
|
||||
|
||||
-- Prompting the user for basic input
|
||||
local text: string = stdio.prompt("text", "Please write some text")
|
||||
local confirmed: boolean = stdio.prompt("confirm", "Please confirm this action")
|
||||
|
||||
-- Writing directly to stdout or stderr, without the auto-formatting of print/warn/error
|
||||
stdio.write("Hello, ")
|
||||
stdio.write("World! ")
|
||||
stdio.write("All on the same line")
|
||||
stdio.ewrite("\nAnd some error text, too")
|
||||
|
||||
-- Reading the entire input from stdin
|
||||
local input = stdio.readToEnd()
|
||||
```
|
||||
]=]
|
||||
local stdio = {}
|
||||
|
||||
stdio.prompt = prompt
|
||||
|
||||
--[=[
|
||||
@within Stdio
|
||||
@tag must_use
|
||||
|
||||
Return an ANSI string that can be used to modify the persistent output color.
|
||||
|
||||
Pass `"reset"` to get a string that can reset the persistent output color.
|
||||
|
||||
### Example usage
|
||||
|
||||
```lua
|
||||
stdio.write(stdio.color("red"))
|
||||
print("This text will be red")
|
||||
stdio.write(stdio.color("reset"))
|
||||
print("This text will be normal")
|
||||
```
|
||||
|
||||
@param color The color to use
|
||||
@return A printable ANSI string
|
||||
]=]
|
||||
function stdio.color(color: Color): string
|
||||
return nil :: any
|
||||
end
|
||||
|
||||
--[=[
|
||||
@within Stdio
|
||||
@tag must_use
|
||||
|
||||
Return an ANSI string that can be used to modify the persistent output style.
|
||||
|
||||
Pass `"reset"` to get a string that can reset the persistent output style.
|
||||
|
||||
### Example usage
|
||||
|
||||
```lua
|
||||
stdio.write(stdio.style("bold"))
|
||||
print("This text will be bold")
|
||||
stdio.write(stdio.style("reset"))
|
||||
print("This text will be normal")
|
||||
```
|
||||
|
||||
@param style The style to use
|
||||
@return A printable ANSI string
|
||||
]=]
|
||||
function stdio.style(style: Style): string
|
||||
return nil :: any
|
||||
end
|
||||
|
||||
--[=[
|
||||
@within Stdio
|
||||
@tag must_use
|
||||
|
||||
Formats arguments into a human-readable string with syntax highlighting for tables.
|
||||
|
||||
@param ... The values to format
|
||||
@return The formatted string
|
||||
]=]
|
||||
function stdio.format(...: any): string
|
||||
return nil :: any
|
||||
end
|
||||
|
||||
--[=[
|
||||
@within Stdio
|
||||
|
||||
Writes a string directly to stdout, without any newline.
|
||||
|
||||
@param s The string to write to stdout
|
||||
]=]
|
||||
function stdio.write(s: string) end
|
||||
|
||||
--[=[
|
||||
@within Stdio
|
||||
|
||||
Writes a string directly to stderr, without any newline.
|
||||
|
||||
@param s The string to write to stderr
|
||||
]=]
|
||||
function stdio.ewrite(s: string) end
|
||||
|
||||
--[=[
|
||||
@within Stdio
|
||||
@tag must_use
|
||||
|
||||
Reads the entire input from stdin.
|
||||
|
||||
@return The input from stdin
|
||||
]=]
|
||||
function stdio.readToEnd(): string
|
||||
return nil :: any
|
||||
end
|
||||
|
||||
return stdio
|
Loading…
Add table
Add a link
Reference in a new issue