Skip to content

Commit 28db3e5

Browse files
Fix code snippets indentation in README.
* README.md
1 parent 27c71bd commit 28db3e5

File tree

1 file changed

+24
-18
lines changed

1 file changed

+24
-18
lines changed

README.md

Lines changed: 24 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,15 @@
77

88
Enforce rules regarding frozen revisions in `.pre-commit-config.yaml`.
99

10+
<!-- prettier-ignore-start -->
1011
```yaml
11-
# Enforce frozen revisions in `.pre-commit-config.yaml`
12-
- repo: https://github.com/real-yfprojects/check-pre-commit-config
13-
rev: v1.0.0-alpha3
14-
hooks:
12+
# Enforce frozen revisions in `.pre-commit-config.yaml`
13+
- repo: https://github.com/real-yfprojects/check-pre-commit-config
14+
rev: v1.0.0-alpha3
15+
hooks:
1516
- id: check-frozen
1617
```
18+
<!-- prettier-ignore-end -->
1719
1820
We advise to put this hook before any yaml formatters (like prettier) that you have configured as well.
1921
@@ -86,31 +88,35 @@ By default `--strict --fix-all` is passed to the underlying script.
8688
You can customize the hooks behaviour by overriding which command line arguments
8789
are passed to the underlying script when the hook is run. The following configuration can be used to prevent frozen revisions from being committed:
8890

91+
<!-- prettier-ignore-start -->
8992
```yaml
90-
# Prevent use of frozen revisions in `.pre-commit-config.yaml`
91-
- repo: https://github.com/real-yfprojects/check-pre-commit-config
92-
rev: v1.0.0-alpha3
93-
hooks:
93+
# Prevent use of frozen revisions in `.pre-commit-config.yaml`
94+
- repo: https://github.com/real-yfprojects/check-pre-commit-config
95+
rev: v1.0.0-alpha3
96+
hooks:
9497
- id: check-frozen
9598
args:
96-
- "--rules"
97-
- "ycue"
98-
- "--fix-all"
99+
- "--rules"
100+
- "ycue"
101+
- "--fix-all"
99102
```
103+
<!-- prettier-ignore-end -->
100104
101105
If you just want to make sure that comments match revisions and that no abbreviated hashes are used the following configuration will be suited:
102106
107+
<!-- prettier-ignore-start -->
103108
```yaml
104-
# Check use of `frozen: xxx` comments in `.pre-commit-config.yaml`
105-
- repo: https://github.com/real-yfprojects/check-pre-commit-config
106-
rev: v1.0.0-alpha3
107-
hooks:
109+
# Check use of `frozen: xxx` comments in `.pre-commit-config.yaml`
110+
- repo: https://github.com/real-yfprojects/check-pre-commit-config
111+
rev: v1.0.0-alpha3
112+
hooks:
108113
- id: check-frozen
109114
args:
110-
- "--rules"
111-
- "ycamet"
112-
- "--fix-all"
115+
- "--rules"
116+
- "ycamet"
117+
- "--fix-all"
113118
```
119+
<!-- prettier-ignore-end -->
114120
115121
## Contributing
116122

0 commit comments

Comments
 (0)