compose-guard - GitLite

KO | EN

gitlite — search

#machine-learning #computer-vision #ios #macos #pdf #kotlin #self-hosted #react-native #ruby #postgresql

compose-guard

(★ 115)

Real-time detection of Jetpack Compose best practices and rule violations directly in Android Studio.

파일 탐색기

ZIP 다운로드

- - Bug_report.md
  - Feature_request.md
- - android.yml
  - intellij-plugin.yml
- CODEOWNERS
- pull_request_template.md
- app.run.xml
- Build Plugin.run.xml
- Clean Build Plugin.run.xml
- Run Plugin in Android Studio.run.xml
- Run Plugin Tests.run.xml
- Verify Plugin.run.xml
- build.gradle.kts
- proguard-rules.pro
- dashboard.png
- disablerules.png
- logo.svg
- preview.png
- build.gradle.kts
- CHANGELOG.md
- RELEASE_NOTES.md
- - gradle-wrapper.jar
  - gradle-wrapper.properties
- libs.versions.toml
- ComposeGuardTestSample.kt
- copyright.kt
- copyright.kts
- copyright.xml
.editorconfig
.gitignore
build.gradle.kts
compose-guard.zip
DOCUMENTATION.md
gradle.properties
gradlew
gradlew.bat
LICENSE
README.md
renovate.json
rules.md
settings.gradle.kts

# CDN으로 사용하기

jsDelivr

jsDelivr는 공개 GitHub 리포지토리를 별도 설정 없이 CDN으로 즉시 서빙합니다. 버전과 파일을 고르면 웹페이지에 바로 붙일 수 있는 링크와 예시 코드가 만들어집니다.

버전

파일

링크

예시

명령어 용어집

이 문서에서 사용된 명령어를 모아봤습니다. 낯선 명령어가 있다면 펼쳐서 확인해보세요.

🔍

`git checkout`

설명 보기 ▼

Checkout a branch or paths to the working tree.

git checkout -b {{branch_name}}

Create and switch to a new branch:

git checkout -b {{branch_name}} {{reference}}

Create and switch to a new branch based on a specific reference (branch, remote/branch, tag are examples of valid references):

git checkout {{branch_name}}

Switch to an existing local branch:

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<p align="center">
  <img src="art/logo.svg" width="120px"/>
</p>

<h1 align="center">ComposeGuard</h1>

<p align="center">
  <a href="https://plugins.jetbrains.com/plugin/29308-composeguard"><img alt="JetBrains Plugin" src="https://img.shields.io/jetbrains/plugin/v/29308-composeguard?label=JetBrains%20Marketplace"/></a>
  <a href="https://plugins.jetbrains.com/plugin/29308-composeguard"><img alt="Downloads" src="https://img.shields.io/jetbrains/plugin/d/29308-composeguard?label=Downloads"/></a>
  <a href="https://opensource.org/licenses/Apache-2.0"><img alt="License" src="https://img.shields.io/badge/License-Apache%202.0-blue.svg"/></a>
  <a href="https://github.com/androidpoet"><img alt="Profile" src="https://img.shields.io/badge/GitHub-androidpoet-blue"/></a>
  <a href="https://androidweekly.net/issues/issue-705"><img alt="Android Weekly" src="https://androidweekly.net/issues/issue-705/badge"/></a>
</p>

<p align="center">
  <b>Catch Jetpack Compose mistakes as you type</b> — 37 best-practice rules from the
  <a href="https://mrmans0n.github.io/compose-rules/">Compose Rules</a> guidelines, surfaced live in
  Android Studio &amp; IntelliJ IDEA with inline highlights, gutter icons, and one-click fixes.
</p>

---

## Preview

<p align="center">
  <img src="art/preview.png" alt="ComposeGuard Preview"/>
</p>

## Why ComposeGuard?

