typos 1.37.3__tar.gz → 1.38.0__tar.gz

{typos-1.37.3 → typos-1.38.0}/Cargo.lock

@@ -1314,6 +1314,8 @@ dependencies = [
  "libc",
  "normalize-line-endings",
  "os_pipe",
+ "serde",
+ "serde_json",
  "similar",
  "snapbox-macros",
  "tempfile",
@@ -1591,7 +1593,7 @@ dependencies = [
 
 [[package]]
 name = "typos-cli"
-version = "1.37.3"
+version = "1.38.0"
 dependencies = [
  "ahash",
  "annotate-snippets",
@@ -1640,7 +1642,7 @@ dependencies = [
 
 [[package]]
 name = "typos-dict"
-version = "0.13.8"
+version = "0.13.9"
 dependencies = [
  "codegenrs",
  "csv",

{typos-1.37.3 → typos-1.38.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: typos
-Version: 1.37.3
+Version: 1.38.0
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
 Classifier: Topic :: Software Development

{typos-1.37.3 → typos-1.38.0}/crates/typos-cli/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "typos-cli"
-version = "1.37.3"
+version = "1.38.0"
 description = "Source Code Spelling Correction"
 readme = "README.md"
 categories = ["development-tools", "text-processing"]
@@ -84,7 +84,7 @@ supports-unicode = "3.0.0"
 assert_fs = "1.1"
 divan = "0.1.21"
 maplit = "1.0"
-snapbox = "0.6.21"
+snapbox = { version = "0.6.21", features = ["json"] }
 trycmd = "0.15.10"
 
 [[bench]]

{typos-1.37.3 → typos-1.38.0}/crates/typos-cli/src/bin/typos-cli/args.rs

@@ -169,6 +169,7 @@ impl FileArgs {
                 ..Default::default()
             },
             extend_ignore_re: Default::default(),
+            _unused: Default::default(),
         }
     }
 

{typos-1.37.3 → typos-1.38.0}/crates/typos-cli/src/config.rs

@@ -17,7 +17,7 @@ pub const SUPPORTED_FILE_NAMES: &[&str] = &[
 const CARGO_TOML: &str = "Cargo.toml";
 const PYPROJECT_TOML: &str = "pyproject.toml";
 
-#[derive(Debug, Clone, Default, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
+#[derive(Debug, Clone, Default, serde::Serialize, serde::Deserialize)]
 #[serde(deny_unknown_fields)]
 #[serde(default)]
 #[serde(rename_all = "kebab-case")]
@@ -31,7 +31,7 @@ pub struct Config {
     pub overrides: EngineConfig,
 }
 
-#[derive(Debug, Clone, Default, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
+#[derive(Debug, Clone, Default, serde::Serialize, serde::Deserialize)]
 #[serde(default)]
 #[serde(rename_all = "kebab-case")]
 pub struct CargoTomlConfig {
@@ -39,28 +39,28 @@ pub struct CargoTomlConfig {
     pub package: Option<CargoTomlPackage>,
 }
 
-#[derive(Debug, Clone, Default, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
+#[derive(Debug, Clone, Default, serde::Serialize, serde::Deserialize)]
 #[serde(default)]
 #[serde(rename_all = "kebab-case")]
 pub struct CargoTomlPackage {
     pub metadata: CargoTomlMetadata,
 }
 
-#[derive(Debug, Clone, Default, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
+#[derive(Debug, Clone, Default, serde::Serialize, serde::Deserialize)]
 #[serde(default)]
 #[serde(rename_all = "kebab-case")]
 pub struct CargoTomlMetadata {
     pub typos: Option<Config>,
 }
 
-#[derive(Debug, Clone, Default, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
+#[derive(Debug, Clone, Default, serde::Serialize, serde::Deserialize)]
 #[serde(default)]
 #[serde(rename_all = "kebab-case")]
 pub struct PyprojectTomlConfig {
     pub tool: PyprojectTomlTool,
 }
 
-#[derive(Debug, Clone, Default, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
+#[derive(Debug, Clone, Default, serde::Serialize, serde::Deserialize)]
 #[serde(default)]
 #[serde(rename_all = "kebab-case")]
 pub struct PyprojectTomlTool {
@@ -88,7 +88,7 @@ impl Config {
             )
         })?;
 
-        if path.file_name().unwrap() == CARGO_TOML {
+        let config = if path.file_name().unwrap() == CARGO_TOML {
             let config = toml::from_str::<CargoTomlConfig>(&s)?;
             let typos = config
                 .workspace
@@ -96,27 +96,32 @@ impl Config {
                 .or(config.package.and_then(|p| p.metadata.typos));
 
             if let Some(typos) = typos {
-                Ok(Some(typos))
+                typos
             } else {
                 log::debug!(
                     "No `package.metadata.typos` section found in `{CARGO_TOML}`, skipping"
                 );
 
-                Ok(None)
+                return Ok(None);
             }
         } else if path.file_name().unwrap() == PYPROJECT_TOML {
             let config = toml::from_str::<PyprojectTomlConfig>(&s)?;
 
             if let Some(typos) = config.tool.typos {
-                Ok(Some(typos))
+                typos
             } else {
                 log::debug!("No `tool.typos` section found in `{PYPROJECT_TOML}`, skipping");
 
-                Ok(None)
+                return Ok(None);
             }
         } else {
-            Self::from_toml(&s).map(Some)
+            Self::from_toml(&s)?
+        };
+        if let Some(key) = config.unused().next() {
+            anyhow::bail!("unknown key `{key}`");
         }
+
+        Ok(Some(config))
     }
 
     pub fn from_toml(data: &str) -> Result<Self, anyhow::Error> {
@@ -139,9 +144,22 @@ impl Config {
         self.type_.update(&source.type_);
         self.overrides.update(&source.overrides);
     }
+
+    fn unused(&self) -> impl Iterator<Item = String> + '_ {
+        self.default
+            ._unused
+            .keys()
+            .map(|k| format!("default.{k}"))
+            .chain(self.type_.patterns.iter().flat_map(|(name, glob)| {
+                glob.engine._unused.keys().map(|k| {
+                    let name = name.clone();
+                    format!("type.{name}.{k}")
+                })
+            }))
+    }
 }
 
-#[derive(Debug, Clone, Default, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
+#[derive(Debug, Clone, Default, serde::Serialize, serde::Deserialize)]
 #[serde(deny_unknown_fields)]
 #[serde(default)]
 #[serde(rename_all = "kebab-case")]
@@ -232,7 +250,7 @@ impl Walk {
     }
 }
 
-#[derive(Debug, Clone, Default, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
+#[derive(Debug, Clone, Default, serde::Serialize, serde::Deserialize)]
 #[serde(deny_unknown_fields)]
 #[serde(default)]
 #[serde(transparent)]
@@ -306,7 +324,7 @@ impl TypeEngineConfig {
     }
 }
 
-#[derive(Debug, Clone, Default, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
+#[derive(Debug, Clone, Default, serde::Serialize, serde::Deserialize)]
 //#[serde(deny_unknown_fields)]  // Doesn't work with `flatten`
 #[serde(default)]
 #[serde(rename_all = "kebab-case")]
@@ -344,6 +362,9 @@ pub struct EngineConfig {
     #[serde(with = "serde_regex")]
     #[cfg_attr(feature = "unstable-schema", schemars(schema_with = "vec_string"))]
     pub extend_ignore_re: Vec<regex::Regex>,
+    #[serde(flatten)]
+    #[cfg_attr(feature = "unstable-schema", schemars(skip))]
+    pub _unused: toml::Table,
 }
 
 impl EngineConfig {
@@ -356,6 +377,7 @@ impl EngineConfig {
             tokenizer: TokenizerConfig::from_defaults(),
             dict: DictConfig::from_defaults(),
             extend_ignore_re: Default::default(),
+            _unused: Default::default(),
         }
     }
 
@@ -373,6 +395,7 @@ impl EngineConfig {
         self.dict.update(&source.dict);
         self.extend_ignore_re
             .extend(source.extend_ignore_re.iter().cloned());
+        self._unused.extend(source._unused.clone());
     }
 
     pub fn binary(&self) -> bool {
@@ -392,24 +415,7 @@ impl EngineConfig {
     }
 }
 
-impl PartialEq for EngineConfig {
-    fn eq(&self, rhs: &Self) -> bool {
-        self.binary == rhs.binary
-            && self.check_filename == rhs.check_filename
-            && self.check_file == rhs.check_file
-            && self.tokenizer == rhs.tokenizer
-            && self.dict == rhs.dict
-            && self
-                .extend_ignore_re
-                .iter()
-                .map(|r| r.as_str())
-                .eq(rhs.extend_ignore_re.iter().map(|r| r.as_str()))
-    }
-}
-
-impl Eq for EngineConfig {}
-
-#[derive(Debug, Clone, Default, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
+#[derive(Debug, Clone, Default, serde::Serialize, serde::Deserialize)]
 #[serde(deny_unknown_fields)]
 #[serde(default)]
 #[serde(rename_all = "kebab-case")]
@@ -556,27 +562,7 @@ fn find_project_files<'a>(
         .filter(|path| path.exists())
 }
 
-impl PartialEq for DictConfig {
-    fn eq(&self, rhs: &Self) -> bool {
-        self.locale == rhs.locale
-            && self
-                .extend_ignore_identifiers_re
-                .iter()
-                .map(|r| r.as_str())
-                .eq(rhs.extend_ignore_identifiers_re.iter().map(|r| r.as_str()))
-            && self.extend_identifiers == rhs.extend_identifiers
-            && self
-                .extend_ignore_words_re
-                .iter()
-                .map(|r| r.as_str())
-                .eq(rhs.extend_ignore_words_re.iter().map(|r| r.as_str()))
-            && self.extend_words == rhs.extend_words
-    }
-}
-
-impl Eq for DictConfig {}
-
-#[derive(Debug, Copy, Clone, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
+#[derive(Debug, Copy, Clone, serde::Serialize, serde::Deserialize)]
 #[serde(rename_all = "kebab-case")]
 #[derive(Default)]
 #[cfg_attr(feature = "unstable-schema", derive(schemars::JsonSchema))]
@@ -655,6 +641,8 @@ fn hashmap_string_t<T: schemars::JsonSchema>(
 #[cfg(test)]
 mod test {
     use super::*;
+    use snapbox::assert_data_eq;
+    use snapbox::prelude::*;
 
     #[cfg(feature = "unstable-schema")]
     #[test]
@@ -668,11 +656,23 @@ mod test {
     fn test_from_defaults() {
         let null = Config::default();
         let defaulted = Config::from_defaults();
-        assert_ne!(defaulted, null);
-        assert_ne!(defaulted.files, null.files);
-        assert_ne!(defaulted.default, null.default);
-        assert_ne!(defaulted.default.tokenizer, null.default.tokenizer);
-        assert_ne!(defaulted.default.dict, null.default.dict);
+        assert_ne!(defaulted.clone().into_json(), null.clone().into_json());
+        assert_ne!(
+            defaulted.files.clone().into_json(),
+            null.files.clone().into_json()
+        );
+        assert_ne!(
+            defaulted.default.clone().into_json(),
+            null.default.clone().into_json()
+        );
+        assert_ne!(
+            defaulted.default.tokenizer.clone().into_json(),
+            null.default.tokenizer.clone().into_json()
+        );
+        assert_ne!(
+            defaulted.default.dict.clone().into_json(),
+            null.default.dict.clone().into_json()
+        );
     }
 
     #[test]
@@ -683,7 +683,7 @@ mod test {
         let mut actual = defaulted.clone();
         actual.update(&null);
 
-        assert_eq!(actual, defaulted);
+        assert_data_eq!(actual.into_json(), defaulted.into_json());
     }
 
     #[test]
@@ -694,7 +694,7 @@ mod test {
         let mut actual = null;
         actual.update(&defaulted);
 
-        assert_eq!(actual, defaulted);
+        assert_data_eq!(actual.into_json(), defaulted.into_json());
     }
 
     #[test]
@@ -708,7 +708,7 @@ mod test {
         let mut actual = null;
         actual.update(&extended);
 
-        assert_eq!(actual, extended);
+        assert_data_eq!(actual.into_json(), extended.into_json());
     }
 
     #[test]
@@ -726,7 +726,7 @@ mod test {
         actual.update(&extended);
 
         let expected: Vec<KString> = vec!["*.foo".into(), "*.bar".into()];
-        assert_eq!(actual.extend_glob, expected);
+        assert_data_eq!(actual.extend_glob.into_json(), expected.into_json());
     }
 
     #[test]
@@ -749,7 +749,7 @@ check-file = true
             },
         );
         let actual = Config::from_toml(input).unwrap();
-        assert_eq!(actual, expected);
+        assert_data_eq!(actual.into_json(), expected.into_json());
     }
 
     #[test]
@@ -781,6 +781,6 @@ inout = "inout"
             },
         );
         let actual = Config::from_toml(input).unwrap();
