typescript — правило для Cursor: стандарты TypeScript в проекте
Правило задаёт агенту Cursor единый стиль TypeScript: типы, имена, обработку ошибок. Пригодится, когда в проекте несколько разработчиков и код пишется вперемешку.
.cursor/rules/typescript.mdcЧто делает typescript
Правило описывает, как писать типы: интерфейсы для объектов, type для объединений и mapped-типов, unknown вместо any. Строгий режим в tsconfig.json — часть требований, а не совет.
Имена тоже зафиксированы: PascalCase для типов, camelCase для переменных и функций, UPPER_CASE для констант, префикс Props у пропсов React-компонентов. Типы советует держать рядом с местом использования, общие — выносить в каталог types и собирать через index.ts.
Дальше идут функции и ошибки: явные возвращаемые типы у публичных функций, async/await вместо цепочек промисов, свои классы ошибок для доменных случаев, проверка на null. Есть и раздел про паттерны — Builder, Repository, Factory, внедрение зависимостей. Правило подключается через globs **/*.ts, **/*.tsx, **/*.d.ts, поэтому затрагивает только файлы TypeScript и не трогает остальной код.
Какие задачи решает
- договориться о едином стиле типов в команде
- убрать
anyиз нового кода - разложить общие типы по каталогам
- описать обработку ошибок через свои классы
- задать имена пропсов React-компонентов
Примеры запросов агенту
- Опиши интерфейс для ответа API и положи его в каталог
types - Перепиши эту функцию на
async/awaitи добавь явный возвращаемый тип - Замени
anyнаunknownи добавь проверку типа перед использованием
Как установить typescript
Вручную: положить файлы
.cursor/rules/typescript.mdcВо frontmatter: description, globs, alwaysApply
Вручную: положить файлы
.claude/rules/typescript.mdПоле paths во frontmatter ограничивает файлы: globs из источника → paths
AGENTS.md
Codex читает AGENTS.md: вставьте текст правила туда
Вручную: положить файлы
.github/instructions/typescript.instructions.mdПоле applyTo задаёт, к каким файлам применять: globs из источника → applyTo
Вручную: положить файлы
.devin/rules/typescript.mdВручную: положить файлы
.clinerules/typescript.mdПо шагам, с командами для каждой платформы: Cursor rules: файлы .mdc, четыре режима и замена .cursorrules
Из того же набора68
Похожие
Рядом в теме «Языки программирования»
Все правила IDE по теме «Языки программирования» →Вопросы о typescript
Как установить правило typescript в Cursor?
Создайте файл .cursor/rules/typescript.mdc и вставьте в него содержимое правила.
Что делает правило typescript?
Задаёт агенту Cursor стандарты TypeScript: интерфейсы вместо типов для объектов, camelCase и PascalCase в именах, свои классы ошибок, явные возвращаемые типы.
На какие файлы распространяется правило?
На файлы по маскам **/*.ts, **/*.tsx и **/*.d.ts — остальной код правило не затрагивает.
Исходный текст
typescript.mdc · CC0-1.0
--- description: "TypeScript coding standards and best practices for modern web development" globs: **/*.ts, **/*.tsx, **/*.d.ts alwaysApply: false --- # TypeScript Best Practices ## Type System - Prefer interfaces over types for object definitions - Use type for unions, intersections, and mapped types - Avoid using `any`, prefer `unknown` for unknown types - Use strict TypeScript configuration - Leverage TypeScript's built-in utility types - Use generics for reusable type patterns ## Naming Conventions - Use PascalCase for type names and interfaces - Use camelCase for variables and functions - Use UPPER_CASE for constants - Use descriptive names with auxiliary verbs (e.g., isLoading, hasError) - Prefix interfaces for React props with 'Props' (e.g., ButtonProps) ## Code Organization - Keep type definitions close to where they're used - Export types and interfaces from dedicated type files when shared - Use barrel exports (index.ts) for organizing exports - Place shared types in a `types` directory - Co-locate component props with their components ## Functions - Use explicit return types for public functions - Use arrow functions for callbacks and methods - Implement proper error handling with custom error types - Use function overloads for complex type scenarios - Prefer async/await over Promises ## Best Practices - Enable strict mode in tsconfig.json - Use readonly for immutable properties - Leverage discriminated unions for type safety - Use type guards for runtime type checking - Implement proper null checking - Avoid type assertions unless necessary ## Error Handling - Create custom error types for domain-specific errors - Use Result types for operations that can fail - Implement proper error boundaries - Use try-catch blocks with typed catch clauses - Handle Promise rejections properly ## Patterns - Use the Builder pattern for complex object creation - Implement the Repository pattern for data access - Use the Factory pattern for object creation - Leverage dependency injection - Use the Module pattern for encapsulation
© PatrickJS · CC0-1.0 · PatrickJS/awesome-cursorrules