Skip to content

Commit 65784e2

Browse files
committed
Update selene docs about pre-commit hook
1 parent 44020ad commit 65784e2

2 files changed

Lines changed: 12 additions & 1 deletion

File tree

docs/src/SUMMARY.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
- [Configuration](./usage/configuration.md)
1111
- [Filtering](./usage/filtering.md)
1212
- [Standard Library Format](./usage/std.md)
13+
- [Version control integration](./usage/version-control-integration.md)
1314
- [Roblox Guide](./roblox.md)
1415
- [Contributing](./contributing.md)
1516
- [Lints](./lints/index.md)
@@ -42,4 +43,4 @@
4243
- [unscoped_variables](./lints/unscoped_variables.md)
4344
- [unused_variable](./lints/unused_variable.md)
4445
- [Archive](./archive/index.md)
45-
- [TOML Standard Library Format](./archive/std_v1.md)
46+
- [TOML Standard Library Format](./archive/std_v1.md)
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
To integrate selene with git, you can use [pre-commit](https://pre-commit.com). Once you have [pre-commit installed](https://pre-commit.com/#install), add this to the `.pre-commit-config.yaml` at root of your repository:
2+
```yaml
3+
repos:
4+
- repo: https://github.com/Kampfkarren/selene
5+
rev: '' # Change this value to use a different version of Selene
6+
hooks:
7+
- id: selene-system # Use the selene binary already present on system path
8+
- id: selene-docker # To use docker to run the hook, needs docker to be present
9+
```
10+
You need to mention only one of the two hooks ids depending upon if you already have the binary available or not on your system path.

0 commit comments

Comments
 (0)