-        assert_eq!(actual, expected);
+        assert_data_eq!(actual.into_json(), expected.into_json());
     }
 }

{typos-1.37.3 → typos-1.38.0}/crates/typos-cli/src/default_types.rs

@@ -27,9 +27,10 @@ pub(crate) const DEFAULT_TYPES: &[(&str, &[&str])] = &[
     ("bat", &["*.bat", "*.cmd"]),
     ("bazel", &[
         "*.bazel", "*.bzl", "*.BUILD", "*.bazelrc", "BUILD", "MODULE.bazel",
-        "WORKSPACE", "WORKSPACE.bazel",
+        "WORKSPACE", "WORKSPACE.bazel", "WORKSPACE.bzlmod",
     ]),
     ("bitbake", &["*.bb", "*.bbappend", "*.bbclass", "*.conf", "*.inc"]),
+    ("boxlang", &["*.bx", "*.bxm", "*.bxs"]),
     ("brotli", &["*.br"]),
     ("buildstream", &["*.bst"]),
     ("bzip2", &["*.bz2", "*.tbz2"]),
@@ -56,6 +57,7 @@ pub(crate) const DEFAULT_TYPES: &[(&str, &[&str])] = &[
         "*.pem",
     ]),
     ("ceylon", &["*.ceylon"]),
