Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "compilerla/conventional-pre-commit",
"dockerComposeFile": ["./compose.yml"],
"dockerComposeFile": ["../compose.yml"],
"service": "dev",
"runServices": ["dev"],
"workspaceFolder": "/home/compiler/src",
Expand Down
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,13 @@ Create a blank configuration file at the root of your repo, if needed:
touch .pre-commit-config.yaml
```

Add a new repo entry to your configuration file:
Add/update `default_install_hook_types` and add a new repo entry in your configuration file:

```yaml
default_install_hook_types:
- pre-commit
- commit-msg

repos:
# - repo: ...

Expand All @@ -32,7 +36,7 @@ repos:
Install the `pre-commit` script:

```console
pre-commit install --hook-type commit-msg
pre-commit install --install-hooks
```

Make a (normal) commit :x::
Expand Down Expand Up @@ -74,9 +78,7 @@ Conventional Commit messages follow a pattern like:

Please correct the following errors:

- Expected value for 'type' but found none.
- Expected value for 'delim' but found none.
- Expected value for 'subject' but found none.
- Expected value for type from: build, chore, ci, docs, feat, fix, perf, refactor, revert, style, test

Run:

Expand Down Expand Up @@ -151,8 +153,8 @@ options:
-h, --help show this help message and exit
--no-color Disable color in output.
--force-scope Force commit to have scope defined.
--scopes SCOPES Optional list of scopes to support. Scopes should be separated by commas with no spaces (e.g. api,client)
--strict Force commit to strictly follow Conventional Commits formatting. Disallows fixup! style commits.
--scopes SCOPES List of scopes to support. Scopes should be separated by commas with no spaces (e.g. api,client).
--strict Force commit to strictly follow Conventional Commits formatting. Disallows fixup! and merge commits.
--verbose Print more verbose error output.
```

Expand Down
4 changes: 2 additions & 2 deletions .devcontainer/compose.yml → compose.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
services:
dev:
build:
context: ..
context: .
dockerfile: .devcontainer/Dockerfile
entrypoint: []
command: sleep infinity
image: compilerla/conventional-pre-commit:dev
volumes:
- ../:/home/compiler/src
- ./:/home/compiler/src
Loading
Loading