mirror of
https://github.com/lune-org/lune.git
synced 2024-12-12 21:10:36 +00:00
190 lines
4.5 KiB
Markdown
190 lines
4.5 KiB
Markdown
<!-- markdownlint-disable MD033 -->
|
|
|
|
# Lune 🌙
|
|
|
|
[](https://github.com/filiptibell/lune/actions/workflows/ci.yaml)
|
|
[](https://github.com/filiptibell/lune/actions/workflows/release.yaml)
|
|
|
|
A [Luau](https://luau-lang.org) script runner
|
|
|
|
---
|
|
|
|
🚀 Use the ergonomics and readability of Luau instead of shell scripts 🚀
|
|
|
|
[Full example & walkthrough](.lune/hello_lune.luau)
|
|
|
|
## ⚙️ Installation
|
|
|
|
The preferred way of installing Lune is using [Aftman](https://github.com/lpghatguy/aftman).
|
|
|
|
This will add `lune` to an `aftman.toml` file in the current directory, or create one if it does not exist:
|
|
|
|
```sh
|
|
aftman add filiptibell/lune
|
|
```
|
|
|
|
You can also download pre-built binaries for most systems directly from the GitHub Releases page.
|
|
|
|
## ✏️ Writing Lune Scripts
|
|
|
|
Check out the examples of how to write a script in the [.lune](.lune) folder !
|
|
|
|
<details>
|
|
<summary><b>🔎 Full list of APIs</b></summary>
|
|
|
|
<details>
|
|
<summary><b>console</b> - Logging & formatting</summary>
|
|
|
|
```lua
|
|
type console = {
|
|
resetColor: () -> (),
|
|
setColor: (color: "black" | "red" | "green" | "yellow" | "blue" | "purple" | "cyan" | "white") -> (),
|
|
resetStyle: () -> (),
|
|
setStyle: (color: "bold" | "dim") -> (),
|
|
format: (...any) -> (string),
|
|
log: (...any) -> (),
|
|
info: (...any) -> (),
|
|
warn: (...any) -> (),
|
|
error: (...any) -> (),
|
|
}
|
|
```
|
|
|
|
</details>
|
|
|
|
<details>
|
|
<summary><b>fs</b> - Filesystem</summary>
|
|
|
|
```lua
|
|
type fs = {
|
|
readFile: (path: string) -> string,
|
|
readDir: (path: string) -> { string },
|
|
writeFile: (path: string, contents: string) -> (),
|
|
writeDir: (path: string) -> (),
|
|
removeFile: (path: string) -> (),
|
|
removeDir: (path: string) -> (),
|
|
isFile: (path: string) -> boolean,
|
|
isDir: (path: string) -> boolean,
|
|
}
|
|
```
|
|
|
|
</details>
|
|
|
|
<details>
|
|
<summary><b>net</b> - Networking</summary>
|
|
|
|
```lua
|
|
type net = {
|
|
request: (config: string | {
|
|
url: string,
|
|
method: ("GET" | "POST" | "PUT" | "DELETE" | "HEAD" | "OPTIONS" | "PATCH")?,
|
|
headers: { [string]: string }?,
|
|
body: string?,
|
|
}) -> {
|
|
ok: boolean,
|
|
statusCode: number,
|
|
statusMessage: string,
|
|
headers: { [string]: string },
|
|
body: string,
|
|
},
|
|
jsonEncode: (value: any, pretty: boolean?) -> string,
|
|
jsonDecode: (encoded: string) -> any,
|
|
}
|
|
```
|
|
|
|
</details>
|
|
|
|
<details>
|
|
<summary><b>process</b> - Current process & child processes</summary>
|
|
|
|
```lua
|
|
type process = {
|
|
args: { string },
|
|
env: { [string]: string? },
|
|
exit: (code: number?) -> (),
|
|
spawn: (program: string, params: { string }?) -> {
|
|
ok: boolean,
|
|
code: number,
|
|
stdout: string,
|
|
stderr: string,
|
|
},
|
|
}
|
|
```
|
|
|
|
</details>
|
|
|
|
</details>
|
|
|
|
<details>
|
|
<summary><b>🔀 Example translation from Bash</b></summary>
|
|
|
|
```bash
|
|
#!/bin/bash
|
|
VALID=true
|
|
COUNT=1
|
|
while [ $VALID ]
|
|
do
|
|
echo $COUNT
|
|
if [ $COUNT -eq 5 ];
|
|
then
|
|
break
|
|
fi
|
|
((COUNT++))
|
|
done
|
|
```
|
|
|
|
**_With Lune & Luau:_**
|
|
|
|
```lua
|
|
local valid = true
|
|
local count = 1
|
|
while valid do
|
|
print(count)
|
|
if count == 5 then
|
|
break
|
|
end
|
|
count += 1
|
|
end
|
|
```
|
|
|
|
</details>
|
|
|
|
<details>
|
|
<summary><b>🧑💻 Configuring VSCode for Lune</b></summary>
|
|
|
|
Lune puts developer experience first, and as such provides type definitions and configurations for several tools out of the box.
|
|
|
|
<details>
|
|
<summary>Luau LSP</summary>
|
|
|
|
1. Use `lune --download-luau-types` to download Luau types (`luneTypes.d.luau`) to the current directory
|
|
2. Set your definition files setting to include `luneTypes.d.luau`, an example can be found in the [.vscode](.vscode) folder in this repository
|
|
|
|
</details>
|
|
|
|
<details>
|
|
<summary>Selene</summary>
|
|
|
|
1. Use `lune --download-selene-types` to download Selene types (`lune.yml`) to the current directory
|
|
2. Use either `std = "roblox-lune"` or `std = "luau+lune"` in your `selene.toml` configuration file
|
|
|
|
</details>
|
|
|
|
**_NOTE:_** _It is highly recommended to add any type definition files to your `.gitignore` and to only download them using these commands, since this guarantees that you have type definitions compatible with your installed version of Lune._
|
|
|
|
</details>
|
|
|
|
## 🏃 Running Lune Scripts
|
|
|
|
When you've written a script with either a `.lua` or `.luau` extension, you can run it:
|
|
|
|
```sh
|
|
lune script-name
|
|
```
|
|
|
|
This will look for the script `script-name` in a few locations:
|
|
|
|
- The current directory
|
|
- The folder `lune` in the current directory, if it exists
|
|
- The folder `.lune` in the current directory, if it exists
|
|
|
|
If you don't want Lune to look in sub-directories you can provide a full file path with the file extension included, instead of only the file name.
|