agentleFS
PL-Coding-GmbHPL-Coding-GmbH/Skills/skills/android-module-structure/SKILL.md

android-module-structure

Skill18 starsChanged 4 months agoMITView on GitHub

Module layout, dependency rules, and Gradle convention plugins for Android and Kotlin Multiplatform (KMP) projects. Use this skill whenever setting up a new Android/KMP project, deciding where a new module should live, asking "how should I structure this", creating a new feature module, adding a core submodule, configuring Gradle convention plugins, working with version catalogs, or making any decision about project-level architecture. Trigger on phrases like "set up the project", "add a module", "create a feature", "how should I structure", "project structure", "convention plugin", "build-logic", or "where does X live".

2 other projects use a version of this, 2 of them edited.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

1 rule. About 0 are common, 0 are distinctive, and 1 is very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈0

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Use version catalogs (libs.versions.toml) for all dependency and version management.

    line 66

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Android / KMP Module Structure

Core Philosophy

  • Feature-layered modularization: split by feature first, then by layer within each feature.
  • Clean Architecture layers: presentation → domain ← data. Domain is innermost and depends on nothing.
  • Code lives in a feature module unless it is needed by more than one feature — then it moves to the appropriate core submodule.
  • Features never depend on each other. Cross-feature shared data belongs in core:domain (domain models) or core:presentation (shared composables/UI logic), not in the owning feature.

Module Layout

:app
:build-logic                    ← Gradle convention plugins
:core:domain                    ← Shared domain models, repository interfaces, error types, Result
:core:data                      ← Shared data logic, Ktor HttpClient factory, shared DB schemas/DAOs
:core:presentation              ← Shared UI utilities (ObserveAsEvents, UiText, etc.)
:core:design-system             ← Reusable Compose components, colors, theme, typography
:feature:<name>:domain          ← Feature-specific domain models, repo interfaces, error types
:feature:<name>:data            ← Repo implementations, DTOs, mappers, Room DAOs
:feature:<name>:presentation    ← ViewModel, screen composables, state, actions, events

For standalone, self-contained concerns that involve meaningful complexity (multiple classes, configuration, or a non-trivial API surface), create a dedicated module under :core (e.g., :core:location, :core:analytics). Do not create a separate module for a single class or a trivial utility — that belongs in an existing core module instead.

A shared Room database is a good candidate for a dedicated :core:database module. It contains the @Database class, all entity definitions, all DAOs, and migrations. Feature modules that need DB access depend on :core:database directly, while features that don't need it remain decoupled.


Dependency Rules

LayerMay depend on
presentationdomain (own feature), core:domain, core:presentation, core:design-system
datadomain (own feature), core:domain, core:data
domaincore:domain only — never data or presentation
:appeverything (wires all modules)

Every layer and module may access core:domain.


Convention Plugins (:build-logic)

Define a convention plugin for every non-trivial Gradle config:

PluginPurpose
android-applicationApp module config (applicationId, versionCode, etc.)
android-libraryBase Android library config
android-featureAndroid library + Compose + Koin + shared feature deps bundled
domain-modulePure Kotlin/KMP module, no Android deps
composeCompose compiler + BOM
koinKoin dependency block
ktorKtor client + serialization
roomRoom + KSP config
kotlinx-serializationKotlinX Serialization plugin + dep

Use version catalogs (libs.versions.toml) for all dependency and version management. No hardcoded versions in build files.


Key Libraries

ConcernLibrary
DIKoin
NetworkingKtor Client
Local DBRoom
PreferencesDataStore
NavigationCompose Navigation (type-safe)
SerializationKotlinX Serialization (Ktor + Nav routes)
Image loadingCoil
LoggingKermit
AsyncCoroutines + Flow
Background tasksWorkManager — see android-background skill
Secretslocal.properties + BuildConfig (Android); BuildKonfig (KMP)
TestingJUnit5, Turbine, AssertK, kotlinx-coroutines-test
UI testingComposeTestRule

Checklist: Adding a New Feature Module

  • Create :feature:<name>:domain, :feature:<name>:data, :feature:<name>:presentation modules
  • Apply appropriate convention plugins to each module (domain-module, android-library/android-feature)
  • Verify no cross-feature dependencies are introduced
  • If logic is shared across 2+ features, extract to the appropriate core submodule

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.