aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSun Howwrongbum <sun@libermatic.com>2022-01-01 16:32:25 +0530
committerSun Howwrongbum <sun@libermatic.com>2022-01-01 16:32:25 +0530
commita30e419820ce40f209c674650477bae1947d85ec (patch)
tree10d2e89b26b64b7f117ca58954052edc0ab57d6a
parentac64dba0a21b50aa2090f2ff7f20bc64f7b8256f (diff)
downloadtrackermap-server-a30e419820ce40f209c674650477bae1947d85ec.tar.gz
trackermap-server-a30e419820ce40f209c674650477bae1947d85ec.tar.bz2
trackermap-server-a30e419820ce40f209c674650477bae1947d85ec.zip
docs: refactor config keys generation
-rw-r--r--tools/gen_config_doc.py66
1 files changed, 43 insertions, 23 deletions
diff --git a/tools/gen_config_doc.py b/tools/gen_config_doc.py
index e309da942..caedba577 100644
--- a/tools/gen_config_doc.py
+++ b/tools/gen_config_doc.py
@@ -8,50 +8,70 @@ _KEYS_FILE = os.path.join(
os.path.dirname(__file__), "../src/main/java/org/traccar/config/Keys.java"
)
-def get_config_key_descriptions():
+
+def get_config_keys():
+ """Parses Keys.java to extract keys to be used in configuration files
+
+ Args: None
+
+ Returns:
+ list: A list of dict containing the following keys -
+ 'key': A dot separated name of the config key
+ 'description': A list of str
+ """
desc_re = re.compile(r"(/\*\*\n|\s+\*/|\s+\*)")
key_match_re = re.compile(r"\(\n(.+)\);", re.DOTALL)
key_split_re = re.compile(r",\s+", re.DOTALL)
- snippets = []
+ keys = []
with open(_KEYS_FILE, "r") as f:
- code = f.read()
config = re.findall(
- r"(/\*\*.*?\*/)\n\s+(public static final Config.*?;)", code, re.DOTALL
+ r"(/\*\*.*?\*/)\n\s+(public static final Config.*?;)", f.read(), re.DOTALL
)
for i in config:
try:
key_match = key_match_re.search(i[1])
if key_match:
- description = "<br /> ".join(
- [
- x.strip().replace("\n", "")
- for x in desc_re.sub("\n", i[0]).strip().split("\n\n")
- ]
- )
terms = [x.strip() for x in key_split_re.split(key_match.group(1))]
key = terms[0].replace('"', "")
- default = terms[2] if len(terms) == 3 else None
- snippets.append(
- f""" <div class="card mt-3">
+ description = [
+ x.strip().replace("\n", "")
+ for x in desc_re.sub("\n", i[0]).strip().split("\n\n")
+ ]
+ if len(terms) == 3:
+ description.append(f"Default: {terms[2]}")
+ keys.append(
+ {
+ "key": key,
+ "description": description,
+ }
+ )
+ except IndexError:
+ # will continue if key_match.group(1) or terms[0] does not exist
+ # for some reason
+ pass
+
+ return keys
+
+
+def get_html():
+ return ("\n").join(
+ [
+ f""" <div class="card mt-3">
<div class="card-body">
<h5 class="card-title">
- {key} <span class="badge badge-dark">config</span>
+ {x["key"]} <span class="badge badge-dark">config</span>
</h5>
<p class="card-text">
- {description}{f"<br/ > Default: {default}." if default else ""}
+ {"<br /> ".join(x["description"])}
</p>
</div>
</div>"""
- )
- except IndexError:
- # will continue if key_match.group(1) or terms[0] does not exist
- # for some reason
- pass
-
- return ("\n").join(snippets)
+ for x in get_config_keys()
+ ]
+ )
if __name__ == "__main__":
- html = get_config_key_descriptions()
+ html = get_html()
print(html)