From 2541d0a0e280f70da4aa3250541754eab1693c00 Mon Sep 17 00:00:00 2001 From: rubo77 Date: Mon, 24 Jun 2019 04:41:02 +0200 Subject: [PATCH] docs: Add information how to automatically check your code with luacheck --- docs/dev/basics.rst | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/dev/basics.rst b/docs/dev/basics.rst index 7fcc2d7c..18aec227 100644 --- a/docs/dev/basics.rst +++ b/docs/dev/basics.rst @@ -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``.