Tools: scripts: add lua language check and docs generation

Tools/scripts/generate_lua_docs.sh

@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+# Generate md file from lua docs with lua-language-sever
+
+cd "$(dirname "$0")"
+cd ../..
+
+if [ -n "$(ls -A lualogs)" ]; then
+    echo "lualogs Not Empty"
+    exit 1
+fi
+
+# Need to use abs paths due to lua-language-sever bug
+CONFIG_PATH=$(realpath libraries/AP_Scripting/tests/docs.json)
+DOC_PATH=$(realpath libraries/AP_Scripting/docs/)
+
+lua-language-server --configpath ${CONFIG_PATH}  --logpath lualogs --doc ${DOC_PATH}
+
+mv lualogs/doc.md ScriptingDocs.md
+rm -r lualogs

Tools/scripts/run_lua_language_check.py

@@ -0,0 +1,105 @@
+'''
+Reads lua-language-sever check
+
+It generates a json report that this then parses to make it look nicer
+
+AP_FLAKE8_CLEAN
+'''
+
+import optparse
+import sys
+import os
+import pathlib
+import json
+import shutil
+from urllib.parse import unquote
+
+
+def print_failures(file_name, fails):
+    file_name = unquote(file_name)
+    file_path = pathlib.Path(file_name[5:])
+
+    for fail in fails:
+        start = fail['range']['start']
+
+        # These seem to be off by one, not sure why
+        line = start['line'] + 1
+        character = start['character'] + 1
+
+        print("%s:%i:%i" % (file_path, line, character))
+
+        print("\tCode: %s" % fail['code'])
+        message = fail['message'].split("\n")
+        for line in message:
+            print("\t%s" % line)
+
+    print()
+    return len(fails)
+
+
+if __name__ == '__main__':
+
+    parser = optparse.OptionParser(__file__)
+
+    opts, args = parser.parse_args()
+
+    if len(args) > 1:
+        print('Usage: %s "check path"' % parser.usage)
+        sys.exit(0)
+
+    check_path = "./"
+    if len(args) > 0:
+        check_path = args[0]
+
+    if not os.path.exists(check_path):
+        raise Exception("Path invalid: %s" % check_path)
+
+    # Work out full path to config file
+    ap_root = (pathlib.Path(__file__) / "../../../").resolve()
+    setup = (ap_root / "libraries/AP_Scripting/tests/check.json").resolve()
+    logs = (ap_root / "lualogs").resolve()
+    docs = (ap_root / "libraries/AP_Scripting/docs/docs.lua").resolve()
+
+    # Make sure the log directory is empty
+    if os.path.exists(logs) and len(os.listdir(logs)) != 0:
+        raise Exception("lualogs not empty")
+
+    # Can't get the lua-language-server to find docs outside of workspace, so just copy in and then delete
+    docs_check_path = (pathlib.Path(os.getcwd()) / check_path).resolve()
+    if os.path.isfile(docs_check_path):
+        docs_check_path = (docs_check_path / "../").resolve()
+
+    docs_copy = None
+    if not docs.is_relative_to(docs_check_path):
+        docs_copy = (docs_check_path / "docs.lua").resolve()
+
+    if docs_copy is not None:
+        # make copy of docs
+        shutil.copyfile(docs, docs_copy)
+
+    # Run check
+    os.system("lua-language-server --configpath %s --logpath %s --check %s" % (setup, logs, check_path))
+
+    if docs_copy is not None:
+        # remove copy of docs
+        os.remove(docs_copy)
+
+    # Read output
+    errors = 0
+    result = (logs / "check.json").resolve()
+    if os.path.exists(result):
+        # File only created if there are errors
+        f = open((logs / "check.json").resolve())
+        data = json.load(f)
+        f.close()
+
+        # Print output
+        for key, value in data.items():
+            errors += print_failures(key, value)
+
+    # Remove output
+    shutil.rmtree(logs)
+
+    # Rase error if detected
+    if errors != 0:
+        raise Exception("Detected %i errors" % errors)