Skip to main content

typescript-style-guide

Apply, review, and explain the opinionated conventions in the TypeScript Style Guide. Use automatically only when TypeScript conventions are part of the requested task, including type modelling, discriminated unions, function APIs, variables and state, naming, source organization, React props, component APIs, state management, data flow, or tests. Do not use for styling or layout alone.

来源信息

仓库
mkosir/typescript-style-guide
最近来源活动
2026年8月25日 08:53
检测到的 SKILL.md 语言
英语
星标
783
分支
37

安装方式

默认使用会先检查来源的 Prompt;你也可以切换为直接命令,或下载本地副本。

检查来源文件

决定是否安装前,请先阅读 SKILL.md,以及 SkillsMP 当前展示的配套文件。

文件资源管理器
9 个文件

正在显示 SKILL.md

SKILL.md
来源说明 · 只读预览
name
typescript-style-guide
description
Apply, review, and explain the opinionated conventions in the TypeScript Style Guide. Use automatically only when TypeScript conventions are part of the requested task, including type modelling, discriminated unions, function APIs, variables and state, naming, source organization, React props, component APIs, state management, data flow, or tests. Do not use for styling or layout alone.
# TypeScript Style Guide Apply only the conventions relevant to the current task. Keep TypeScript, linters, and formatters responsible for rules they can enforce automatically. ## Workflow 1. Inspect the consuming repository's conventions and configuration. 2. Let explicit repository conventions take precedence over this opinionated guide. 3. Identify which guide topic applies. 4. Read only the reference for the task's primary guide topic. Read multiple references only when the task substantively spans multiple topics. 5. Apply, review, or explain the conventions in the context of the current task. 6. State important tradeoffs when a convention depends on context or judgment. ## Reference routing - Read [references/types.md](references/types.md) for type modelling, inference, readonly data, constants, template literal types, `any`, `unknown`, assertions, type errors, type definitions, arrays, type imports, and generated service types. This reference takes precedence for narrowing `unknown` and assertions, including their runtime null checks. - Read [references/discriminated-unions.md](references/discriminated-unions.md) for general discriminated-union modelling, narrowing, invalid states, exhaustiveness checking, required and optional object properties, application state with variant-specific data, function arguments, and React props. This reference takes precedence when discriminated unions concern application state, function arguments, or React props. - Read [references/functions.md](references/functions.md) for function responsibility, statelessness, purity, side effects, function arguments, function API design, and return types. - Read [references/variables.md](references/variables.md) when the task concerns variable declarations, simple literal-union state modelling, enum alternatives, or choosing how application state represents absence with `null` or `undefined`. Do not read it for incidental variables or runtime checks used only for type narrowing. - Read [references/naming.md](references/naming.md) for named exports, naming conventions, generic type parameters, React naming, comments, and TSDoc. - Read [references/source-organization.md](references/source-organization.md) for code collocation, feature-based organization, relative and absolute import paths, and frontend or backend project structure. Do not read it for type-only import semantics, which belong to Types. - Read [references/react.md](references/react.md) for React component and hook APIs, props-to-state, component typing and roles, data flow, state placement, and compound components. - Read [references/tests.md](references/tests.md) for test design, the Arrange-Act-Assert pattern, isolation, implementation details, mocking, test descriptions, and snapshots. ## Boundaries - Do not reimplement deterministic TypeScript, ESLint, or formatting checks. - Do not introduce unrelated conventions merely because this skill is active. - Treat guide conventions as defaults when the consuming repository is silent.
在 GitHub 查看