Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/trixnz/lua-fmt
lua-fmt is pretty-printer for Lua code
https://github.com/trixnz/lua-fmt
formatter lua pretty-printer typescript
Last synced: 11 days ago
JSON representation
lua-fmt is pretty-printer for Lua code
- Host: GitHub
- URL: https://github.com/trixnz/lua-fmt
- Owner: trixnz
- License: mit
- Created: 2017-03-21T20:50:35.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-09-06T00:21:13.000Z (almost 5 years ago)
- Last Synced: 2024-05-31T18:17:34.627Z (27 days ago)
- Topics: formatter, lua, pretty-printer, typescript
- Language: Lua
- Size: 169 KB
- Stars: 186
- Watchers: 7
- Forks: 24
- Open Issues: 27
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-stars - trixnz/lua-fmt - lua-fmt is pretty-printer for Lua code (Lua)
- awesome-stars - trixnz/lua-fmt - lua-fmt is pretty-printer for Lua code (Lua)
README
[](https://travis-ci.org/trixnz/lua-fmt) [](https://www.npmjs.com/package/lua-fmt)
# Code Formatter for Lua
`lua-fmt` is pretty-printer for [Lua](https://www.lua.org/) code, written in [TypeScript](https://www.typescriptlang.org/) and deeply inspired by [prettier](https://github.com/prettier/prettier). `lua-fmt` provides an interface to format Lua code that conforms to a single and consistent standard.
While not implemented yet, the interface will be customizable to tailor the output to the user's preferences: linebreaks, string style, etc.
## Installing
* `npm install lua-fmt`
## Usage
### API
```TypeScript
import {formatText} from 'lua-fmt';
console.log(formatText('local hello = "Hello"; print(hello .. " world!")'))
```
### Command Line
Format a single file:
* `luafmt test/lua-5.3.4-tests/calls.lua`
Format a stream from `stdin`:
* `cat test/lua-5.3.4-tests/calls.lua | luafmt --stdin`
## TODO
- [ ] Add support for a `.luafmt` preferences file
## Testing
`lua-fmt` uses [jest](https://facebook.github.io/jest/) for automated testing.
Among the user-created tests in the `test/` folder, a copy of the `lua-5.3.4` tests are executed after formatting to ensure the code remains syntactically correct after formatting. For this reason, please do not modify the `lua-5.3.4-tests` folder unless updating with new tests from the official Lua tests. To run these tests, `lua53` is expected to be available on the `PATH`.
When contributing changes, please consider writing tests to ensure they do not regress.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Acknowledgments
* [Oskar Schöldström](https://github.com/oxyc) - [luaparse](https://github.com/oxyc/luaparse): A Lua parser written in JavaScript
* [Christopher Chedeau](https://github.com/vjeux) - [prettier](https://github.com/prettier/prettier): Prettier is an opinionated JavaScript formatter.
* [Ben Newman](https://github.com/benjamn) - [recast](https://github.com/benjamn/recast): JavaScript syntax tree transformer, nondestructive pretty-printer, and automatic source map generator.