-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
9 changed files
with
28 additions
and
47 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# This file is managed by Copier; DO NOT EDIT OR REMOVE. | ||
_commit: v0.1.1 | ||
_src_path: [email protected]:quantco/copier-template-pre-commit-mirrors | ||
description: Source code spell checker, binary install | ||
entry: typos | ||
tool: typos | ||
url: https://github.com/crate-ci/typos |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,7 @@ | ||
name: Keep | ||
on: | ||
# pull_request: | ||
schedule: | ||
- cron: "0 6 * * SUN" # Once weekly on Sunday @ 0600 UTC | ||
- cron: 0 6 * * SUN | ||
|
||
jobs: | ||
keep-alive: | ||
|
@@ -12,7 +11,7 @@ jobs: | |
- uses: actions/checkout@v4 | ||
- uses: gautamkrishnar/keepalive-workflow@60b13c92aeda855e493b83aaf482c25da7e0043b | ||
with: | ||
commit_message: "Ah ah ah, stayin' alive" | ||
commit_message: Ah ah ah, stayin' alive | ||
committer_username: ForrestQuant | ||
committer_email: "[email protected]" | ||
time_elapsed: 50 # days | ||
committer_email: [email protected] | ||
time_elapsed: 50 # days |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,7 +4,6 @@ on: | |
push: | ||
branches: | ||
- main | ||
- master | ||
|
||
jobs: | ||
tag: | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,8 @@ | ||
- id: typos-conda | ||
name: typos-conda | ||
description: Source code spell checker, binary install | ||
language: conda | ||
entry: typos | ||
language: conda | ||
args: [--force-exclude] | ||
types: [text] | ||
stages: [commit, merge-commit, push, manual] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,43 +1,18 @@ | ||
typos(-conda) mirror | ||
==================== | ||
# typos mirror | ||
|
||
Mirror of typos for pre-commit with conda as a language. | ||
|
||
For pre-commit: see https://github.com/pre-commit/pre-commit | ||
For typos: see https://github.com/crate-ci/typos | ||
For pre-commit: see [here](https://github.com/pre-commit/pre-commit) | ||
|
||
### Using typos with pre-commit and conda: | ||
For ansible-lint: see [here](https://github.com/crate-ci/typos) | ||
|
||
## Using typos with pre-commit and conda: | ||
|
||
Add this to your `.pre-commit-config.yaml` | ||
|
||
```yaml | ||
- repo: https://github.com/Quantco/pre-commit-mirrors-typos | ||
- repo: https://github.com/quantco/pre-commit-mirrors-typos | ||
rev: '' # Use the sha / tag you want to point at | ||
hooks: | ||
- id: typos-conda | ||
``` | ||
### Some Useful Exceptions | ||
For the exact documentation on how to ignore certain typos, see: https://github.com/crate-ci/typos#false-positives . This config | ||
can be included in the `pyproject.toml` of a repository as shown below. | ||
|
||
In our projects, some shorter German works are too similar to English words and are picked up. Here is a list of commonly encountered typos: | ||
|
||
```toml | ||
[tool.typos] | ||
[tool.typos.default.extend-words] | ||
als = "als" | ||
alle = "alle" | ||
autor = "autor" | ||
beginn = "beginn" | ||
ende = "ende" | ||
iif = "iif" | ||
ist = "ist" | ||
feld = "field" | ||
sie = "sie" | ||
tage = "tage" | ||
titel = "titel" | ||
``` | ||
|
||
### Flagging Unrecognized Typos | ||
If you notice that there is a typo in your project that is not being caught by `typos`, simply open an issue in this repository. |