kore/dev.buijs.klutter.kore.project

Package-level declarations

Types

class Android(val folder: File, val pluginPackageName: String, val pluginClassName: String)

Wrapper class with a file instance pointing to the android submodule.

enum Architecture : Enum<Architecture>

data class Config(val dependencies: Dependencies = Dependencies(), val bomVersion: String = klutterBomVersion, val flutterVersion: String? = null, val featureProtobufEnabled: Boolean? = null)

data class Dependencies(val klutter: String? = null, val klutterUI: String? = null, val squint: String? = null, val embedded: Set<String> = emptySet())

FlutterDistribution

data class FlutterDistribution(val version: Version, val os: OperatingSystem, val arch: Architecture)

FlutterDistributionFolderName

value class FlutterDistributionFolderName(source: String)

The full Flutter distribution version in format major.minor.patch.platform.architecture.

class IOS(val folder: File, val pluginName: String, val pluginClassName: String)

Wrapper class with a path to the root/ios.

OperatingSystem

enum OperatingSystem : Enum<OperatingSystem>

class Platform(val folder: File, pluginName: String)

Wrapper class with a file instance pointing to the kmp sub-module in root/platform.

PrettyPrintedFlutterDistribution

value class PrettyPrintedFlutterDistribution(source: String)

The full Flutter distribution version in format major.minor.patch (platform architecture).

data class Project(val root: Root, val ios: IOS, val android: Android, val platform: Platform)

A representation of the structure of a project made with the Klutter Framework. Each property of this object represents a folder containing one or more folders and/or files which are in some way used or needed by Klutter.

data class Pubspec(val name: String? = null, val description: String? = null, val version: String? = null, val flutter: PubspecFlutter? = null)

The parsed pubspec.yaml file.

data class PubspecFlutter(val plugin: PubspecPlugin?)

flutter: plugin: platforms: android: package: com.example.super_awesome pluginClass: SuperAwesomePlugin ios: pluginClass: SuperAwesomePlugin

data class PubspecPlugin(val platforms: PubspecPluginPlatforms?)

plugin: platforms: android: package: com.example.super_awesome pluginClass: SuperAwesomePlugin ios: pluginClass: SuperAwesomePlugin

PubspecPluginClass

data class PubspecPluginClass(val pluginPackage: String? = null, val pluginClass: String?)

PubspecPluginPlatforms

data class PubspecPluginPlatforms(val android: PubspecPluginClass?, val ios: PubspecPluginClass?)

platforms: android: package: com.example.super_awesome pluginClass: SuperAwesomePlugin ios: pluginClass: SuperAwesomePlugin

class Root(val pluginName: String, file: File)

data class Version(val major: Int, val minor: Int, val patch: Int)

Properties

val PrettyPrintedFlutterDistribution.arch: Architecture

compatibleFlutterVersions

val compatibleFlutterVersions: Map<FlutterDistribution, String>

currentArchitecture

val currentArchitecture: Architecture

currentOperatingSystem

val currentOperatingSystem: OperatingSystem

Get current OperatingSystem from System Properties.

currentWorkingDirectory

val currentWorkingDirectory: File

flutterDistribution

val FlutterDistributionFolderName.flutterDistribution: FlutterDistribution

val PrettyPrintedFlutterDistribution.flutterDistribution: FlutterDistribution

val PrettyPrintedFlutterDistribution.folderName: FlutterDistributionFolderName

folderNameString

val FlutterDistribution.folderNameString: FlutterDistributionFolderName

Generate a unique folder name for this Flutter configuration.

gitDependencies

val gitDependencies: Dependencies

Dependencies instance which uses GIT for all dependencies.

val isMacos: Boolean

val isWindows: Boolean

klutterBomVersion

const val klutterBomVersion: String

The version of Klutter Gradle Executable Tool.

klutterPubVersion

const val klutterPubVersion: String

The version of the klutter Pub Plugin.

