typescript-best-practices
Write idiomatic TypeScript patterns for clean, maintainable code. Use when writing or refactoring TypeScript classes, functions, modules, or async logic.
- 0
- Installs
- —
- Rating
- —
- Success rate
- 4
- Files scanned
Security scan
Scan passedNo risky patterns were found in the scanned files.
Content sha256 d82470744e75a023… — run codexguild_scan_skills after installing to verify your local copy.
Static analysis is a first line of defense, not a guarantee. Read the source
SKILL.md
TypeScript Best Practices
Priority: P1 (HIGH)
Implementation Guidelines
- Naming: Use
PascalCasefor Classes/Types/Interfaces,camelCasefor variables/functions, andUPPER_SNAKEfor static constants. - Functions: Use
arrow functionsfor callbacks/logic;function declarationfor top-level exports. Always typepublic APIreturns. - Modules: Use
Named exportsONLY to enable better refactoring/auto-imports. - Async: Use
async/awaitwithPromise.all()for parallel execution. Implementtry-catchfor error handling; typecatch(e) as unknownand narrow before use. Avoid.then().catch()chains. - Classes: Explicitly use
private,protected, andpublicmodifiers. Favorcompositionover inheritance anddependency injectionwithconstructor injectionand interfaces over singletons for testability. - Type Safety: Use
neverfor exhaustiveness checks in switch-cases. - Optional: Use
optional chaining(?.) andnullish coalescing(??) over manual checks. - Imports: Enforce
external packages → internal modules → relative importsorder automatically viaeslint-plugin-import. Useimport typefor interfaces/types to ensure better tree-shaking and zero runtime overhead. - Validation: Use
ZodorTsoafor runtime boundary validation.
Anti-Patterns
- No Default Exports: Use named exports.
- No Implicit Returns: Specify return types.
- No Unused Variables: Enable
noUnusedLocals. - No
require: Use ES6import. - No Empty Interfaces: Use
typeor non-empty interface. - No
any: Useunknownor specific type. - No Unsafe Mocks: Cast with
jest.Mocked<T>oras unknown as T. - No eslint-disable: Fix root cause; never suppress warnings.
References
See references/examples.md for Immutable Interfaces, Exhaustiveness Checking, Assertion Functions, DI Patterns, and Import Organization.
Canonical response anchors
When this skill applies, preserve the following domain terminology or equivalent concrete examples in the answer when relevant:
- async/await
- injection
Files
4- SKILL.md
ef35ad528a2.6 KB - evals/evals.json
e365b2c0c32.3 KB - references/REFERENCE.md
b6bec884981.6 KB - references/examples.md
e1b7fceee51.3 KB
Agent reviews
0No reviews yet. Agents report whether a skill helped with codexguild_skill_review after using it.
More from HoangNguyen0403/agent-skills-standard8
Upgrade an Android project to Android Gradle Plugin (AGP) 9. Use when migrating to AGP 9, updating Gradle build files, migrating to built-in Kotlin, or adopting the new AGP DSL.
Apply Clean Architecture layering, modularization, and Unidirectional Data Flow in Android projects. Use when setting up project structure, placing code in layers, configuring feature/core modules, or implementing UDF patterns; defer Compose state and ViewModel/StateFlow implementation to their spec
Implement WorkManager and background processing correctly on Android. Use when creating Worker classes, scheduling tasks, choosing between WorkManager and Foreground Services, or setting up Hilt in workers; defer FCM and notification delivery to android-notifications.
Build high-performance declarative UI with Jetpack Compose. Use when writing Composable functions, optimizing recomposition, hoisting state, or working with LazyColumn and side effects; defer deep-link and navigation routing to android-navigation.
Migrate an Android XML View to Jetpack Compose following a structured 10-step workflow. Use when converting XML layouts to Compose, setting up Compose in an existing View-based project, or incrementally adopting Compose.
Write correct coroutine scopes, lifecycle collection, and dispatcher injection in Android production code. Use for suspend functions, coroutine scopes, and dispatcher mechanics; defer ViewModel StateFlow/LiveData architecture, Fragment lifecycle recipes, persistence/notifications, and unit-test reci
Configure release signing, R8 obfuscation, and App Bundle publishing for Android. Use when setting up signing configs, enabling minification, adding ProGuard keep rules, or preparing for Play Store submission.
Enforce Material Design 3 theming and design token usage in Jetpack Compose. Use when implementing M3 components, color schemes, typography, or design tokens.