Skip to content

Commit f1286ab

Browse files
committed
Update README
1 parent 3683735 commit f1286ab

1 file changed

Lines changed: 7 additions & 16 deletions

File tree

README.md

Lines changed: 7 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,21 @@
11
# pre-commit-jsonnet
2-
[![lint and tests](https://github.com/cybozu-private/pre-commit-jsonnet/actions/workflows/lint_and_tests.yml/badge.svg)](https://github.com/cybozu-private/pre-commit-jsonnet/actions/workflows/lint_and_tests.yml)
2+
[![lint and tests](https://github.com/cybozu/pre-commit-jsonnet/actions/workflows/lint_and_tests.yml/badge.svg)](https://github.com/cybozu/pre-commit-jsonnet/actions/workflows/lint_and_tests.yml)
33

4-
`jsonnet-lint`, `jsonnetfmt` を実行する pre-commit hooks
4+
[pre-commit](https://pre-commit.com/) hooks for [jsonnet](https://jsonnet.org/).
55

66

77
## Usage
88

99
### Configurations
10-
pre-commit hooks を適用したいリポジトリの `.pre-commit-config.yaml` に以下のような記載を追加する:
10+
Add this to your `.pre-commit-config.yaml`:
1111

1212
```yaml
1313
repos:
14-
- repo: https://github.com/cybozu-private/pre-commit-jsonnet
15-
rev: HEAD
14+
- repo: https://github.com/cybozu/pre-commit-jsonnet
15+
rev: v0.1.0
1616
hooks:
1717
- id: jsonnet-fmt
18-
args: ["--test"] # commit 時に書き換えたい場合は --test を外し -i を追加する
18+
args: ["--test"] # you can use arbitrary options of jsonnetfmt command
1919
- id: jsonnet-lint
20-
args: ["--jpath", "lib/"] # --jpath に指定するディレクトリは適宜書き換える。不要な場合は削除する。
21-
```
22-
23-
`rev` は `pre-commit autoupdate` を実行することで最新の commit hash に更新出来る。
24-
25-
### Install hooks
26-
`.pre-commit-config.yaml` を配置したリポジトリで以下を実行する:
27-
28-
```
29-
pre-commit install
20+
args: ["--jpath", "lib/"] # you can use arbitrary options of jsonnet-lint command
3021
```

0 commit comments

Comments
 (0)