gdlint-plugin/README.md

22 lines
679 B
Markdown

# gdLint Plugin
A bare-bones plugin to run gdLint in Godot 4.x.
## Setup
Install [gdscript-toolkit](https://github.com/Scony/godot-gdscript-toolkit).
If you install the toolkit in a venv, you may want to edit
`run_linter.gd` to set the path to the `gdlint` binary
(e.g. `venv/bin/gdlint`). That way, you won't have to run Godot
through a venv just to use `gdlint`.
## About
This is an extremely simple implementation -- the plugin runs `gdlint`
on save, and raises any errors as warnings.
If you want more full-featured linter integration, check out
[el-falso/gdlinter](https://github.com/el-falso/gdlinter). When I
wrote this plugin, it wasn't being actively maintained.