docs(parser): Note new features

This commit is contained in:
Ed Page 2021-06-29 14:43:05 -05:00
parent c83f655109
commit 9a0d754862
2 changed files with 25 additions and 0 deletions

View file

@ -7,6 +7,26 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
<!-- next-header --> <!-- next-header -->
## [Unreleased] - ReleaseDate ## [Unreleased] - ReleaseDate
#### Change of Behavior
- `ignore-hex` and `identifier-leading-digit` are deprecated and `typos` acts as
if `ignore-hex=true` and `identifier-leading-digit=false`.
#### Features
- Automatically ignore
- UUIDs
- SHAs
- base64 encoded data (must be at least 90 bytes)
- emails
- URLs
#### Performance
- Due to new literal detection, finding identifiers is takes 10x longer.
Combined with word splitting, its only takes 3x longer. The majority of the
time is spent in dictionary lookups, so we don't expect this to have too much impact in the end.
## [1.0.10] - 2021-06-28 ## [1.0.10] - 2021-06-28
#### Bug Fixes #### Bug Fixes

View file

@ -8,7 +8,12 @@
| Per-Lang Dict | Yes | ? | No | Yes | | Per-Lang Dict | Yes | ? | No | Yes |
| CamelCase | Yes | ? | No | Yes | | CamelCase | Yes | ? | No | Yes |
| snake_case | Yes | ? | No | Yes | | snake_case | Yes | ? | No | Yes |
| Ignore email | Yes | yes | No | No |
| Ignore url | Yes | yes | No | No |
| Ignore Hex | Yes | ? | No | Yes | | Ignore Hex | Yes | ? | No | Yes |
| Ignore UUID | Yes | ? | No | No |
| Ignore base64 | Yes | ? | No | No |
| Ignore SHAs | Yes | ? | No | No |
| C-Escapes | No ([#20][def-3]) | ? | No | Yes | | C-Escapes | No ([#20][def-3]) | ? | No | Yes |
| Encodings | UTF-8 / UTF-16 | ? | Auto | Auto | | Encodings | UTF-8 / UTF-16 | ? | Auto | Auto |
| Whole-project | Yes | Yes | Yes | No | | Whole-project | Yes | Yes | Yes | No |