Skip to content

Commit c9b3bd4

Browse files
authored
Add example pre-commit based on this projects own pre-commit-config (#269)
1 parent 3ac5264 commit c9b3bd4

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -166,6 +166,34 @@ jobs:
166166

167167
See the discussion in https://github.com/Scony/godot-gdscript-toolkit/issues/239 for more details.
168168

169+
## Using gdtookit in pre-commit
170+
171+
To add gdtookit as a pre-commit hook check the latest GitHub version (eg `4.2.2`) and add the followingto your `pre-commit-config.yaml` with the latest version.
172+
173+
```Yaml
174+
repos:
175+
# GDScript Toolkit
176+
- repo: https://github.com/Scony/godot-gdscript-toolkit
177+
rev: 4.2.2
178+
hooks:
179+
- id: gdlint
180+
name: gdlint
181+
description: "gdlint - linter for GDScript"
182+
entry: gdlint
183+
language: python
184+
language_version: python3
185+
require_serial: true
186+
types: [gdscript]
187+
- id: gdformat
188+
name: gdformat
189+
description: "gdformat - formatter for GDScript"
190+
entry: gdformat
191+
language: python
192+
language_version: python3
193+
require_serial: true
194+
types: [gdscript]
195+
```
196+
169197
## Development [(more)](https://github.com/Scony/godot-gdscript-toolkit/wiki/5.-Development)
170198
171199
Everyone is free to fix bugs or introduce new features. For that, however, please refer to existing issue or create one before starting implementation.

0 commit comments

Comments
 (0)