Skip to content

Commit

Permalink
Use repo's own hooks on itself
Browse files Browse the repository at this point in the history
  • Loading branch information
Chris Gilmer committed Nov 6, 2019
1 parent c2e68f2 commit 6068abd
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 19 deletions.
6 changes: 6 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,9 @@ repos:
hooks:
- id: markdownlint
entry: markdownlint --ignore .github/*.md

- repo: git://github.com/trussworks/pre-commit-hooks
rev: v0.0.1
hooks:
- id: markdown-toc
- id: mdspell
13 changes: 13 additions & 0 deletions .spelling
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
CircleCI
adr-log
circleci-validate
config
markdown-toc
mdspell
pre-commit
pre-commit-circleci-validate
pre-commit-gen-docs
pre-commit-markdown-toc
pre-commit-mdspell
repo
yaml
28 changes: 9 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@

<!-- toc -->

* [pre-commit-circleci-validate](#pre-commit-circleci-validate)
* [pre-commit-gen-docs](#pre-commit-gen-docs)
* [pre-commit-markdown-toc](#pre-commit-markdown-toc)
* [pre-commit-mdspell](#pre-commit-mdspell)
* [circleci-validate](#circleci-validate)
* [gen-docs](#gen-docs)
* [markdown-toc](#markdown-toc)
* [mdspell](#mdspell)

Regenerate with "scripts/pre-commit-markdown-toc"
Regenerate with "pre-commit run -a markdown-toc"

<!-- tocstop -->

Expand All @@ -25,23 +25,13 @@ on CircleCI and it will be a no-op.

## gen-docs

Generate a Docs Index using [adr-log](https://www.npmjs.com/package/adr-log). It will modify files with this
code in it:

```md
<!-- adrlog -->
<!-- adrlogstop -->
```
Generate a Docs Index using [adr-log](https://www.npmjs.com/package/adr-log). It will modify files with comments in it
per the docs on that module.

## markdown-toc

Generate a Table of Contents using [markdown-toc](https://www.npmjs.com/package/markdown-toc). It will modify files with this
code in it:

```md
<!-- toc -->
<!-- tocstop -->
```
Generate a Table of Contents using [markdown-toc](https://www.npmjs.com/package/markdown-toc). It will modify files
with comments in it per the docs on that module.

## mdspell

Expand Down

0 comments on commit 6068abd

Please sign in to comment.