Skip to content
Snippets Groups Projects
Commit 2541d0a0 authored by rubo77's avatar rubo77 Committed by Martin Weinelt
Browse files

docs: Add information how to automatically check your code with luacheck

parent a8e5a822
No related branches found
No related tags found
No related merge requests found
......@@ -54,16 +54,18 @@ commits, making `git reflog` the only way to recover them!
Development Guidelines
----------------------
lua should be used instead of sh whenever sensible. The following criteria
Lua should be used instead of sh whenever sensible. The following criteria
should be considered:
- Is the script doing more than just executing external commands? if so, use lua
- Is the script parsing/editing json-data? If so, use lua for speed
- Is the script doing more than just executing external commands? if so, use Lua
- Is the script parsing/editing json-data? If so, use Lua for speed
- When using sh, use jsonfilter instead of json_* functions for speed
Code formatting may sound like a topic for the pedantic, however it helps if
the code in the project is formatted in the same way. The following rules
the code in the project is formatted in the same way. The following basic rules
apply:
- use tabs instead of spaces
- trailing whitespaces must be eliminated
If you add Lua scripts to gluon, check formatting with ``luacheck``.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment