
typescript-best-practices
TypeScript best practices for edits.
- version
- 0.1.6
- GitHub stars
- 347
Install
/plugin install typescript-best-practices@khanelinix-ai-toolsRun it inside Claude Code after adding the marketplace with /plugin marketplace add khaneliman/khanelinix.
Contents
Discovered from sourceSkills 1
TypeScript best practices
Apply type-system-discipline from engineering-principles first. This skill
grounds that principle in TypeScript syntax.
| Rule | Summary |
|---|---|
| Discriminated unions | Model variants with a kind literal discriminant so impossible states can't be represented. No optional-field bags. |
| Branded types | Brand primitives with & { readonly __brand: "X" } so they can't be mixed up. Validate once at creation. |
| Constructive modeling | Build the shape so the illegal value can't be constructed. [T, ...T[]] for non-empty, [T, T][] for even length, start plus duration for a range. Not a runtime guard, not a wish for refinement types. |
| Simplest total type | Keep T[] while every operation on it stays total. Strengthen to NonEmpty<T> only where the loose type forces !, a cast, or a "should never happen" throw. |
unknown over any | External data is unknown. any disables type checking everywhere it touches. |
| Avoid unchecked assertions | Type assertions add no runtime validation. Prefer narrowing; assert only when evidence establishes the claimed type. |
| Narrowing hierarchy | Discriminant switch > in operator > typeof/instanceof > user-defined type guard > as. |
| Type guards | Must verify the claim. A lying guard is worse than as because the bug hides behind a name that says it's safe. Name them isX or hasX. |
| Exhaustiveness | Inline const _exhaustive: never = x; in default arms so the compiler errors when a new variant is added. |
satisfies over as | Validates the value without widening literal types. |
| Boundary validation | Validate where data crosses in; trust types inside. Apply boundary-discipline from engineering-principles. |
| Schema-derived types | Reach for Pick/Omit/Parameters/ReturnType/Awaited/typeof before declaring a new interface. |
| Object args | Pass objects, not positional, so argument order is self-documenting. Skip on hot paths (per-frame render, tokenizers, parsers). |
| Real tests | Don't mock what you can run. Prefer the framework's real test primitives with leak/disposable checks, and verify UI in a running build. Mock only what you can't run locally. |
| Structured telemetry | Prefer structured logger diagnostics with enough context to debug from an id. No console.log in shipped code. |
Examples: references/patterns.md.
Sponsors
Details
- Marketplace
- khaneliman/khanelinix
- Source
- modules/common/ai-tools/skills/typescript-best-practices
- Author
- khaneliman
- Category
- Developer Tools
More from khaneliman/khanelinix
All 43- unslopv0.1.7
- verification-harnessv0.1.5
- whyv0.1.6
- ai-tools-architectv0.1.21
- architectv0.1.7
- arenav0.1.5
- bevy-toolkitv0.1.6
- blast-radiusv0.1.6
- blender-toolkitv0.3.2
- develop-web-gamev0.1.7
- diagnosing-bugsv0.1.3
- dotnet-toolkitv0.1.2
- engineering-principlesv0.1.22
- engineering-workflowv0.1.27
- figure-it-outv0.1.10
- git-toolkitv0.1.15
- github-toolkitv0.1.33
- howv0.1.7
- interrogatev0.1.10
- jj-toolkitv0.1.8
- lua-toolkitv0.2.0
- mcp-builderv0.1.6
- memory-profilerv0.1.6
- microsoft-teamsv0.1.0