First Commit

tools/templates/FeatureModule.json

@@ -0,0 +1 @@
+{"template":{"name":"","isDir":true,"placeholders":{"MODULE_NAME":"","FEATURE_NAME":"","BUILD_GRADLE_API":"build.gradle.kts","BUILD_GRADLE_IMPL":"build.gradle.kts"},"fileTemplates":{"${FEATURE_NAME}EntryPoint":"Template Module Feature Entry Point API","Default${FEATURE_NAME}EntryPoint":"Template Module Feature Entry Point Flow Impl","${BUILD_GRADLE_API}":"Template Module Feature Build Gradle API","${BUILD_GRADLE_IMPL}":"Template Module Feature Build Gradle Impl","${FEATURE_NAME}FlowNode":"Template Module Feature Node Flow Impl"},"realChildren":[{"name":"${MODULE_NAME}","isDir":true,"realChildren":[{"name":"api","isDir":true,"realChildren":[{"name":"src","isDir":true,"realChildren":[{"name":"main","isDir":true,"realChildren":[{"name":"kotlin","isDir":true,"realChildren":[{"name":"io","isDir":true,"realChildren":[{"name":"element","isDir":true,"realChildren":[{"name":"android","isDir":true,"realChildren":[{"name":"features","isDir":true,"realChildren":[{"name":"${MODULE_NAME}","isDir":true,"realChildren":[{"name":"api","isDir":true,"realChildren":[{"name":"${FEATURE_NAME}EntryPoint","isDir":false,"placeholders":{},"fileTemplates":{},"realChildren":[]}]}]}]}]}]}]}]}]}]},{"name":"${BUILD_GRADLE_API}","isDir":false,"placeholders":{},"fileTemplates":{},"realChildren":[]}]},{"name":"impl","isDir":true,"realChildren":[{"name":"src","isDir":true,"realChildren":[{"name":"main","isDir":true,"realChildren":[{"name":"kotlin","isDir":true,"realChildren":[{"name":"io","isDir":true,"realChildren":[{"name":"element","isDir":true,"realChildren":[{"name":"android","isDir":true,"realChildren":[{"name":"features","isDir":true,"realChildren":[{"name":"${MODULE_NAME}","isDir":true,"realChildren":[{"name":"impl","isDir":true,"realChildren":[{"name":"Default${FEATURE_NAME}EntryPoint","isDir":false,"placeholders":{},"fileTemplates":{},"realChildren":[]},{"name":"${FEATURE_NAME}FlowNode","isDir":false,"placeholders":{},"fileTemplates":{},"realChildren":[]}]}]}]}]}]}]}]}]},{"name":"test","isDir":true,"realChildren":[{"name":"kotlin","isDir":true,"realChildren":[{"name":"io","isDir":true,"realChildren":[{"name":"element","isDir":true,"realChildren":[{"name":"android","isDir":true,"realChildren":[{"name":"features","isDir":true,"realChildren":[{"name":"${MODULE_NAME}","isDir":true,"realChildren":[{"name":"impl","isDir":true,"realChildren":[]}]}]}]}]}]}]}]}]},{"name":"${BUILD_GRADLE_IMPL}","isDir":false,"placeholders":{},"fileTemplates":{},"realChildren":[]}]}]}]},"language":"java","templateName":"FeatureModule","lowercaseDir":true,"capitalizeFile":false,"packageNameToDir":false}

tools/templates/files/fileTemplates/Template Module Feature Build Gradle API.kts

@@ -0,0 +1,11 @@
+plugins {
+    id("io.element.android-library")
+}
+
+android {
+    namespace = "io.element.android.features.${MODULE_NAME}.api"
+}
+
+dependencies {
+    implementation(projects.libraries.architecture)
+}

tools/templates/files/fileTemplates/Template Module Feature Build Gradle Impl.kts

@@ -0,0 +1,25 @@
+import extension.setupDependencyInjection
+import extension.testCommonDependencies
+
+plugins {
+    id("io.element.android-compose-library")
+    id("kotlin-parcelize")
+}
+
+android {
+    namespace = "io.element.android.features.${MODULE_NAME}.impl"
+}
+
+setupDependencyInjection()
+
+dependencies {
+    api(projects.features.${MODULE_NAME}.api)
+    implementation(projects.libraries.core)
+    implementation(projects.libraries.architecture)
+    implementation(projects.libraries.matrix.api)
+    implementation(projects.libraries.matrixui)
+    implementation(projects.libraries.designsystem)
+
+    testCommonDependencies(libs)
+    testImplementation(projects.libraries.matrix.test)
+}

tools/templates/files/fileTemplates/Template Module Feature Entry Point API.kt

@@ -0,0 +1,18 @@
+package io.element.android.features.${MODULE_NAME}.api
+
+import com.bumble.appyx.core.modality.BuildContext
+import com.bumble.appyx.core.node.Node
+import com.bumble.appyx.core.plugin.Plugin
+import io.element.android.libraries.architecture.FeatureEntryPoint
+
+interface ${FEATURE_NAME}EntryPoint : FeatureEntryPoint {
+    fun createNode(
+        parentNode: Node,
+        buildContext: BuildContext,
+        callback: Callback,
+    ): Node
+
+    interface Callback : Plugin {
+        // Add your callbacks
+    }
+}

