typos.toml

  1[files]
  2ignore-files = true
  3ignore-hidden = false
  4extend-exclude = [
  5    ".git/",
  6
  7    # Typewriter model names used for agent branch names aren't typos.
  8    "crates/agent_ui/src/branch_names.rs",
  9
 10    # Contributor names aren't typos.
 11    ".mailmap",
 12
 13    # File suffixes aren't typos.
 14    "crates/theme/src/icon_theme.rs",
 15    "crates/extensions_ui/src/extension_suggest.rs",
 16
 17    # Some mock data is flagged as typos.
 18    "crates/assistant_tools/src/web_search_tool.rs",
 19
 20    # Suppress false positives in database schema.
 21    "crates/collab/migrations/20251208000000_test_schema.sql",
 22
 23    # Not our typos.
 24    "crates/livekit_api/",
 25    # Vim makes heavy use of partial typing tables.
 26    "crates/vim/",
 27    # Editor and file finder rely on partial typing and custom in-string syntax.
 28    "crates/file_finder/src/file_finder_tests.rs",
 29    "crates/editor/src/editor_tests.rs",
 30    "crates/editor/src/edit_prediction_tests.rs",
 31    # There are some names in the test data that are incorrectly flagged as typos.
 32    "crates/git/test_data/blame_incremental_complex",
 33    "crates/git/test_data/golden/blame_incremental_complex.json",
 34    # We have some base64-encoded data that is incorrectly being flagged.
 35    "crates/rpc/src/auth.rs",
 36    # glsl isn't recognized by this tool.
 37    "extensions/glsl/languages/glsl/",
 38    # Protols is the name of the language server.
 39    "extensions/proto/extension.toml",
 40    "extensions/proto/src/language_servers/protols.rs",
 41    # Windows likes its abbreviations.
 42    "crates/gpui_windows/src/directx_renderer.rs",
 43    "crates/gpui_windows/src/events.rs",
 44    "crates/gpui_windows/src/direct_write.rs",
 45    "crates/gpui_windows/src/window.rs",
 46    # Some typos in the base mdBook CSS.
 47    "docs/theme/css/",
 48    # Automatically generated JS.
 49    "docs/theme/c15t@*.js",
 50    # Spellcheck triggers on `|Fixe[sd]|` regex part.
 51    "script/danger/dangerfile.ts",
 52    # Eval examples for prompts and criteria
 53    "crates/eval/src/examples/",
 54    # File type extensions are not typos
 55    "crates/zed/resources/windows/zed.iss",
 56    # typos-cli doesn't understand our `vˇariable` markup
 57    "crates/editor/src/hover_links.rs",
 58    # typos-cli doesn't understand `setis` is intentional test case
 59    "crates/editor/src/code_completion_tests.rs",
 60    # Linux repository structure is not a valid text, hence we should not check it for typos
 61    "crates/project_panel/benches/linux_repo_snapshot.txt",
 62    # Some multibuffer test cases have word fragments that register as typos
 63    "crates/multi_buffer/src/multi_buffer_tests.rs",
 64    # Macos apis
 65    "crates/gpui_macos/src/dispatcher.rs",
 66    # Tests contain partially incomplete words (by design)
 67    "crates/edit_prediction_cli/src/split_commit.rs",
 68    # Eval examples contain intentionally partial words (e.g. "secur" for "secure")
 69    "crates/edit_prediction_cli/evals/",
 70    # Tests contain `baˇr` that cause `"ba" should be "by" or "be".`-like false-positives
 71    "crates/editor/src/document_symbols.rs",
 72]
 73
 74[default]
 75extend-ignore-re = [
 76    # PNG is a file format, not a typo
 77    "PNG",
 78    'cl\[ist]',
 79    '\[lan\]guage',
 80    '"ba"',
 81    "doas",
 82    # ProtoLS crate with tree-sitter Protobuf grammar.
 83    "protols",
 84    # x11rb SelectionNotifyEvent struct field
 85    "requestor",
 86    # macOS version
 87    "Big Sur",
 88    # Not an actual typo but an intentionally invalid color, in `color_extractor`
 89    "#fof",
 90    # Stripped version of reserved keyword `type`
 91    "typ",
 92    # AMD GPU Services
 93    "ags",
 94    # AMD GPU Services
 95    "AGS",
 96    # "noet" is a vim variable (ideally to ignore locally)
 97    "noet",
 98    # Yarn Plug'n'Play
 99    "PnP"
100]
101check-filename = true