The [Compose Rules](https://mrmans0n.github.io/compose-rules/) catch the subtle mistakes that hurt
Compose code — missing `Modifier` parameters, un-remembered state, unstable collections, reused
modifiers, and dozens more. ComposeGuard brings those checks **into the editor**, so you fix them
while the code is still fresh instead of discovering them in a build log or a code review.

- ⚡ **Instant** — analysis runs as you type; no build, no Gradle task, no CI round-trip.
- 🎯 **Accurate** — rules are PSI-based and tuned to avoid false positives on valid patterns
  (overrides, scoped slots, mutually-exclusive branches, run-once effects, …).
- 🛠 **Actionable** — most violations come with a quick fix (<kbd>Alt</kbd>+<kbd>Enter</kbd>) and a
  detailed explanation of *why* it matters.
- 🎚 **Configurable** — enable/disable any rule or whole category, or suppress per declaration.

## Table of Contents

- [Features](#features)
- [Installation](#installation)
- [Quick Start](#quick-start)
- [Suppressing Rules](#suppressing-rules)
- [Rule Reference](#rule-reference)
- [Statistics Dashboard](#statistics-dashboard)
- [Configuration](#configuration)
- [Requirements &amp; Compatibility](#requirements--compatibility)
- [Contributing](#contributing)
- [Credits](#credits)
- [License](#license)

## Features

- **Real-time highlighting** — violations appear as colored underlines while you edit.
- **Gutter icons** — a color-coded dot per `@Composable` summarizes its status at a glance:
  - 🔴 Error &nbsp;&nbsp; 🟠 Warning &nbsp;&nbsp; ⚪ Weak warning &nbsp;&nbsp; 🔵 Info
- **Inline hints** — compact badges next to function names show rule violations.
- **Hover tooltips** — every violation explains the problem, the reasoning, and the fix.
- **Quick fixes** — rename, add a `modifier` parameter, wrap in `remember`, switch to a type-specific
  state, make a preview private, swap to an immutable collection, and more.
- **37 rules across 6 categories** — see the full [Rule Reference](#rule-reference).

## Installation

<a href="https://plugins.jetbrains.com/plugin/29308-composeguard"><img src="https://img.shields.io/badge/Install-JetBrains%20Marketplace-blue?style=for-the-badge&logo=jetbrains" alt="Install from Marketplace"/></a>

1. Open **Android Studio** or **IntelliJ IDEA**.
2. Go to **Settings** → **Plugins** → **Marketplace**.
3. Search for **ComposeGuard**.
4. Click **Install** and restart when prompted.

Or install directly from the [JetBrains Marketplace](https://plugins.jetbrains.com/plugin/29308-composeguard).

## Quick Start

Once installed, ComposeGuard automatically analyzes any Kotlin file containing `@Composable`
functions — no configuration required. Here are a few things it catches:

```kotlin
// 🟠 Naming: Unit-returning composables should be PascalCase
@Composable
fun userCard(user: User) { }              // → rename to "UserCard"

// 🟠 Modifier: public UI composables should expose a Modifier
@Composable
fun ProductCard(product: Product) {       // → add `modifier: Modifier = Modifier`
    Column { Text(product.name) }
}

// 🔴 State: state must be remembered
@Composable
fun Counter() {
    val count = mutableStateOf(0)         // → wrap in remember { }
}

// 🟠 Stricter: prefer stable collections
@Composable
fun ItemList(items: List<Item>) { }       // → use ImmutableList<Item>
```

Hover any highlight for the full explanation, or press <kbd>Alt</kbd>+<kbd>Enter</kbd> to apply a fix.

## Suppressing Rules

To intentionally allow a violation, annotate the declaration with `@Suppress` using the **rule id**
(the same id shown in the warning, e.g. `ModifierRequired`). The quick fix can insert this for you:

```kotlin
@Suppress("ModifierRequired")
@Composable
fun SplashLogo() {
    Image(painterResource(R.drawable.logo), contentDescription = null)
}

// Multiple rules at once:
@Suppress("ModifierRequired", "ComposableNaming")
@Composable
fun splash() { /* ... */ }
```

Suppression works at the function, property, or class level. To turn rules off project-wide instead,
use [Configuration](#configuration).

## Rule Reference

ComposeGuard ships **37 rules** based on the [Compose Rules](https://mrmans0n.github.io/compose-rules/)
guidelines. Severity legend: 🔴 Error · 🟠 Warning · ⚪ Weak warning · 🔵 Info.

### Naming

| Rule id | Checks | Severity |
|---------|--------|:--------:|
| `ComposableNaming` | Unit-returning composables use PascalCase; value-returning use camelCase | 🟠 |
| `CompositionLocalNaming` | `CompositionLocal` properties are prefixed with `Local` | 🟠 |
| `PreviewNaming` | `@Preview` functions reference `Preview` in their name | ⚪ |
| `MultipreviewNaming` | Multipreview annotation classes reference `Preview` | ⚪ |
| `ComposableAnnotationNaming` | `@ComposableTargetMarker` annotations end with `Composable` | ⚪ |
| `EventParameterNaming` | Event lambdas use present tense (`onClick`, not `onClicked`) | ⚪ |

### Modifiers

| Rule id | Checks | Severity |
|---------|--------|:--------:|
| `ModifierRequired` | Public, UI-emitting composables expose a `Modifier` parameter | 🟠 |
| `ModifierDefaultValue` | `modifier` parameters default to `Modifier` | 🟠 |
| `ModifierNaming` | The main modifier is named `modifier`; others follow `xModifier` | ⚪ |
| `ModifierTopMost` | The modifier is applied to the root-most layout | 🟠 |
| `ModifierReuse` | The same modifier isn't applied to multiple live nodes | 🟠 |
| `ModifierOrder` | Modifier chain order is intentional (e.g. `padding` before `clickable`) | 🟠 |
| `AvoidComposed` | Prefer `Modifier.Node` over the deprecated `composed { }` factory | 🟠 |

### State

| Rule id | Checks | Severity |
|---------|--------|:--------:|
| `RememberState` | `mutableStateOf` and friends are wrapped in `remember { }` | 🔴 |
| `TypeSpecificState` | Primitives use `mutableIntStateOf` / `mutableFloatStateOf` / … | 🟠 |
| `DerivedStateOfCandidate` | Values computed from state use `derivedStateOf` | 🟠 |
| `FrequentRecomposition` | Hot observable sources use lifecycle-aware collection | 🟠 |
| `DeferStateReads` | Fast-changing state reads are deferred to lambda modifiers | 🟠 |
| `HoistState` | State is hoisted to the appropriate level | 🔵 |
| `MutableStateParameter` | Pass `value` + callback instead of a `MutableState` parameter | 🟠 |

### Parameters

| Rule id | Checks | Severity |
|---------|--------|:--------:|
| `ParameterOrdering` | Order is required → `modifier` → optional → trailing content | ⚪ |
| `TrailingLambda` | The content slot is the trailing lambda; event handlers are not | ⚪ |
| `MutableParameter` | Avoid inherently mutable types (`MutableList`, `ArrayList`, …) as parameters | 🟠 |
| `ExplicitDependencies` | Make injected ViewModels explicit parameters | ⚪ |
| `ViewModelForwarding` | Don't forward a ViewModel into another composable | 🟠 |

### Composables &amp; Effects

| Rule id | Checks | Severity |
|---------|--------|:--------:|
| `ContentEmission` | A composable emits content **or** returns a value, not both | 🟠 |
| `MultipleContentEmitters` | A composable emits a single piece of content | 🟠 |
| `ContentSlotReused` | A content slot isn't invoked more than once on the same pass | 🟠 |
| `EffectKeys` | Changing captured values are passed as effect keys | 🟠 |
| `LambdaParameterInEffect` | Lambda parameters used in effects are wrapped in `rememberUpdatedState` | 🟠 |
| `MovableContent` | `movableContentOf` is remembered | 🔴 |
| `PreviewVisibility` | `@Preview` composables are `private` | 🟠 |
| `ComponentDefaultsVisibility` | A `<Component>Defaults` object matches its composable's visibility | 🟠 |
| `LazyListMissingKey` | Lazy list items provide a stable `key` | 🟠 |
| `LazyListContentType` | Heterogeneous lazy lists set a `contentType` | 🔵 |

### Stricter

| Rule id | Checks | Severity |
|---------|--------|:--------:|
| `UnstableCollections` | Prefer `ImmutableList` / `PersistentList` over `List`, `Set`, `Map` | 🟠 |
| `Material2Usage` | Migrate `androidx.compose.material` (M2) imports to Material 3 | 🔵 |

> Suppress any rule with `@Suppress("<RuleId>")`, or toggle it in **Settings → Tools → ComposeGuard**.

## Statistics Dashboard

ComposeGuard includes a tool window that tracks rule violations across your project.

<p align="center">
  <img src="art/dashboard.png" alt="ComposeGuard Statistics Dashboard"/>
</p>

- **Real-time statistics** — violation counts update as you code.
- **Category breakdown** — see violations grouped by rule category.
- **Rule-level details** — drill into specific rules.
- **Project overview** — track overall code-quality trends.

Open it from **View** → **Tool Windows** → **ComposeGuard Statistics**.

## Configuration

Configure ComposeGuard at **Settings** → **Tools** → **ComposeGuard**.

<p align="center">
  <img src="art/disablerules.png" alt="ComposeGuard Settings - Disable Rules"/>
</p>

- **Enable ComposeGuard** — master toggle for the whole plugin.
- **Display options** — toggle gutter icons and inlay hints.
- **Rule configuration** — enable/disable individual rules or entire categories.

### Adopting ComposeGuard in an existing codebase

Adding the plugin to a large legacy project? Roll it out gradually instead of facing every warning at once:

1. Start with the **Stricter** category off (`Material2Usage`, `UnstableCollections`).
2. Enable categories one at a time as you refactor — the category checkbox toggles the whole group.
3. Use `@Suppress("<RuleId>")` for individual, intentional exceptions.

## Requirements &amp; Compatibility

- **IntelliJ IDEA 2024.2+** or **Android Studio Ladybug (2024.2)+**
- The bundled **Kotlin** plugin (enabled by default)

| ComposeGuard | Supported IDE builds |
|--------------|----------------------|
| 1.2.x | 2024.2 – 2026.2 |

## Contributing

Contributions are welcome — issues and pull requests both.

1. Fork the repository.
2. Create a feature branch: `git checkout -b feature/amazing-feature`.
3. Make your change and add tests (`./gradlew :compose-guard:test`).
4. Commit and push, then open a Pull Request.

## Credits

Built on the excellent [Compose Rules](https://mrmans0n.github.io/compose-rules/) guidelines by
[Nacho Lopez (mrmans0n)](https://github.com/mrmans0n).

## Find this repository useful? :heart:
Support it by joining __[stargazers](https://github.com/androidpoet/compose-guard/stargazers)__ for this repository. :star: <br>
Also, __[follow me](https://github.com/androidpoet)__ on GitHub for my next creations! 🤩

## License

```
Designed and developed by 2025 androidpoet (Ranbir Singh)

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```

---

<p align="center">
Made with ❤️ by <a href="https://github.com/androidpoet">androidpoet</a>
</p>