tools/templates/files/fileTemplates/Template Module Feature Entry Point Flow Impl.kt

@@ -0,0 +1,21 @@
+package io.element.android.features.${MODULE_NAME}.impl
+
+import com.bumble.appyx.core.modality.BuildContext
+import com.bumble.appyx.core.node.Node
+import com.bumble.appyx.core.plugin.Plugin
+import dev.zacsweers.metro.ContributesBinding
+import io.element.android.features.${MODULE_NAME}.api.${FEATURE_NAME}EntryPoint
+import io.element.android.libraries.architecture.createNode
+import dev.zacsweers.metro.AppScope
+
+@ContributesBinding(AppScope::class)
+class Default${FEATURE_NAME}EntryPoint() : ${FEATURE_NAME}EntryPoint {
+
+    override fun createNode(
+        parentNode: Node,
+        buildContext: BuildContext,
+        callback: ${FEATURE_NAME}EntryPoint.Callback,
+    ): Node {
+        return parentNode.createNode<${FEATURE_NAME}FlowNode>(buildContext, listOf(callback))
+    }
+}

tools/templates/files/fileTemplates/Template Module Feature Node Flow Impl.kt

@@ -0,0 +1,58 @@
+package io.element.android.features.${MODULE_NAME}.impl
+
+import android.os.Parcelable
+import androidx.compose.runtime.Composable
+import androidx.compose.ui.Modifier
+import com.bumble.appyx.core.composable.Children
+import com.bumble.appyx.core.modality.BuildContext
+import com.bumble.appyx.core.node.Node
+import com.bumble.appyx.core.plugin.Plugin
+import com.bumble.appyx.navmodel.backstack.BackStack
+import com.bumble.appyx.navmodel.backstack.operation.push
+import dev.zacsweers.metro.Assisted
+import dev.zacsweers.metro.AssistedInject
+import io.element.android.annotations.ContributesNode
+import io.element.android.libraries.architecture.BackstackNode
+import io.element.android.libraries.architecture.animation.rememberDefaultTransitionHandler
+import io.element.android.libraries.architecture.createNode
+import dev.zacsweers.metro.AppScope
+import kotlinx.parcelize.Parcelize
+
+// CHANGE THE SCOPE
+@ContributesNode(AppScope::class)
+@AssistedInject
+class ${FEATURE_NAME}FlowNode(
+    @Assisted buildContext: BuildContext,
+    @Assisted plugins: List<Plugin>,
+) : BackstackNode<${FEATURE_NAME}FlowNode.NavTarget>(
+    backstack = BackStack(
+        initialElement = NavTarget.Root,
+        savedStateMap = buildContext.savedStateMap,
+    ),
+    buildContext = buildContext,
+    plugins = plugins,
+) {
+
+    sealed interface NavTarget : Parcelable {
+        @Parcelize
+        object Root : NavTarget
+    }
+
+    override fun resolve(navTarget: NavTarget, buildContext: BuildContext): Node {
+        return when (navTarget) {
+            NavTarget.Root -> {
+                //Give your root node or completely delete this FlowNode if you have only one node.
+                createNode<>(buildContext)
+            }
+        }
+    }
+
+    @Composable
+    override fun View(modifier: Modifier) {
+        Children(
+            navModel = backstack,
+            modifier = modifier,
+            transitionHandler = rememberDefaultTransitionHandler(),
+        )
+    }
+}

tools/templates/files/fileTemplates/Template Presentation Classes.kt

@@ -0,0 +1,23 @@
+#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME}#end
+
+import androidx.compose.runtime.Composable
+import io.element.android.libraries.architecture.Presenter
+import dev.zacsweers.metro.Inject
+
+@Inject
+class ${NAME}Presenter() : Presenter<${NAME}State> {
+
+    @Composable
+    override fun present(): ${NAME}State {
+
+        fun handleEvent(event: ${NAME}Event) {
+            when (event) {
+                ${NAME}Event.MyEvent -> Unit
+            }
+        }
+
+        return ${NAME}State(
+            eventSink = ::handleEvent,
+        )
+    }
+}

tools/templates/files/fileTemplates/Template Presentation Classes.kt.child.0.kt

@@ -0,0 +1,15 @@
+#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME}#end
+
+import androidx.compose.ui.tooling.preview.PreviewParameterProvider
+
+open class ${NAME}StateProvider : PreviewParameterProvider<${NAME}State> {
+    override val values: Sequence<${NAME}State>
+        get() = sequenceOf(
+            a${NAME}State(),
+            // Add other states here
+        )
+}
+
+fun a${NAME}State() = ${NAME}State(
+    eventSink = {}
+)

tools/templates/files/fileTemplates/Template Presentation Classes.kt.child.1.kt

