From 9a0d7548627ce3bdf17972396f965b754af61411 Mon Sep 17 00:00:00 2001 From: Ed Page Date: Tue, 29 Jun 2021 14:43:05 -0500 Subject: [PATCH] docs(parser): Note new features --- CHANGELOG.md | 20 ++++++++++++++++++++ docs/comparison.md | 5 +++++ 2 files changed, 25 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index a74cb95..af102e3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,26 @@ and this project adheres to [Semantic Versioning](http://semver.org/). ## [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 #### Bug Fixes diff --git a/docs/comparison.md b/docs/comparison.md index 952864f..21898f1 100644 --- a/docs/comparison.md +++ b/docs/comparison.md @@ -8,7 +8,12 @@ | Per-Lang Dict | Yes | ? | No | Yes | | CamelCase | 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 UUID | Yes | ? | No | No | +| Ignore base64 | Yes | ? | No | No | +| Ignore SHAs | Yes | ? | No | No | | C-Escapes | No ([#20][def-3]) | ? | No | Yes | | Encodings | UTF-8 / UTF-16 | ? | Auto | Auto | | Whole-project | Yes | Yes | Yes | No |