+    ("cfml", &["*.cfc", "*.cfm"]),
     ("clojure", &["*.clj", "*.cljc", "*.cljs", "*.cljx"]),
     ("cmake", &["*.cmake", "CMakeLists.txt"]),
     ("cml", &["*.cml"]),
@@ -101,6 +103,7 @@ pub(crate) const DEFAULT_TYPES: &[(&str, &[&str])] = &[
     ("fsharp", &["*.fs", "*.fsx", "*.fsi"]),
     ("fut", &["*.fut"]),
     ("gap", &["*.g", "*.gap", "*.gi", "*.gd", "*.tst"]),
+    ("gleam", &["*.gleam"]),
     ("gn", &["*.gn", "*.gni"]),
     ("go", &["*.go", "go.mod", "go.work"]),
     ("gprbuild", &["*.gpr"]),
@@ -124,10 +127,11 @@ pub(crate) const DEFAULT_TYPES: &[(&str, &[&str])] = &[
     ("jinja", &["*.j2", "*.jinja", "*.jinja2"]),
     ("jl", &["*.jl"]),
     ("js", &["*.js", "*.jsx", "*.vue", "*.cjs", "*.mjs"]),
-    ("json", &["*.json"]),
+    ("json", &["*.json", "*.sarif"]),
     ("jsonl", &["*.jsonl"]),
     ("jupyter", &["*.ipynb", "*.jpynb"]),
     ("k", &["*.k"]),
+    ("kconfig", &["Kconfig", "Kconfig.*"]),
     ("kotlin", &["*.kt", "*.kts"]),
     ("lean", &["*.lean"]),
     ("less", &["*.less"]),
@@ -160,6 +164,7 @@ pub(crate) const DEFAULT_TYPES: &[(&str, &[&str])] = &[
     ]),
     ("lilypond", &["*.ly", "*.ily"]),
     ("lisp", &["*.el", "*.lisp", "*.lsp", "*.sc", "*.scm"]),
+    ("llvm", &["*.ll"]),
     ("lock", &[
         "*.lock",
         "package-lock.json", "pnpm-lock.yaml",
@@ -177,7 +182,7 @@ pub(crate) const DEFAULT_TYPES: &[(&str, &[&str])] = &[
         "[Gg][Nn][Uu]makefile", "[Mm]akefile",
         "[Gg][Nn][Uu]makefile.am", "[Mm]akefile.am",
         "[Gg][Nn][Uu]makefile.in", "[Mm]akefile.in",
-        "*.mk", "*.mak"
+        "*.mk", "*.mak", "Makefile.*"
     ]),
     ("mako", &["*.mako", "*.mao"]),
     ("man", &["*.[0-9lnpx]", "*.[0-9][cEFMmpSx]"]),
@@ -199,7 +204,7 @@ pub(crate) const DEFAULT_TYPES: &[(&str, &[&str])] = &[
     ("motoko", &["*.mo"]),
     ("msbuild", &[
         "*.csproj", "*.fsproj", "*.vcxproj", "*.proj", "*.props", "*.targets",
-        "*.sln",
+        "*.sln", "*.slnf",
     ]),
     ("nim", &["*.nim", "*.nimf", "*.nimble", "*.nims"]),
     ("nix", &["*.nix"]),
@@ -249,7 +254,7 @@ pub(crate) const DEFAULT_TYPES: &[(&str, &[&str])] = &[
         // Idiomatic files
         "config.ru", "Gemfile", ".irbrc", "Rakefile",
         // Extensions
-        "*.gemspec", "*.rb", "*.rbw"
+        "*.gemspec", "*.rb", "*.rbw", "*.rake"
     ]),
     ("rust", &[
         "*.rs",
@@ -258,9 +263,11 @@ pub(crate) const DEFAULT_TYPES: &[(&str, &[&str])] = &[
     ]),
     ("sass", &["*.sass", "*.scss"]),
     ("scala", &["*.scala", "*.sbt"]),
+    ("scdoc", &["*.scd", "*.scdoc"]),
+    ("seed7", &["*.s7i", "*.sd7"]),
     ("sh", &[
         // Portable/misc. init files
-        ".login", ".logout", ".profile", "profile",
+        ".env", ".login", ".logout", ".profile", "profile",
         // bash-specific init files
         ".bash_login", "bash_login",
         ".bash_logout", "bash_logout",
@@ -279,7 +286,7 @@ pub(crate) const DEFAULT_TYPES: &[(&str, &[&str])] = &[
         ".zprofile", "zprofile",
         ".zshrc", "zshrc",
         // Extensions
-        "*.bash", "*.csh", "*.ksh", "*.sh", "*.tcsh", "*.zsh",
+        "*.bash", "*.env", "*.csh", "*.ksh", "*.sh", "*.tcsh", "*.zsh",
     ]),
     ("slim", &["*.skim", "*.slim", "*.slime"]),
     ("smarty", &["*.tpl"]),
@@ -306,9 +313,8 @@ pub(crate) const DEFAULT_TYPES: &[(&str, &[&str])] = &[
     ("texinfo", &["*.texi"]),
     ("textile", &["*.textile"]),
     ("tf", &[
-        "*.tf", "*.auto.tfvars", "terraform.tfvars", "*.tf.json",
-        "*.auto.tfvars.json", "terraform.tfvars.json", "*.terraformrc",
-        "terraform.rc", "*.tfrc",
+        "*.tf", "*.tf.json", "*.tfvars", "*.tfvars.json",
+        "*.terraformrc", "terraform.rc", "*.tfrc",
     ]),
     ("thrift", &["*.thrift"]),
     ("toml", &["*.toml"]),
@@ -316,6 +322,7 @@ pub(crate) const DEFAULT_TYPES: &[(&str, &[&str])] = &[
     ("twig", &["*.twig"]),
     ("txt", &["*.txt"]),
     ("typoscript", &["*.typoscript"]),
+    ("typst", &["*.typ"]),
     ("usd", &["*.usd", "*.usda", "*.usdc"]),
     ("v", &["*.v", "*.vsh"]),
     ("vala", &["*.vala"]),

{typos-1.37.3 → typos-1.38.0}/crates/typos-dict/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "typos-dict"
-version = "0.13.8"
+version = "0.13.9"
 description = "Source Code Spelling Correction"
 readme = "README.md"
 categories = ["development-tools", "text-processing"]