Agent Skills › chrisbanes/skills › kotlin-api-design

kotlin-api-design

GitHub

提供 Kotlin API 设计指导，涵盖函数所有权、值类、多平台边界及重构场景，旨在优化代码结构与领域语义表达。

skills/kotlin-api-design/SKILL.md chrisbanes/skills

Trigger Scenarios

设计或审查 Kotlin 函数归属与扩展函数定义单字段领域类型或数据类处理 Kotlin Multiplatform expect/actual 声明

Install

npx skills add chrisbanes/skills --skill kotlin-api-design -g -y

More Options

Use without installing

npx skills use chrisbanes/skills@kotlin-api-design

指定 Agent (Claude Code)

npx skills add chrisbanes/skills --skill kotlin-api-design -a claude-code -g -y

安装 repo 全部 skill

npx skills add chrisbanes/skills --all -g -y

预览 repo 内 skill

npx skills add chrisbanes/skills --list

SKILL.md

Frontmatter

{
    "name": "kotlin-api-design",
    "description": "Use when designing or reviewing Kotlin function ownership, member or extension functions, factories, single-field domain types, value classes, data classes, Kotlin Multiplatform expect\/actual declarations, or platform service boundaries."
}

Kotlin API design

Core principle

Place behavior, types, and platform seams where their meaning is clearest to callers; use the smallest public abstraction that preserves domain language and platform independence.

Procedure

Name the domain concept, its owning type or module, and the callers that need to depend on it.
Choose function ownership before adding an extension, factory, helper, or service layer.
Represent a single-field domain concept with the smallest type that preserves its semantic and interop contract.
Keep shared code semantic; put native SDK and platform details behind an interface or a narrowly justified expect/actual boundary.
Read the focused reference for every material API decision below.
Finish when the public surface states domain intent, platform details remain at leaves, and callers do not depend on convenience abstractions with no clear owner.

Topic router

Signal	Read
Member vs top-level, extension, factory, service, or receiver choice	Function ownership
Primitive obsession, one-field domain type, `@JvmInline value class`, data class, interop, or Compose stability	Value classes
Source sets, platform services, native SDKs, files, sensors, permissions, Compose Multiplatform interop, or expect/actual	Multiplatform boundaries
Branching and guard-condition shape	Kotlin control flow

RED/GREEN agent scenarios

RED adds an extension on String to hide repository behavior. GREEN gives the behavior a domain owner or service with a meaningful dependency boundary.
Novel case: shared UI needs a platform permission service. GREEN preserves a semantic shared contract and places platform SDK calls at the native leaf.
Counterexample: an internal helper has one obvious owning class. GREEN keeps it a member instead of extracting a factory or value type for ceremony.