nils/gluon
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
rubo77 2019-06-24 04:41:02 +02:00 committed by Martin Weinelt
parent a8e5a82215
commit 2541d0a0e2
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/dev/basics.rst
View File

@ -54,16 +54,18 @@ commits, making `git reflog` the only way to recover them!
Development Guidelines 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: should be considered:
- Is the script doing more than just executing external commands? if so, use lua - 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 parsing/editing json-data? If so, use Lua for speed
- When using sh, use jsonfilter instead of json_* functions 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 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: apply:
- use tabs instead of spaces - use tabs instead of spaces
- trailing whitespaces must be eliminated - trailing whitespaces must be eliminated
If you add Lua scripts to gluon, check formatting with ``luacheck``.