klutterUIPubVersion

const val klutterUIPubVersion: String

The version of the klutter-ui Pub Plugin.

val Root.kradleEnvFile: File

The root/kradle.env File.

val kradleHome: File

Path to Klutter projects cache folder which is /.kradle.

val Root.kradleYaml: File

The root/kradle.yaml File.

kspArgumentKlutterProjectFolder

const val kspArgumentKlutterProjectFolder: String

latestVersionPlaceholder

const val latestVersionPlaceholder: Int = 9999

val mapper: ObjectMapper

Mapper to read/write YAML.

val PrettyPrintedFlutterDistribution.os: OperatingSystem

val Version.prettyPrint: String

prettyPrintedString

val FlutterDistribution.prettyPrintedString: PrettyPrintedFlutterDistribution

Generate a unique display name for this Flutter configuration.

projectPropertyPattern

val projectPropertyPattern: Regex

Pattern to be used to add properties to local/public configuration files (kradle.yaml, kradle.env).

val protocHome: File

Path to Klutter projects protoc folder which is kradleHome/.cache/protobuf/protoc.

val FlutterDistribution.sdk: File

Path to SDK folder Flutter which is /.kradle/cache/.

squintPubVersion

const val squintPubVersion: String

The version of the squint_json Pub Plugin.

systemPropertyPattern

val systemPropertyPattern: Regex

Pattern to be used to add system properties to local/public configuration files (kradle.yaml, kradle.env).

val PrettyPrintedFlutterDistribution.version: String

Functions

androidClassName

fun Pubspec.androidClassName(orElse: String): String

androidPackageName

fun Pubspec.androidPackageName(): String

fun dartExecutable(name: FlutterDistributionFolderName): File

fun dartExecutable(name: String): File

examplePubspecInit

fun examplePubspecInit(examplePubspecFile: File, rootPubspec: Pubspec, config: Config? = null): File

findFlutterVersionInKradleYamlOrNull

fun findFlutterVersionInKradleYamlOrNull(content: String?): String?

findOutputPathInKradleEnvOrNull

fun findOutputPathInKradleEnvOrNull(content: String?): String?

findProtocDownloadURLInKradleEnvOrNull

fun findProtocDownloadURLInKradleEnvOrNull(content: String?): String?

findSkipCodeGenInKradleEnvOrNull

fun findSkipCodeGenInKradleEnvOrNull(content: String?): Boolean?

flutterDownloadPathOrThrow

fun flutterDownloadPathOrThrow(os: OperatingSystem, arch: Architecture, version: Version): String

flutterExecutable

fun flutterExecutable(name: FlutterDistributionFolderName): File

fun flutterExecutable(name: String): File

fun flutterSDK(name: FlutterDistributionFolderName): File

Path to Klutter cache folder which is /.kradle/cache.

flutterVersionsDescending

fun flutterVersionsDescending(os: OperatingSystem): Set<FlutterDistribution>

initKradleCache

fun initKradleCache(): File

fun Pubspec.iosClassName(orElse: String): String

latestFlutterVersion

fun latestFlutterVersion(os: OperatingSystem): FlutterDistribution

fun Root.plugin(): Project

fun File.plugin(): Project

fun String.plugin(): Project

fun File.plugin(pluginName: String): Project

fun String.plugin(pluginName: String): Project

resolveProjectPropertiesOrThrow

fun File.resolveProjectPropertiesOrThrow(): File

Try to replace all project properties projectPropertyPattern and return File content.

resolveSystemPropertiesOrThrow

fun File.resolveSystemPropertiesOrThrow(): File

Try to replace all system properties systemPropertyPattern and return File content.

rootPubspecInit

fun rootPubspecInit(pubspecFile: File, pubspec: Pubspec, config: Config? = null): File

fun File.toConfigOrNull(): Config?

fun Root.toPubspec(): Pubspec

fun File.toPubspec(): Pubspec