@@ -0,0 +1,30 @@
+#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME}#end
+
+import androidx.compose.runtime.Composable
+import androidx.compose.ui.Modifier
+import com.bumble.appyx.core.modality.BuildContext
+import com.bumble.appyx.core.node.Node
+import com.bumble.appyx.core.plugin.Plugin
+import dev.zacsweers.metro.Assisted
+import dev.zacsweers.metro.AssistedInject
+import io.element.android.annotations.ContributesNode
+import dev.zacsweers.metro.AppScope
+
+// CHANGE THE SCOPE
+@ContributesNode(AppScope::class)
+@AssistedInject
+class ${NAME}Node(
+    @Assisted buildContext: BuildContext,
+    @Assisted plugins: List<Plugin>,
+    private val presenter: ${NAME}Presenter,
+) : Node(buildContext, plugins = plugins) {
+
+    @Composable
+    override fun View(modifier: Modifier) {
+        val state = presenter.present()
+        ${NAME}View(
+            state = state,
+            modifier = modifier
+        )
+    }
+}

tools/templates/files/fileTemplates/Template Presentation Classes.kt.child.2.kt

@@ -0,0 +1,35 @@
+#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME}#end
+
+import androidx.compose.foundation.layout.Box
+import androidx.compose.runtime.Composable
+import androidx.compose.ui.Alignment
+import androidx.compose.ui.Modifier
+import androidx.compose.ui.tooling.preview.Preview
+import androidx.compose.ui.tooling.preview.PreviewParameter
+import io.element.android.compound.theme.ElementTheme
+import io.element.android.libraries.designsystem.preview.ElementPreview
+import io.element.android.libraries.designsystem.preview.PreviewsDayNight
+import io.element.android.libraries.designsystem.theme.components.Text
+
+@Composable
+fun ${NAME}View(
+    state: ${NAME}State,
+    modifier: Modifier = Modifier,
+) {
+    Box(modifier, contentAlignment = Alignment.Center) {
+        Text(
+            "${NAME} feature view",
+            color = ElementTheme.colors.textPrimary,
+        )
+    }
+}
+
+@PreviewsDayNight
+@Composable
+internal fun ${NAME}ViewPreview(
+    @PreviewParameter(${NAME}StateProvider::class) state: ${NAME}State
+) = ElementPreview {
+    ${NAME}View(
+        state = state,
+    )
+}

tools/templates/files/fileTemplates/Template Presentation Classes.kt.child.3.kt

@@ -0,0 +1,6 @@
+#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME}#end
+
+// TODO add your ui models. Remove the eventSink if you don't have events.
+data class ${NAME}State(
+    val eventSink: (${NAME}Event) -> Unit
+)

tools/templates/files/fileTemplates/Template Presentation Classes.kt.child.4.kt

@@ -0,0 +1,6 @@
+#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME}#end
+
+// TODO Add your events or remove the file completely if no events
+sealed interface ${NAME}Event {
+    data object MyEvent: ${NAME}Event
+}

tools/templates/files/options/file.template.settings.xml

@@ -0,0 +1,18 @@
+<application>
+  <component name="ExportableFileTemplateSettings">
+    <default_templates>
+      <template name="Template Presentation Classes.kt" file-name="${NAME}Presenter" reformat="true" live-template-enabled="false">
+        <template name="Template Presentation Classes.kt.child.0.kt" file-name="${NAME}StateProvider" reformat="true" live-template-enabled="false" />
+        <template name="Template Presentation Classes.kt.child.1.kt" file-name="${NAME}Node" reformat="true" live-template-enabled="false" />
+        <template name="Template Presentation Classes.kt.child.2.kt" file-name="${NAME}View" reformat="true" live-template-enabled="false" />
+        <template name="Template Presentation Classes.kt.child.3.kt" file-name="${NAME}State" reformat="true" live-template-enabled="false" />
+        <template name="Template Presentation Classes.kt.child.4.kt" file-name="${NAME}Event" reformat="true" live-template-enabled="false" />
+      </template>
+      <template name="Template Presentation Classes.kt.child.0.kt" file-name="${NAME}StateProvider" reformat="true" live-template-enabled="false" />
+      <template name="Template Presentation Classes.kt.child.1.kt" file-name="${NAME}Node" reformat="true" live-template-enabled="false" />
+      <template name="Template Presentation Classes.kt.child.2.kt" file-name="${NAME}View" reformat="true" live-template-enabled="false" />
+      <template name="Template Presentation Classes.kt.child.3.kt" file-name="${NAME}State" reformat="true" live-template-enabled="false" />
+      <template name="Template Presentation Classes.kt.child.4.kt" file-name="${NAME}Event" reformat="true" live-template-enabled="false" />
+    </default_templates>
+  </component>
+</application>

tools/templates/generate_templates.sh

@@ -0,0 +1,17 @@
+#!/usr/bin/env bash
+
+# Copyright (c) 2025 Element Creations Ltd.
+# Copyright 2023-2024 New Vector Ltd.
+#
+# SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial.
+# Please see LICENSE files in the repository root for full details.
+
+echo "Zipping the contents of the 'files' directory..."
+
+# Ensure tmp folder exists
+mkdir -p tmp
+
+rm -f ./tmp/file_templates.zip
+pushd ./tools/templates/files || exit
+zip -r ../../../tmp/file_templates.zip .
+popd || exit