prasad-vennam/awesome-android-ai-agent-skills

android-ktlint-formatting

Use when formatting Kotlin code, enforcing the Android style guide, or configuring KtLint for Android.

查看源码

使用方法

  1. 复制安装命令,在自己的智能体环境安装前先检查源码包。
  2. 从原始文档核对所需工具、凭据和支持的宿主。
  3. 说明输入材料与期望交付物,并对照来源检查输出。
npx skills add https://github.com/prasad-vennam/awesome-android-ai-agent-skills --skill android-ktlint-formatting

开始前需了解

  • 安装不包含模型订阅、API 额度或访问文件的权限。
  • 仓库星数和安装量反映活跃情况,不等于独立质量或安全测试。
仓库原始内容

按源仓库内容呈现,保留标题、案例、代码、表格、链接以及原文引用的演示图片。

Android KtLint Formatting Excellence 🧹💎

Standardized formatting rules for Android developers based on the official Kotlin and Android Style Guides.

⚡ When to Use

  • Code Cleanup: Automatically reformatting messy files.
  • Pre-commit Audit: Ensuring the code is perfectly formatted before pushing.
  • CI/CD Configuration: Setting up a gatekeeper for code style.
  • New Project Setup: Initializing a project with the correct .editorconfig.

🏗️ Core Rules (Android Style)

1. Indentation

  • Use 4 spaces for indentation.
  • No TAB characters allowed.
  • Follow "Continuation Indents" for long method calls (8 spaces).

2. Imports

  • Rule: Avoid wildcard imports (import com.example.*).
  • Order alphabetically.
  • Group by java.*, kotlin.*, then external libraries.

3. Blank Lines

  • Single blank line between classes, properties, and methods.
  • NO trailing whitespace at the end of lines.
  • NO multiple blank lines.

4. Naming

  • Classes/Interfaces: PascalCase.
  • Properties/Variables: camelCase.
  • Functions: camelCase.
  • Constants: SCREAMING_SNAKE_CASE.

🛠️ Essential Commands

Check Formatting

bash
./gradlew ktlintCheck

Auto-Fix Formatting

  • Rule: ALWAYS run this before committing if formatting changes are extensive.
bash
./gradlew ktlintFormat

📜 Configuration (.editorconfig)

Ensure your project has a .editorconfig that KtLint reads:

ini
[*.{kt,kts}]
indent_size=4
insert_final_newline=true
max_line_length=120
ij_kotlin_allow_trailing_comma=true

🚀 Performance & Tips

  • [ ] IDE Integration: Install the "KtLint" or "Kotlin" plugin and enable "On Save" actions.
  • [ ] Trailing Comma: Use trailing commas for all multi-line collections and arguments for better diffs.
  • [ ] Imports Cleanup: Periodically run Alt+Enter → "Optimize Imports".

🧪 Verification Checklist

  • [ ] No Wildcards: All imports are explicit.
  • [ ] No Tabs: Only spaces.
  • [ ] EndOfLine: File ends with exactly one newline.
  • [ ] No Redundant Semicolons: Clean up all unnecessary ;.

🔗 Related Resources

按任务相关推荐

来自同一仓库

更多 Skills

全部 Skills