Merge pull request #218 from epage/types

refactor(cli): Prepare for more advanced config
crate-ci · Mar 31, 2021 · a148054 · a148054
2 parents 60dbf0a + d51725b
commit a148054
Show file tree

Hide file tree

Showing 11 changed files with 579 additions and 301 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -46,6 +46,7 @@ toml = "0.5"
 log = "0.4"
 env_logger = "0.8"
 bstr = "0.2"
+once_cell = "1.2.0"
 ahash = "0.7"
 difflib = "0.4"
 proc-exit = "1.0"
@@ -57,6 +58,8 @@ derive_setters = "0.1"
 itertools = "0.10"
 serde_json = "1.0"
 encoding = "0.2"
+kstring = "1.0"
+typed-arena = "2.0.1"
 
 [dev-dependencies]
 assert_fs = "1.0"

diff --git a/benches/checks.rs b/benches/checks.rs
@@ -5,6 +5,12 @@ use criterion::{criterion_group, criterion_main, BenchmarkId, Criterion};
 use typos_cli::file::FileChecker;
 
 fn bench_checks(c: &mut Criterion) {
+    let dict = typos_cli::dict::BuiltIn::new(Default::default());
+    let tokenizer = typos::tokens::Tokenizer::new();
+    let policy = typos_cli::policy::Policy::new()
+        .dict(&dict)
+        .tokenizer(&tokenizer);
+
     let mut group = c.benchmark_group("checks");
     for (name, sample) in data::DATA {
         let len = sample.len();
@@ -13,16 +19,11 @@ fn bench_checks(c: &mut Criterion) {
             let sample_path = temp.child("sample");
             sample_path.write_str(sample).unwrap();
 
-            let corrections = typos_cli::dict::BuiltIn::new(Default::default());
-            let parser = typos::tokens::Tokenizer::new();
-            let settings = typos_cli::file::CheckSettings::new();
             b.iter(|| {
                 typos_cli::file::FoundFiles.check_file(
                     sample_path.path(),
                     true,
-                    &settings,
-                    &parser,
-                    &corrections,
+                    &policy,
                     &typos_cli::report::PrintSilent,
                 )
             });
@@ -34,16 +35,11 @@ fn bench_checks(c: &mut Criterion) {
             let sample_path = temp.child("sample");
             sample_path.write_str(sample).unwrap();
 
-            let corrections = typos_cli::dict::BuiltIn::new(Default::default());
-            let parser = typos::tokens::Tokenizer::new();
-            let settings = typos_cli::file::CheckSettings::new();
             b.iter(|| {
                 typos_cli::file::Identifiers.check_file(
                     sample_path.path(),
                     true,
-                    &settings,
-                    &parser,
-                    &corrections,
+                    &policy,
                     &typos_cli::report::PrintSilent,
                 )
             });
@@ -55,16 +51,11 @@ fn bench_checks(c: &mut Criterion) {
             let sample_path = temp.child("sample");
             sample_path.write_str(sample).unwrap();
 
-            let corrections = typos_cli::dict::BuiltIn::new(Default::default());
-            let parser = typos::tokens::Tokenizer::new();
-            let settings = typos_cli::file::CheckSettings::new();
             b.iter(|| {
                 typos_cli::file::Words.check_file(
                     sample_path.path(),
                     true,
-                    &settings,
-                    &parser,
-                    &corrections,
+                    &policy,
                     &typos_cli::report::PrintSilent,
                 )
             });
@@ -76,16 +67,11 @@ fn bench_checks(c: &mut Criterion) {
             let sample_path = temp.child("sample");
             sample_path.write_str(sample).unwrap();
 
-            let corrections = typos_cli::dict::BuiltIn::new(Default::default());
-            let parser = typos::tokens::Tokenizer::new();
-            let settings = typos_cli::file::CheckSettings::new();
             b.iter(|| {
                 typos_cli::file::Typos.check_file(
                     sample_path.path(),
                     true,
-                    &settings,
-                    &parser,
-                    &corrections,
+                    &policy,
                     &typos_cli::report::PrintSilent,
                 )
             });

diff --git a/docs/reference.md b/docs/reference.md
@@ -28,6 +28,6 @@ Configuration is read from the following (in precedence order)
 | default.identifier-include-digits   | \-   | bool   | Allow identifiers to include digits, in addition to letters. |
 | default.identifier-leading-chars    | \-   | string | Allow identifiers to start with one of these characters. |
 | default.identifier-include-chars    | \-   | string | Allow identifiers to include these characters. |
-| default.locale         | \-                | en, en-us, en-gb, en-ca, en-au   | English dialect to correct to. |
+| default.locale         | --locale          | en, en-us, en-gb, en-ca, en-au   | English dialect to correct to. |
 | default.extend-identifiers | \-            | table of strings | Corrections for identifiers. When the correction is blank, the word is never valid. When the correction is the key, the word is always valid. |
 | default.extend-words       | \-            | table of strings | Corrections for identifiers. When the correction is blank, the word is never valid. When the correction is the key, the word is always valid. |
diff --git a/src/args.rs b/src/args.rs
@@ -101,7 +101,7 @@ pub(crate) struct Args {
     pub(crate) verbose: clap_verbosity_flag::Verbosity,
 }
 
-#[derive(Debug, StructOpt)]
+#[derive(Debug, Clone, StructOpt)]
 #[structopt(rename_all = "kebab-case")]
 pub(crate) struct FileArgs {
     #[structopt(long, overrides_with("no-binary"))]
@@ -122,20 +122,14 @@ pub(crate) struct FileArgs {
     #[structopt(long, overrides_with("no-check-files"), hidden(true))]
     check_files: bool,
 
-    #[structopt(long, overrides_with("hex"))]
-    /// Don't try to detect that an identifier looks like hex
-    no_hex: bool,
-    #[structopt(long, overrides_with("no-hex"), hidden(true))]
-    hex: bool,
-
     #[structopt(
         long,
         possible_values(&config::Locale::variants()),
     )]
     pub(crate) locale: Option<config::Locale>,
 }
 
-impl config::FileSource for FileArgs {
+impl config::EngineSource for FileArgs {
     fn binary(&self) -> Option<bool> {
         match (self.binary, self.no_binary) {
             (true, false) => Some(true),
@@ -163,15 +157,12 @@ impl config::FileSource for FileArgs {
         }
     }
 
-    fn ignore_hex(&self) -> Option<bool> {
-        match (self.hex, self.no_hex) {
-            (true, false) => Some(true),
-            (false, true) => Some(false),
-            (false, false) => None,
-            (_, _) => unreachable!("StructOpt should make this impossible"),
-        }
+    fn dict(&self) -> Option<&dyn config::DictSource> {
+        Some(self)
     }
+}
 
+impl config::DictSource for FileArgs {
     fn locale(&self) -> Option<config::Locale> {
         self.locale
     }