actions/typos
1
0
Fork 0
mirror of https://github.com/crate-ci/typos.git synced 2024-12-22 23:52:12 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
2071 commits 2 branches 509 tags 38 MiB
Commit graph

252 commits

Author SHA1 Message Date
Ed Page
e15de8b72e chore: Release 2023-03-18 02:09:49 -05:00
Ed Page
ac46a6ba54 feat(config): Custom ignores 
Typos primarily works off of identifiers and words.  We have built-in
support to detect constructs that span identifiers that should not be
spell checked, like UUIDs, emails, domains, etc.  This opens it up for
for user-defined identifier-spanning constructs using regexes via
`extend-ignore-re`.

This works differently than any of the previous ways of ignoring thing
because the regexes require extra parse passes.  Under the assumption
that (1) actual typos are rare and (2) number of files relying on
`extend-ignore-re` are rare, we only do these extra parse passes when a
typo is found, causing almost no performance hit in the expected case.

While this could be used for more generic types of ignores, it isn't the
most maintainable because it is separate from the source files in
question.  Ideally, we'd implement document settings / directives for
these cases (#316).
 2023-03-18 01:25:39 -05:00
Ed Page
a1a601195e chore: Release 2023-03-17 23:59:36 -05:00
Ed Page
fc7dfba01b docs(reference): Fix glob field name 2023-03-17 23:37:57 -05:00
Ed Page
797574c10a chore: Release 2023-03-17 23:09:02 -05:00
Ed Page
af90817e50 feat(dict): extend-ignore-identifiers-re support 
This opens the door for users to provide patterns for identifiers that
are always valid.  The key limitation is "identifiers".  Run `typos
--identifiers` to verify what you are trying to write the regex for.

Fixes #651
 2023-03-17 22:40:55 -05:00
Ed Page
03286f0f82 chore: Release 2023-03-16 05:22:42 -05:00
Ed Page
57502b53cc chore: Release 2023-03-16 03:47:08 -05:00
Ed Page
dc0eafc7e5 chore: Release 2023-03-14 02:14:39 -05:00
Ed Page
28e7f17a65 chore: Release 2023-03-13 20:45:44 -05:00
Ed Page
6add7347fc docs(design): Note that we want non-transient, machine-independent config 2023-03-13 15:08:12 -05:00
Ed Page
34289639e6 chore: Release 2023-03-13 12:33:33 -05:00
Ed Page
3d0de83fb6 chore: Release 2023-03-13 11:57:15 -05:00
Ed Page
a50bd03c2a chore: Release 2023-03-07 04:47:20 -06:00
Ed Page
5414608bf6 chore: Release 2023-03-07 03:18:52 -06:00
Ed Page
52d0ea7ddf chore: Release 2023-03-05 21:02:01 -06:00
Ed Page
08a9831825 chore: Release 2023-03-05 20:43:46 -06:00
Ed Page
c389c36b66 chore: Release 2023-02-28 07:25:30 -06:00
Ed Page
f4293b58c5 chore: Release 2023-02-28 06:30:27 -06:00
Ed Page
8cef23a8f4 chore: Release 2023-02-27 16:14:07 -06:00
Ed Page
9f306b2be9 chore: Release 2023-02-27 15:33:00 -06:00
Ed Page
26c2ca1853 chore: Release 2023-02-23 13:09:37 -06:00
Ed Page
efa38136f2
Merge pull request #657 from bnjbvr/write-changes 
Allow writing changes in the github action
 2023-02-23 13:08:55 -06:00
Ed Page
59a10c298a chore: Release 2023-02-23 10:44:11 -06:00
Benjamin Bouvier
c24f4675b8 docs: document writing_changes in the Github action 2023-02-08 15:04:32 +01:00
Ed Page
6e14cefb85 chore: Release 2023-02-01 10:09:00 -06:00
Ed Page
97770bdd02 chore: Release 2023-01-25 10:31:49 -06:00
Ed Page
12c6491895 chore: Release 2023-01-16 08:43:06 -06:00
Ed Page
1f4ee742ab chore: Release 2023-01-13 21:18:38 -06:00
Ed Page
59c4713e8b docs(ref): Further clarify identifiers and words 
This supersedes #648
 2023-01-03 07:06:08 -06:00
Ed Page
6773b4caa2 docs(ref): Define identifiers/words 
This came up in #646
 2023-01-02 07:13:25 -06:00
Ed Page
6efbdc33f4 chore: Release 2022-12-20 14:39:46 -06:00
Ville Skyttä
ec3ffa591c feat: Add Docker pre-commit hook 
Mostly as an alternative to the src install, but trading host dependency
on Rust with one on Docker.
 2022-12-20 21:06:04 +02:00
Ed Page
f268a89d38 chore: Release 2022-12-19 08:47:53 -06:00
Ed Page
1d8996e205 chore: Release 2022-12-06 13:54:17 -06:00
Ed Page
b38d05b941 docs: Clarify word vs identifier 2022-12-02 10:05:09 -06:00
Ed Page
4637c964a3 chore: Release 2022-12-01 20:25:20 -06:00
Ed Page
98c3a33cc6 chore: Release 2022-12-01 20:00:28 -06:00
Ed Page
6bf2e7c7d7 chore: Release 2022-11-29 23:00:05 -06:00
Ed Page
8b88f9f340 chore: Release 2022-11-21 22:26:08 -06:00
Ed Page
eff3fe8444 chore: Release 2022-11-04 09:52:20 -05:00
Ed Page
39b28c3010 chore: Release 2022-11-03 22:28:10 -05:00
Ed Page
47912c390a chore: Release 2022-10-25 07:11:46 -05:00
Ed Page
4e7e37799b chore: Release 2022-10-20 07:08:07 -05:00
Ed Page
2fc71b2e13 chore: Release 2022-10-11 09:48:09 -05:00
Ed Page
9576a03cee fix: Don't point to 1.12.9 (unsure where it went) 2022-10-06 14:35:40 -05:00
Ed Page
16ca0accbb chore: Release 2022-10-06 08:26:11 -05:00
Ed Page
45a93446f2 chore: Release 2022-09-28 16:15:05 -05:00
Ed Page
fd5abef1a7 chore: Release 2022-09-22 13:38:17 -05:00
Ed Page
668a94791b chore: Release 2022-09-21 19:28:48 -05:00
Ed Page
384aaef311 chore: Release 2022-09-15 08:43:18 -05:00
Ed Page
7be4ba34c9 chore: Release 2022-09-08 11:49:58 -05:00
Ed Page
3161cd6a82 chore: Release 2022-09-06 09:25:25 -05:00
Ed Page
c6d876294c chore: Release 2022-09-01 10:43:57 -05:00
Ed Page
0d43c1c24e chore: Release 2022-09-01 09:50:53 -05:00
Ed Page
fdb425c279 chore: Release 2022-08-30 09:28:57 -05:00
Ed Page
57a0ae69af chore: Release 2022-08-29 16:11:36 -05:00
Ed Page
4c2445fb57 chore: Release 2022-08-25 16:24:58 -05:00
Ed Page
7d2ad4148d chore: Release 2022-08-25 06:37:27 -05:00
Ed Page
0612303e7d chore: Release 2022-08-23 09:24:26 -05:00
Ed Page
9b70dca40c chore: Release 2022-08-16 07:49:04 -05:00
Ed Page
69fe45d5e7 chore: Release 2022-08-13 12:06:41 -05:00
Ed Page
a6674d5be4 chore: Release 2022-07-22 11:09:08 -05:00
Ed Page
9be36f97fd chore: Release 2022-06-22 12:28:18 -05:00
Ed Page
05ad2bde04 chore: Release 2022-06-16 14:11:38 -05:00
Ed Page
8dc6da2da0 chore: Release 2022-06-16 13:51:51 -05:00
Ed Page
f8073dcfa0 chore: Release 2022-06-15 16:13:13 -05:00
Ed Page
927308c726 chore: Release 2022-05-16 09:33:53 -05:00
Ed Page
778fd7a53d chore: Release 2022-05-10 14:24:11 -05:00
Ed Page
9f623c618b chore: Release 2022-04-28 09:39:14 -05:00
Ed Page
dd827082e9 chore: Release 2022-04-27 21:56:53 -05:00
Ed Page
dcc3c0b11e chore: Release 2022-04-25 11:49:02 -05:00
Ed Page
7d3e9bb070 chore: Release 2022-04-18 09:39:53 -05:00
Ville Skyttä
60fc0ca19d
docs(reference): Formatting and copy-pasto fixes 
Escape left angle bracket, fix copy-pastos in default.extend-identifiers
and default.extend-words descriptions.
 2022-04-11 00:06:26 +03:00
Ed Page
3e802f8100 chore: Release 2022-04-06 12:53:00 -05:00
Ed Page
4253c3c3ee chore: Release 2022-03-09 09:00:30 -06:00
Ed Page
21cd8dc32f docs(compare): Add another tool 2022-02-16 12:46:16 -06:00
Ed Page
b686760935 chore: Release 2022-02-14 09:05:09 -06:00
Ed Page
05773fe815 chore: Release 2022-02-08 07:12:19 -06:00
Ed Page
5b7fe620ec chore: Release 2022-01-26 14:32:31 -06:00
Ed Page
2c5f2ecedd chore: Release 2022-01-26 10:01:15 -06:00
Ed Page
4b2e66487c chore: Release 2022-01-24 20:35:08 -06:00
Ed Page
a329a99ec7 chore: Release 2022-01-24 12:30:42 -06:00
Ed Page
f7fd7c0e42 chore: Release 2022-01-21 10:39:27 -06:00
Ed Page
ac83c55077 chore: Release 2022-01-12 11:16:44 -06:00
Ed Page
71b53cb23e chore: Release 2021-12-18 17:52:11 -06:00
Ed Page
469a9aedc2 chore: Release 2021-12-14 12:58:03 -06:00
Ed Page
496b8ab3e1 chore: Release 2021-11-16 07:49:32 -06:00
Ed Page
7377c3d382 chore: Release 2021-11-15 08:37:02 -06:00
Ed Page
153f570ec9 chore: Release 2021-11-03 11:48:12 -05:00
Ed Page
e394b4d65e chore: Release 2021-10-23 09:44:22 -05:00
Ed Page
3cd24f5cca chore: Release 2021-09-14 10:03:34 -05:00
Ed Page
dbea7ab1e0 chore: Release 2021-08-30 09:16:40 -05:00
Ed Page
ce6b9b9516 chore: Release 2021-08-20 12:16:11 -05:00
Ed Page
c5028ded31 chore: Release 2021-08-06 09:03:52 -05:00
Ed Page
936ec335a5 chore: Release 2021-08-04 08:47:54 -05:00
Ed Page
acf5fd331b chore: Release 2021-08-02 09:58:00 -05:00
Ed Page
f5b42c3e61 chore: Release 2021-07-30 12:14:20 -05:00
Ed Page
39afbec0ea chore: Release 2021-07-30 11:10:12 -05:00
Ed Page
488d24f78b chore: Release 2021-07-27 15:43:50 -05:00
Ed Page
30038f572b chore: Release 2021-07-27 15:33:16 -05:00
Ed Page
ccbd1a69af docs: Call out dictionary model 2021-07-27 15:22:17 -05:00
Ed Page
8f3f5b90ad chore: Release 2021-06-29 15:34:25 -05:00
Ed Page
9a0d754862 docs(parser): Note new features 2021-06-29 14:43:05 -05:00
Ed Page
32f5e6c682 refactor(typos)!: Bake ignores into parser 
This is prep for other items to be ignored

BREAKING CHANGE: `TokenizerBuilder` no longer takes config for ignoring
tokens.  Related, we now ignore token-ignore config flags.
 2021-06-29 11:41:25 -05:00
Ed Page
3e5787c0e2 chore: Release 2021-06-28 14:56:13 -05:00
Ville Skyttä
867ee75b02 feat(pre-commit): Add binary based install 
For no additional build dependencies (besides Python >= 3.6), and faster
install.

The setup.py here is a copy of the one at
https://github.com/shellcheck-py/shellcheck-py with changes kept at the
bare minimum for future diffability.

We don't support checksumming at least yet, because there's no access to
them from cargo-release at the moment.

Closes #285
 2021-06-28 19:53:51 +03:00
Ed Page
e9c800b2bf chore: Release 2021-06-15 17:32:26 -05:00
Ed Page
5304d94fb7 chore: Release 2021-06-15 10:53:20 -05:00
Ville Skyttä
9739865559 feat: Add pre-commit integration 2021-06-08 23:07:54 +03:00
Marian Triebe
7141c710c8
Fix example in github-action.md 
The repository of crate-ci/typos does not have a "main" branch, "master" is used instead.
 2021-06-05 10:17:32 +02:00
Vanessasaurus
7d09c5a4bf
feat(ci): adding github action to use typos to check spelling (#267) 
Signed-off-by: vsoch <vsoch@users.noreply.github.com>

Co-authored-by: vsoch <vsoch@users.noreply.github.com>
 2021-05-31 19:42:45 -05:00
Ed Page
8a19ec5059 docs: Remove reference to misspell-rs 
This project seems to be dead
 2021-05-22 21:17:37 -05:00
Ed Page
327a84a242 feat(ignore): Typos=specific ignores 
We want both CLI and config ignores.  The question then is what we make
them relative to.  I decided to favor CLI with `.`.  We'll see how this
works out

Fixes #134
 2021-05-20 21:00:28 -05:00
Ed Page
0b9733c606 docs: Remove dead space 2021-05-19 19:49:51 -05:00
Ed Page
75b170c2b4 docs: Include screenshot 
Fixes #237
 2021-05-19 19:48:33 -05:00
Ed Page
14f1532bee docs: Switch from blacklist language 2021-04-30 20:49:01 -05:00
Ed Page
4b812e1b96 docs: Re-organize to clarify intent 
This is part of #237
 2021-04-30 20:41:57 -05:00
Ed Page
92a1172bfa feat(ddi): Allow controlling 'unicode' via args 2021-04-30 10:36:55 -05:00
Ed Page
517da7ecd2 perf(parser): Allow people to bypass unicode cost 2021-04-29 21:07:59 -05:00
Ed Page
9cbc7410a4 fix(parser)!: Defer to Unicode XID for identifiers 
This saves us from having to have configuration for every detail.  If
people need more control, we can offer it later.

Fixes #225
 2021-04-29 18:30:57 -05:00
Ed Page
10d97949e8 docs(about): Update comparison table 2021-04-06 21:18:56 -05:00
Ed Page
2a7bd5b046 feat(config): Add new file types 
Fixes #220
 2021-04-06 21:18:18 -05:00
Ed Page
8f365ee155 feat(config): Show available type definitions 2021-04-05 21:15:41 -05:00
Ed Page
a101df95c2 feat(config): Per-file type settings 
Fixes #14
 2021-04-05 21:03:49 -05:00
Ed Page
4bbc59facf refactor(config)!: Detect when no dict config 
In preparing for smarter handling of config, we need to be able to tell
what is present and what isn't.

BREAKING CHANGE: `--hex` was removed, the value didn't seem high enough.
 2021-03-29 20:27:12 -05:00
Ed Page
1c3acd747a fix(config)!: Move binary to file 
Seems like it would make sense to allow varying this by directory (when
supporting layering) and by file type.
 2021-03-01 11:50:12 -06:00
Ed Page
998fad4390 feat: Check and replace UTF-16 files 
We don't have good detection for non-UTF encodings and don't have
encoding support for UTF-32, so limiting it to just UTF-16.

Fixes #17
 2021-01-02 19:25:00 -06:00
Ed Page
b97b6ddd45
docs: Note custom dicts is supported 2020-11-10 06:40:24 -06:00
Ed Page
2ef1d02164 Revert "feat(ignore): Typos-specific ignores" 
This reverts commit 0052617fcd.

The fix for #134 was backwards.  It turns out `overrides` is for
including rather than ignoring.  Will need to look at this further.
 2020-11-03 19:55:45 -06:00
Ed Page
f0c24b0afa feat(config): Allow separating config from source 2020-10-30 08:33:43 -05:00
Ed Page
527b9837b4 feat: Custom dictionary support 
Switching `valid-*` to just `*` where you map typo to correction, with
support for always-valid and never-valid.

Fixes #9
 2020-10-27 21:15:25 -05:00
Ed Page
043692afe0 feat(dict): Override builtin dictionary 
Sometimes you just have to live with a typo or its done intentionally
(like weird company names).  With this commit, a user can now identifier
blessed identifiers and words.

This is ostly what is needed for #9 but sometimes people will have
common typos that they'll want to provide corrections for.
 2020-09-02 20:24:54 -05:00
Ed Page
0052617fcd feat(ignore): Typos-specific ignores 
THis is to help with cases like a monorepo with vendored dependencies.
A user might want to search (`.ignore`) them but not hold the code to
the same standards as first-party code.

Fixes #134
 2020-08-25 21:09:42 -05:00
Ed Page
ab4a5bbdaf feat: Support english dialects 
The goal is to be as accepting and unobtrusive to new code bases as
possible.  To this end, we correct typos into the closest english
dialect.

If someone wants to opt-in, they can have typos correct to a specific
english dialect.

Fixes #52
Fixes #22
 2020-08-20 19:37:37 -05:00
Ed Page
0867a6a6eb
docs: Pre-built binaries! 
Fixes #18
 2019-10-29 09:42:26 -06:00
Ed Page
158f83b29c
docs: Update install instructions for crate split 2019-10-26 09:04:25 -06:00
Ed Page
52926d8cd1
docs: Fix source precedence 2019-10-25 09:39:55 -06:00
Ed Page
5863158a31 docs: Add reference 2019-10-25 08:17:58 -06:00
Ed Page
851336b931 docs: Fix links 2019-10-25 08:06:05 -06:00
Ed Page
f5af748146
docs: Add link to benchmarks 2019-10-25 06:15:40 -06:00
Ed Page
81f20bb293 feat: Set exit code on typos being found 
Fixes #45
 2019-07-23 10:37:05 -06:00
Ed Page
ec307dffdd feat: Check file names 
Fixes #24
 2019-07-19 07:28:17 -06:00
Ed Page
006204e66a feat(parser): Ignore hex literals 
Trying to avoid accidentally correcting something that looks like a word
inside a hex number, like `0xBEAF`.

Fixes #19
 2019-07-13 20:15:22 -06:00
Ed Page
894df1bcdc docs: Add gitignore to comparison 
Fixes #25
 2019-07-13 18:46:03 -06:00
Ed Page
e039d9aae0 docs: Compare with codespell 
Fixes #23
 2019-07-13 18:45:38 -06:00
Ed Page
60372effa1 docs: Re-arrange comparison 2019-07-06 19:11:03 -06:00
Ed Page
86de1b8c2d
fix(docs): Table misformatted 2019-07-06 07:51:08 -06:00
Ed Page
377c911328 fix: Rename to typos 2019-07-03 19:22:36 -06:00
Ed Page
9692f7cd46
docs(about): Fix formatting 2019-06-26 21:52:49 -06:00