Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(readme): Update README.md #5

Merged
merged 1 commit into from
Oct 26, 2023
+7 −31
Merged

docs(readme): Update README.md #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
38 changes: 7 additions & 31 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,47 +1,23 @@
# Missing #
# Missing

A simple [pre-commit][0] hook to find missing `__init__.py` that is required for unit test cases to be discovered.
A simple [pre-commit][0] hook to find missing `__init__.py`. Will obey settings in `.gitignore`.

## Example ##
## Example

Default setting, everything except `.git` will be scanned
Default settings

```yaml
- repo: https://github.com/hardcoretech/missing
rev: v0.2.5
rev: v0.3.0
hooks:
- id: missing-init-py
```

Exclude according to .gitignore
Exclude some folders

```yaml
- repo: https://github.com/hardcoretech/missing
rev: v0.2.5
hooks:
- id: missing-init-py
args:
- --mode
- obey_gitignore
```

Only include git staged files

```yaml
- repo: https://github.com/hardcoretech/missing
rev: v0.2.5
hooks:
- id: missing-init-py
args:
- --mode
- staged_only
```

Exclude frontend and doc folder

```yaml
- repo: https://github.com/hardcoretech/missing
rev: v0.2.5
rev: v0.3.0
hooks:
- id: missing-init-py
args:
Expand Down
Loading