Skip to content

Commit b17994d

Browse files
feat: adding pre-commit-hooks.yaml (#858)
Co-authored-by: Alexander Fenster <fenster@google.com>
1 parent ffb3e2c commit b17994d

File tree

2 files changed

+21
-0
lines changed

2 files changed

+21
-0
lines changed

.pre-commit-hooks.yaml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
- id: gts
2+
name: gts
3+
description: 'gts: TypeScript style guide, formatter, and linter.'
4+
entry: gts lint
5+
language: node
6+
language_version: system
7+
minimum_pre_commit_version: 2.9.2
8+
require_serial: true
9+
types_or: [javascript, jsx, ts, tsx]

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,18 @@ Show your love for `gts` and include a badge!
7777
## Supported Node.js Versions
7878
Our client libraries follow the [Node.js release schedule](https://nodejs.org/en/about/releases/). Libraries are compatible with all current _active_ and _maintenance_ versions of Node.js.
7979

80+
## Can I use *gts* with the [pre-commit](https://pre-commit.com/) framework?
81+
82+
Yes! You can put the following in your `.pre-commit-config.yaml` file:
83+
84+
```yaml
85+
repos:
86+
- repo: https://github.com/google/gts
87+
rev: '' # Use the sha / tag you want to point at
88+
hooks:
89+
- id: gts
90+
```
91+
8092
## License
8193
[Apache-2.0](LICENSE)
8294

0 commit comments

Comments
 (0)