https://github.com/wasm-fmt/lua_fmt
A WASM Based Lua Formatter
https://github.com/wasm-fmt/lua_fmt
Last synced: 4 months ago
JSON representation
A WASM Based Lua Formatter
- Host: GitHub
- URL: https://github.com/wasm-fmt/lua_fmt
- Owner: wasm-fmt
- License: mit
- Created: 2024-02-29T15:58:13.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-10T16:46:24.000Z (over 1 year ago)
- Last Synced: 2025-04-10T18:08:37.212Z (over 1 year ago)
- Language: Rust
- Homepage:
- Size: 160 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/wasm-fmt/lua_fmt/actions/workflows/test.yml)
# Install
[](https://www.npmjs.com/package/@wasm-fmt/lua_fmt)
```bash
npm install @wasm-fmt/lua_fmt
```
[](https://jsr.io/@fmt/lua-fmt)
```bash
npx jsr add @fmt/lua-fmt
```
# Usage
## Node.js / Deno / Bun / Bundler
```javascript
import { format } from "@wasm-fmt/lua_fmt";
const input = `print "Hello World"`;
const formatted = format(input);
console.log(formatted);
```
## Web
For web environments, you need to initialize WASM module manually:
```javascript
import init, { format } from "@wasm-fmt/lua_fmt/web";
await init();
const input = `print "Hello World"`;
const formatted = format(input);
console.log(formatted);
```
### Vite
```JavaScript
import init, { format } from "@wasm-fmt/lua_fmt/vite";
await init();
// ...
```
Or use the `./bundler` entry with [vite-plugin-wasm](https://www.npmjs.com/package/vite-plugin-wasm)
```javascript
import { format } from "@wasm-fmt/lua_fmt/bundler";
```
## Entry Points
- `.` - Auto-detects environment (Node.js uses node, Webpack uses bundler, default is ESM)
- `./node` - Node.js environment (no init required)
- `./esm` - ESM environments like Deno (no init required)
- `./bundler` - Bundlers like Webpack (no init required)
- `./web` - Web browsers (requires manual init)
- `./vite` - Vite bundler (requires manual init)
# Credits
Thanks to:
- The [StyLua](https://github.com/JohnnyMorganz/StyLua) project created by [@JohnnyMorganz](https://github.com/JohnnyMorganz)