Skip to content

Commit 932e6fa

Browse files
committed
add typo rules and configuration
1 parent 969f7b9 commit 932e6fa

File tree

1 file changed

+73
-0
lines changed

1 file changed

+73
-0
lines changed

_typos.toml

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
[default]
2+
# Regex patterns to ignore
3+
extend-ignore-re = [
4+
"\\bUE\\b", # Unreal Engine abbreviation
5+
"\\bUE_LOG\\b", # Unreal Engine logging macro
6+
"\\bue4\\b", # Unreal Engine 4
7+
"\\bue5\\b", # Unreal Engine 5
8+
"\\bue\\d+\\b", # Any UE version (ue5, ue6, etc.)
9+
]
10+
11+
[files]
12+
# Files and patterns to exclude from spell checking
13+
extend-exclude = [
14+
# Design and binary files
15+
"*.excalidraw", # Diagram files contain random IDs
16+
"*.png",
17+
"*.jpg",
18+
"*.jpeg",
19+
"*.gif",
20+
"*.svg",
21+
"*.webp",
22+
23+
# Data and configuration files
24+
"*.json", # JSON files have many false positives
25+
"*.lock", # Package lock files
26+
"yarn.lock", # Yarn lock file
27+
"package-lock.json", # NPM lock file
28+
29+
# Documentation assets
30+
"public/_platforms/*.json", # Platform metadata
31+
"public/pdfs/*.pdf", # PDFs can't be edited programmatically
32+
33+
# Build artifacts and dependencies
34+
".next/**", # Next.js build output
35+
"node_modules/**", # Dependencies
36+
"dist/**", # Distribution builds
37+
"build/**", # Build output
38+
]
39+
40+
[default.extend-words]
41+
# Technical terms and product names that are spelled correctly
42+
# .NET ecosystem
43+
Paket = "Paket" # .NET package manager (legitimate tool)
44+
paket = "paket" # .NET package manager CLI command
45+
46+
# Platform-specific terms
47+
ITMS = "ITMS" # Apple error code prefix (legitimate)
48+
SEH = "SEH" # Structured Exception Handling (Windows API)
49+
EDE = "EDE" # Cipher name component (3DES_EDE_CBC_SHA)
50+
UE = "UE" # Unreal Engine abbreviation
51+
UE4 = "UE4" # Unreal Engine 4
52+
UE5 = "UE5" # Unreal Engine 5
53+
54+
# Cloud/Infrastructure
55+
nodejs_als = "nodejs_als" # Cloudflare compatibility flag (correct spelling)
56+
als = "als" # Part of nodejs_als flag
57+
58+
# Common abbreviations in tech docs
59+
DSN = "DSN" # Data Source Name (Sentry)
60+
DSNs = "DSNs" # Plural
61+
SDK = "SDK" # Software Development Kit
62+
SDKs = "SDKs" # Plural
63+
API = "API" # Application Programming Interface
64+
APIs = "APIs" # Plural
65+
MCP = "MCP" # Model Context Protocol
66+
NPM = "NPM" # Node Package Manager
67+
68+
# Code identifiers that are intentionally "misspelled" or match external systems
69+
# Note: These should ONLY include cases where the spelling is intentional
70+
# (e.g., matching an external API/constant name we don't control)
71+
childs = "childs" # Intentional variable name in mdx-deflist.ts
72+
aso = "aso" # Intentional variable name in utils.ts (short for "a sidebar order")
73+
MIGRATED_GETTING_STARTD_DOCS = "MIGRATED_GETTING_STARTD_DOCS" # Matches actual constant in Sentry backend (external) https://github.com/getsentry/sentry/blob/c2d4d527dcf640b616c73921a1294834720c76bd/src/sentry/models/project.py#L54

0 commit comments

Comments
 (0)