This project provides a set of tools for daily work with GDScript. At the moment it provides:
- A parser that produces a parse tree for debugging and educational purposes.
- A linter that performs a static analysis according to some predefined configuration.
- A formatter that formats the code according to some predefined rules.
To install this project you need python3 and pip.
Use this command to install gdtoolkit for Godot 3 from PyPI repository:
pip3 install 'gdtoolkit==3.*'
Alternatively, you can install latest (potentially unstable) version directly from git:
pip3 install git+https://github.com/Scony/godot-gdscript-toolkit.git
Linting with gdlint (more)
To run a linter you need to execute gdlint command like:
$ gdlint misc/MarkovianPCG.gd
Which outputs messages like:
misc/MarkovianPCG.gd:96: Error: Function argument name "aOrigin" is not valid (function-argument-name)
misc/MarkovianPCG.gd:96: Error: Function argument name "aPos" is not valid (function-argument-name)
Formatting with gdformat (more)
Formatting may lead to data loss, so it's highly recommended to use it along with Version Control System (VCS) e.g. git
To run a formatter you need to execute gdformat on the file you want to format. So, given a test.gd file:
class X:
var x=[1,2,{'a':1}]
var y=[1,2,3,] # trailing comma
func foo(a:int,b,c=[1,2,3]):
if a in c and \
b > 100:
print('foo')
func bar():
print('bar')
when you execute gdformat test.gd command, the test.gd file will be reformatted as follows:
class X:
var x = [1, 2, {'a': 1}]
var y = [
1,
2,
3,
] # trailing comma
func foo(a: int, b, c = [1, 2, 3]):
if a in c and b > 100:
print('foo')
func bar():
print('bar')
Parsing with gdparse (more)
To run a parser you need to execute the gdparse command like:
gdparse tests/valid-gd-scripts/recursive_tool.gd -p
The parser outputs a tree that represents your code's structure:
start
class_def
X
class_body
tool_stmt
signal_stmt sss
class_def
Y
class_body
tool_stmt
signal_stmt sss
tool_stmt
Development (more)
Everyone is free to fix bugs or introduce new features. For that, however, please refer to existing issue or create one before starting implementation.