🚧 Not Actively Maintained 🚧
Please note that this plugin is currently unfinished. We don't recommend it for production use.
Prettier is an opinionated code formatter. It enforces a consistent style by parsing your code and re-printing it with its own rules that take the maximum line length into account, wrapping code when necessary.
This plugin adds support for the Lua language to Prettier.
function deepcopy(orig) local orig_type = type(orig) local copy if orig_type == 'table' then; copy = {} for orig_key, orig_value in next, orig, nil do copy[deepcopy(orig_key)] = deepcopy(orig_value) end setmetatable( copy, deepcopy( getmetatable(orig))) else copy = orig end return copy end
function deepcopy(orig) local orig_type = type(orig) local copy if orig_type == "table" then copy = {} for orig_key, orig_value in next, orig, nil do copy[deepcopy(orig_key)] = deepcopy(orig_value) end setmetatable(copy, deepcopy(getmetatable(orig))) else copy = orig end return copy end
yarn:
yarn add --dev prettier @prettier/plugin-lua # or globally yarn global add prettier @prettier/plugin-lua
npm:
npm install --save-dev prettier @prettier/plugin-lua # or globally npm install --global prettier @prettier/plugin-lua
If you installed prettier as a local dependency, you can add prettier as a script in your package.json
,
"scripts": { "prettier": "prettier" }
also add it as a plugin to your prettierrc,
"plugins": [ "@prettier/plugin-lua" ]
and then run it via
yarn run prettier path/to/file.lua --write # or npm run prettier -- path/to/file.lua --write
If you installed globally, run
prettier path/to/file.lua --write
Integration in the prettier plugin for your favorite editor might not be working yet, see the related issues for VS Code, Atom and Vim.
For the moment, you can set up prettier to run on save like this:
Install save-autorun and create a .save.cson
file in your project with the following content:
"**/*.lua": "prettier ${path} --write"
Install Run on Save and add the following section to your settings:
"emeraldwalk.runonsave": { "commands": [ { "match": "\\.lua$", "cmd": "prettier ${file} --write" } ] }
Adding the following to .vimrc
will define a custom command :PrettierLua
that runs the plugin while preserving the cursor position and run it on save.
" Prettier for Lua function PrettierLuaCursor() let save_pos = getpos(".") %! prettier --stdin --parser=lua call setpos('.', save_pos) endfunction " define custom command command PrettierLua call PrettierLuaCursor() " format on save autocmd BufwritePre *.lua PrettierLua
Install JsPrettier using Package Control and add the following to your <project_name>.sublime-project
project-level file:
{
"settings": {
"js_prettier": {
"auto_format_on_save": true,
"custom_file_extensions": ["lua"],
}
}
}
Alternatively, "custom_file_extensions": ["lua"]
can be added to the JsPrettier plugin user settings.
If you're interested in contributing to the development of Prettier for Lua, you can follow the CONTRIBUTING guide from Prettier, as it all applies to this repository too.
To test it out on a Lua file:
yarn
.test.lua
.yarn prettier test.lua
to check the output.RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4